d8fd28a192
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@592 331e1502-861f-0410-8da2-ba01fb791d7f
101 lines
4.1 KiB
TeX
101 lines
4.1 KiB
TeX
\section{mo\-Fit\-Sol\-Continue$<$ EOT $>$ Class Template Reference}
|
|
\label{classmo_fit_sol_continue}\index{moFitSolContinue@{moFitSolContinue}}
|
|
One possible stop criterion for a solution-based heuristic.
|
|
|
|
|
|
{\tt \#include $<$mo\-Fit\-Sol\-Continue.h$>$}
|
|
|
|
Inheritance diagram for mo\-Fit\-Sol\-Continue$<$ EOT $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2cm]{classmo_fit_sol_continue}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef EOT::Fitness \bf{Fitness}\label{classmo_fit_sol_continue_369ed94a788d8bdc08d5554f7669376f}
|
|
|
|
\begin{CompactList}\small\item\em Alias for the fitness. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{mo\-Fit\-Sol\-Continue} (\bf{Fitness} \_\-\_\-fitness)
|
|
\begin{CompactList}\small\item\em Basic constructor. \item\end{CompactList}\item
|
|
bool \bf{operator()} (const EOT \&\_\-\_\-sol)
|
|
\begin{CompactList}\small\item\em Function that activates the stopping criterion. \item\end{CompactList}\item
|
|
void \bf{init} ()
|
|
\begin{CompactList}\small\item\em Procedure which allows to initialise all the stuff needed. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Private Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{Fitness} \bf{fitness}\label{classmo_fit_sol_continue_87d0ba8f2f76f61c89317eed5f094dfc}
|
|
|
|
\begin{CompactList}\small\item\em Fitness target. \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class EOT$>$ class mo\-Fit\-Sol\-Continue$<$ EOT $>$}
|
|
|
|
One possible stop criterion for a solution-based heuristic.
|
|
|
|
The stop criterion corresponds to a fitness threshold gained.
|
|
|
|
|
|
|
|
Definition at line 21 of file mo\-Fit\-Sol\-Continue.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moFitSolContinue@{mo\-Fit\-Sol\-Continue}!moFitSolContinue@{moFitSolContinue}}
|
|
\index{moFitSolContinue@{moFitSolContinue}!moFitSolContinue@{mo\-Fit\-Sol\-Continue}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ \bf{mo\-Fit\-Sol\-Continue}$<$ EOT $>$::\bf{mo\-Fit\-Sol\-Continue} (\bf{Fitness} {\em \_\-\_\-fitness})\hspace{0.3cm}{\tt [inline]}}\label{classmo_fit_sol_continue_b14f37ba88de4e12583b22f5aabeb682}
|
|
|
|
|
|
Basic constructor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-\_\-fitness}]The fitness to reach. \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 33 of file mo\-Fit\-Sol\-Continue.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moFitSolContinue@{mo\-Fit\-Sol\-Continue}!operator()@{operator()}}
|
|
\index{operator()@{operator()}!moFitSolContinue@{mo\-Fit\-Sol\-Continue}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ bool \bf{mo\-Fit\-Sol\-Continue}$<$ EOT $>$::operator() (const EOT \& {\em \_\-\_\-sol})\hspace{0.3cm}{\tt [inline]}}\label{classmo_fit_sol_continue_fa9f0a15f99c998115cae9b456403a27}
|
|
|
|
|
|
Function that activates the stopping criterion.
|
|
|
|
Indicates if the fitness threshold has not yet been reached.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-\_\-sol}]the current solution. \end{description}
|
|
\end{Desc}
|
|
\begin{Desc}
|
|
\item[Returns:]true or false according to the value of the fitness. \end{Desc}
|
|
|
|
|
|
Definition at line 43 of file mo\-Fit\-Sol\-Continue.h.
|
|
|
|
References mo\-Fit\-Sol\-Continue$<$ EOT $>$::fitness.\index{moFitSolContinue@{mo\-Fit\-Sol\-Continue}!init@{init}}
|
|
\index{init@{init}!moFitSolContinue@{mo\-Fit\-Sol\-Continue}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ void \bf{mo\-Fit\-Sol\-Continue}$<$ EOT $>$::init ()\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_fit_sol_continue_670bd895b4edfcd3aebb40d2295d7f7c}
|
|
|
|
|
|
Procedure which allows to initialise all the stuff needed.
|
|
|
|
It can be also used to reinitialize all the needed things.
|
|
|
|
Implements \bf{mo\-Sol\-Continue$<$ EOT $>$} \doxyref{p.}{classmo_sol_continue_064dc966a210f4ffb9515be3f03ca4c7}.
|
|
|
|
Definition at line 57 of file mo\-Fit\-Sol\-Continue.h.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
mo\-Fit\-Sol\-Continue.h\end{CompactItemize}
|