nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doc is updated

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@575 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-07-06 15:25:42 +00:00
commit 20fdb9df76
201 changed files with 2918 additions and 2389 deletions
Download patch file Download diff file Expand all files Collapse all files

58
trunk/paradiseo-mo/doc/latex/classmo_gen_sol_continue.tex
View file

@ -1,11 +1,11 @@
\section{mo\-Gen\-Sol\-Continue$<$ EOT $>$ Class Template Reference}
\section{moGenSolContinue$<$ EOT $>$ Class Template Reference}
\label{classmo_gen_sol_continue}\index{moGenSolContinue@{moGenSolContinue}}
One possible stop criterion for a solution-based heuristic.
{\tt \#include $<$mo\-Gen\-Sol\-Continue.h$>$}
{\tt \#include $<$moGenSolContinue.h$>$}
Inheritance diagram for mo\-Gen\-Sol\-Continue$<$ EOT $>$::\begin{figure}[H]
Inheritance diagram for moGenSolContinue$<$ EOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmo_gen_sol_continue}
@ -14,25 +14,25 @@ Inheritance diagram for mo\-Gen\-Sol\-Continue$<$ EOT $>$::\begin{figure}[H]
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
\bf{mo\-Gen\-Sol\-Continue} (unsigned int \_\-\_\-max\-Num\-Gen)
{\bf moGenSolContinue} (unsigned int \_\-\_\-maxNumGen)
\begin{CompactList}\small\item\em Simple constructor. \item\end{CompactList}\item
bool \bf{operator()} (const EOT \&\_\-\_\-sol)
\begin{CompactList}\small\item\em \doxyref{Function} that activates the stop criterion. \item\end{CompactList}\item
void \bf{init} ()
bool {\bf operator()} (const EOT \&\_\-\_\-sol)
\begin{CompactList}\small\item\em Function that activates the stop criterion. \item\end{CompactList}\item
void {\bf init} ()
\begin{CompactList}\small\item\em Procedure which allows to initialise the generation counter. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
unsigned int \bf{max\-Num\-Gen}\label{classmo_gen_sol_continue_30b9861e090578bdfa2374806600987a}
unsigned int {\bf maxNumGen}\label{classmo_gen_sol_continue_30b9861e090578bdfa2374806600987a}
\begin{CompactList}\small\item\em Iteration maximum number. \item\end{CompactList}\item
unsigned int \bf{num\-Gen}\label{classmo_gen_sol_continue_630d9736a3a2c952540cdc211764258c}
unsigned int {\bf numGen}\label{classmo_gen_sol_continue_630d9736a3a2c952540cdc211764258c}
\begin{CompactList}\small\item\em Iteration current number. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class EOT$>$ class mo\-Gen\-Sol\-Continue$<$ EOT $>$}
\subsubsection*{template$<$class EOT$>$ class moGenSolContinue$<$ EOT $>$}
One possible stop criterion for a solution-based heuristic.
@ -40,12 +40,12 @@ The stop criterion corresponds to a maximum number of iteration.
Definition at line 21 of file mo\-Gen\-Sol\-Continue.h.
Definition at line 21 of file moGenSolContinue.h.
\subsection{Constructor \& Destructor Documentation}
\index{moGenSolContinue@{mo\-Gen\-Sol\-Continue}!moGenSolContinue@{moGenSolContinue}}
\index{moGenSolContinue@{moGenSolContinue}!moGenSolContinue@{mo\-Gen\-Sol\-Continue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ \bf{mo\-Gen\-Sol\-Continue}$<$ EOT $>$::\bf{mo\-Gen\-Sol\-Continue} (unsigned int {\em \_\-\_\-max\-Num\-Gen})\hspace{0.3cm}{\tt [inline]}}\label{classmo_gen_sol_continue_b56e890f1caa3f98e161c6512b59c95b}
\index{moGenSolContinue@{moGenSolContinue}!moGenSolContinue@{moGenSolContinue}}
\index{moGenSolContinue@{moGenSolContinue}!moGenSolContinue@{moGenSolContinue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ {\bf moGenSolContinue}$<$ EOT $>$::{\bf moGenSolContinue} (unsigned int {\em \_\-\_\-maxNumGen})\hspace{0.3cm}{\tt [inline]}}\label{classmo_gen_sol_continue_b56e890f1caa3f98e161c6512b59c95b}
Simple constructor.
@ -53,19 +53,19 @@ Simple constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-\_\-max\-Num\-Gen}]the maximum number of generation. \end{description}
\item[{\em \_\-\_\-maxNumGen}]the maximum number of generation. \end{description}
\end{Desc}
Definition at line 30 of file mo\-Gen\-Sol\-Continue.h.
Definition at line 30 of file moGenSolContinue.h.
\subsection{Member Function Documentation}
\index{moGenSolContinue@{mo\-Gen\-Sol\-Continue}!operator()@{operator()}}
\index{operator()@{operator()}!moGenSolContinue@{mo\-Gen\-Sol\-Continue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ bool \bf{mo\-Gen\-Sol\-Continue}$<$ EOT $>$::operator() (const EOT \& {\em \_\-\_\-sol})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_gen_sol_continue_457257cd73b474d6f7783d84d02c2e61}
\index{moGenSolContinue@{moGenSolContinue}!operator()@{operator()}}
\index{operator()@{operator()}!moGenSolContinue@{moGenSolContinue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ bool {\bf moGenSolContinue}$<$ EOT $>$::operator() (const EOT \& {\em \_\-\_\-sol})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_gen_sol_continue_457257cd73b474d6f7783d84d02c2e61}
\doxyref{Function} that activates the stop criterion.
Function that activates the stop criterion.
Increments the counter and returns TRUE if the current number of iteration is lower than the given maximum number of iterations.
@ -78,25 +78,25 @@ Increments the counter and returns TRUE if the current number of iteration is lo
\item[Returns:]TRUE or FALSE according to the current generation number. \end{Desc}
Implements \bf{eo\-UF$<$ const EOT \&, bool $>$}.
Implements {\bf eoUF$<$ const EOT \&, bool $>$}.
Definition at line 44 of file mo\-Gen\-Sol\-Continue.h.
Definition at line 44 of file moGenSolContinue.h.
References mo\-Gen\-Sol\-Continue$<$ EOT $>$::max\-Num\-Gen, and mo\-Gen\-Sol\-Continue$<$ EOT $>$::num\-Gen.\index{moGenSolContinue@{mo\-Gen\-Sol\-Continue}!init@{init}}
\index{init@{init}!moGenSolContinue@{mo\-Gen\-Sol\-Continue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ void \bf{mo\-Gen\-Sol\-Continue}$<$ EOT $>$::init ()\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_gen_sol_continue_6c5db8182157584b56507cc9075602d4}
References moGenSolContinue$<$ EOT $>$::maxNumGen, and moGenSolContinue$<$ EOT $>$::numGen.\index{moGenSolContinue@{moGenSolContinue}!init@{init}}
\index{init@{init}!moGenSolContinue@{moGenSolContinue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ void {\bf moGenSolContinue}$<$ EOT $>$::init ()\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_gen_sol_continue_6c5db8182157584b56507cc9075602d4}
Procedure which allows to initialise the generation counter.
It can also be used to reset the iteration counter.
Implements \bf{mo\-Sol\-Continue$<$ EOT $>$} \doxyref{p.}{classmo_sol_continue_064dc966a210f4ffb9515be3f03ca4c7}.
Implements {\bf moSolContinue$<$ EOT $>$} \doxyref{}{p.}{classmo_sol_continue_064dc966a210f4ffb9515be3f03ca4c7}.
Definition at line 54 of file mo\-Gen\-Sol\-Continue.h.
Definition at line 54 of file moGenSolContinue.h.
References mo\-Gen\-Sol\-Continue$<$ EOT $>$::num\-Gen.
References moGenSolContinue$<$ EOT $>$::numGen.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
mo\-Gen\-Sol\-Continue.h\end{CompactItemize}
moGenSolContinue.h\end{CompactItemize}