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

70
trunk/paradiseo-mo/doc/latex/classmo_first_impr_select.tex
View file

@ -1,11 +1,11 @@
\section{mo\-First\-Impr\-Select$<$ M $>$ Class Template Reference}
\section{moFirstImprSelect$<$ M $>$ Class Template Reference}
\label{classmo_first_impr_select}\index{moFirstImprSelect@{moFirstImprSelect}}
One possible \doxyref{mo\-Move\-Select}{p.}{classmo_move_select}.
One possible \doxyref{moMoveSelect}{p.}{classmo_move_select}.
{\tt \#include $<$mo\-First\-Impr\-Select.h$>$}
{\tt \#include $<$moFirstImprSelect.h$>$}
Inheritance diagram for mo\-First\-Impr\-Select$<$ M $>$::\begin{figure}[H]
Inheritance diagram for moFirstImprSelect$<$ M $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmo_first_impr_select}
@ -14,68 +14,68 @@ Inheritance diagram for mo\-First\-Impr\-Select$<$ M $>$::\begin{figure}[H]
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef M::EOType::Fitness \bf{Fitness}\label{classmo_first_impr_select_64763ce3e6d2873266624382b407fa5a}
typedef M::EOType::Fitness {\bf Fitness}\label{classmo_first_impr_select_64763ce3e6d2873266624382b407fa5a}
\begin{CompactList}\small\item\em Alias for the fitness. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
virtual void \bf{init} (const \bf{Fitness} \&\_\-\_\-fit)
virtual void {\bf init} (const {\bf Fitness} \&\_\-\_\-fit)
\begin{CompactList}\small\item\em Procedure which initialise the exploration. \item\end{CompactList}\item
bool \bf{update} (const M \&\_\-\_\-move, const typename M::EOType::Fitness \&\_\-\_\-fit)
\begin{CompactList}\small\item\em \doxyref{Function} that indicates if the current move has not improved the fitness. \item\end{CompactList}\item
void \bf{operator()} (M \&\_\-\_\-move, \bf{Fitness} \&\_\-\_\-fit) throw (Empty\-Selection)
bool {\bf update} (const M \&\_\-\_\-move, const typename M::EOType::Fitness \&\_\-\_\-fit)
\begin{CompactList}\small\item\em Function that indicates if the current move has not improved the fitness. \item\end{CompactList}\item
void {\bf operator()} (M \&\_\-\_\-move, {\bf Fitness} \&\_\-\_\-fit) throw (EmptySelection)
\begin{CompactList}\small\item\em Procedure which saved the best move and fitness. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
bool \bf{valid}\label{classmo_first_impr_select_a99c0586ba07449234705c17a258d58c}
bool {\bf valid}\label{classmo_first_impr_select_a99c0586ba07449234705c17a258d58c}
\begin{CompactList}\small\item\em Allow to know if at least one move has improved the solution. \item\end{CompactList}\item
M \bf{best\_\-move}\label{classmo_first_impr_select_dfed419a608dd7c41f07fa1f1279cb8c}
M {\bf best\_\-move}\label{classmo_first_impr_select_dfed419a608dd7c41f07fa1f1279cb8c}
\begin{CompactList}\small\item\em Best stored movement. \item\end{CompactList}\item
\bf{Fitness} \bf{init\_\-fit}\label{classmo_first_impr_select_ce7ba63e8cc3a9164f4e546477e98ca8}
{\bf Fitness} {\bf init\_\-fit}\label{classmo_first_impr_select_ce7ba63e8cc3a9164f4e546477e98ca8}
\begin{CompactList}\small\item\em Initial fitness. \item\end{CompactList}\item
\bf{Fitness} \bf{best\_\-fit}\label{classmo_first_impr_select_e1190347b76ec6fe717be32354b4a9a9}
{\bf Fitness} {\bf best\_\-fit}\label{classmo_first_impr_select_e1190347b76ec6fe717be32354b4a9a9}
\begin{CompactList}\small\item\em Best stored fitness. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class M$>$ class mo\-First\-Impr\-Select$<$ M $>$}
\subsubsection*{template$<$class M$>$ class moFirstImprSelect$<$ M $>$}
One possible \doxyref{mo\-Move\-Select}{p.}{classmo_move_select}.
One possible \doxyref{moMoveSelect}{p.}{classmo_move_select}.
The neighborhood is explored until a move enables an improvment of the current solution.
Definition at line 23 of file mo\-First\-Impr\-Select.h.
Definition at line 23 of file moFirstImprSelect.h.
\subsection{Member Function Documentation}
\index{moFirstImprSelect@{mo\-First\-Impr\-Select}!init@{init}}
\index{init@{init}!moFirstImprSelect@{mo\-First\-Impr\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ virtual void \bf{mo\-First\-Impr\-Select}$<$ M $>$::init (const \bf{Fitness} \& {\em \_\-\_\-fit})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_first_impr_select_4c5ce18ede46247a439c68f6954a4055}
\index{moFirstImprSelect@{moFirstImprSelect}!init@{init}}
\index{init@{init}!moFirstImprSelect@{moFirstImprSelect}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ virtual void {\bf moFirstImprSelect}$<$ M $>$::init (const {\bf Fitness} \& {\em \_\-\_\-fit})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_first_impr_select_4c5ce18ede46247a439c68f6954a4055}
Procedure which initialise the exploration.
It save the current fitness as the initial value for the fitness.
Implements \bf{mo\-Move\-Select$<$ M $>$} \doxyref{p.}{classmo_move_select_bca4c43f13d26eca7163aeb272a4a52e}.
Implements {\bf moMoveSelect$<$ M $>$} \doxyref{}{p.}{classmo_move_select_bca4c43f13d26eca7163aeb272a4a52e}.
Definition at line 35 of file mo\-First\-Impr\-Select.h.
Definition at line 35 of file moFirstImprSelect.h.
References mo\-First\-Impr\-Select$<$ M $>$::init\_\-fit, and mo\-First\-Impr\-Select$<$ M $>$::valid.\index{moFirstImprSelect@{mo\-First\-Impr\-Select}!update@{update}}
\index{update@{update}!moFirstImprSelect@{mo\-First\-Impr\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ bool \bf{mo\-First\-Impr\-Select}$<$ M $>$::update (const M \& {\em \_\-\_\-move}, const typename M::EOType::Fitness \& {\em \_\-\_\-fit})\hspace{0.3cm}{\tt [inline]}}\label{classmo_first_impr_select_7ba0882728daedc75c249647c070ccf0}
References moFirstImprSelect$<$ M $>$::init\_\-fit, and moFirstImprSelect$<$ M $>$::valid.\index{moFirstImprSelect@{moFirstImprSelect}!update@{update}}
\index{update@{update}!moFirstImprSelect@{moFirstImprSelect}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ bool {\bf moFirstImprSelect}$<$ M $>$::update (const M \& {\em \_\-\_\-move}, const typename M::EOType::Fitness \& {\em \_\-\_\-fit})\hspace{0.3cm}{\tt [inline]}}\label{classmo_first_impr_select_7ba0882728daedc75c249647c070ccf0}
\doxyref{Function} that indicates if the current move has not improved the fitness.
Function that indicates if the current move has not improved the fitness.
If the given fitness enables an improvment, the move (\doxyref{mo\-Move}{p.}{classmo_move}) should be applied to the current solution.
If the given fitness enables an improvment, the move (\doxyref{moMove}{p.}{classmo_move}) should be applied to the current solution.
\begin{Desc}
\item[Parameters:]
@ -86,11 +86,11 @@ If the given fitness enables an improvment, the move (\doxyref{mo\-Move}{p.}{cla
\item[Returns:]TRUE if the move does not improve the fitness. \end{Desc}
Definition at line 52 of file mo\-First\-Impr\-Select.h.
Definition at line 52 of file moFirstImprSelect.h.
References mo\-First\-Impr\-Select$<$ M $>$::best\_\-fit, mo\-First\-Impr\-Select$<$ M $>$::best\_\-move, mo\-First\-Impr\-Select$<$ M $>$::init\_\-fit, and mo\-First\-Impr\-Select$<$ M $>$::valid.\index{moFirstImprSelect@{mo\-First\-Impr\-Select}!operator()@{operator()}}
\index{operator()@{operator()}!moFirstImprSelect@{mo\-First\-Impr\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ void \bf{mo\-First\-Impr\-Select}$<$ M $>$::operator() (M \& {\em \_\-\_\-move}, \bf{Fitness} \& {\em \_\-\_\-fit}) throw (\bf{Empty\-Selection})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_first_impr_select_3be12cf4cbaed00df7c4fa735b2c0a95}
References moFirstImprSelect$<$ M $>$::best\_\-fit, moFirstImprSelect$<$ M $>$::best\_\-move, moFirstImprSelect$<$ M $>$::init\_\-fit, and moFirstImprSelect$<$ M $>$::valid.\index{moFirstImprSelect@{moFirstImprSelect}!operator()@{operator()}}
\index{operator()@{operator()}!moFirstImprSelect@{moFirstImprSelect}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class M$>$ void {\bf moFirstImprSelect}$<$ M $>$::operator() (M \& {\em \_\-\_\-move}, {\bf Fitness} \& {\em \_\-\_\-fit}) throw ({\bf EmptySelection})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmo_first_impr_select_3be12cf4cbaed00df7c4fa735b2c0a95}
Procedure which saved the best move and fitness.
@ -103,16 +103,16 @@ Procedure which saved the best move and fitness.
\begin{Desc}
\item[Exceptions:]
\begin{description}
\item[{\em \doxyref{Empty\-Selection}{p.}{class_empty_selection}}]if no move has improved the fitness. \end{description}
\item[{\em \doxyref{EmptySelection}{p.}{class_empty_selection}}]if no move has improved the fitness. \end{description}
\end{Desc}
Implements \bf{eo\-BF$<$ M \&, M::EOType::Fitness \&, void $>$}.
Implements {\bf eoBF$<$ M \&, M::EOType::Fitness \&, void $>$}.
Definition at line 76 of file mo\-First\-Impr\-Select.h.
Definition at line 76 of file moFirstImprSelect.h.
References mo\-First\-Impr\-Select$<$ M $>$::best\_\-fit, mo\-First\-Impr\-Select$<$ M $>$::best\_\-move, and mo\-First\-Impr\-Select$<$ M $>$::valid.
References moFirstImprSelect$<$ M $>$::best\_\-fit, moFirstImprSelect$<$ M $>$::best\_\-move, and moFirstImprSelect$<$ M $>$::valid.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
mo\-First\-Impr\-Select.h\end{CompactItemize}
moFirstImprSelect.h\end{CompactItemize}