Doc is updated

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
31 changed files with 2918 additions and 2389 deletions

View file

@ -1,4 +1,4 @@
.TH "EmptySelection" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "EmptySelection" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moAlgo" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAlgo" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moAspirCrit" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAspirCrit" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,7 +10,7 @@ moAspirCrit \- Description of the conditions in which a tabu move could be accep
.PP
\fC#include <moAspirCrit.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType::Fitness &, bool >\fP.
Inherits \fBeoBF< const M &, const M::EOType::Fitness &, bool >\fP.
.PP
Inherited by \fBmoImprBestFitAspirCrit< M >\fP, and \fBmoNoAspirCrit< M >\fP.
.PP

View file

@ -1,4 +1,4 @@
.TH "moBestImprSelect" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moBestImprSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -30,7 +30,7 @@ Inherits \fBmoMoveSelect< M >< M >\fP.
.ti -1c
.RI "bool \fBupdate\fP (const M &__move, const \fBFitness\fP &__fit)"
.br
.RI "\fI\fBFunction\fP that indicates if the current move has not improved the fitness. \fP"
.RI "\fIFunction that indicates if the current move has not improved the fitness. \fP"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
@ -65,7 +65,7 @@ Definition at line 22 of file moBestImprSelect.h.
.PP
.SS "template<class M> bool \fBmoBestImprSelect\fP< M >::update (const M & __move, const \fBFitness\fP & __fit)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that indicates if the current move has not improved the fitness.
Function that indicates if the current move has not improved the fitness.
.PP
If the given fitness enables an improvment, the move (\fBmoMove\fP) and the fitness linked to this move are saved.
.PP

View file

@ -1,4 +1,4 @@
.TH "moCoolingSchedule" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moExponentialCoolingSchedule" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moExponentialCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -22,7 +22,7 @@ Inherits \fBmoCoolingSchedule\fP.
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
.RI "\fI\fBFunction\fP which proceeds to the cooling. \fP"
.RI "\fIFunction which proceeds to the cooling. \fP"
.in -1c
.SS "Private Attributes"
@ -63,7 +63,7 @@ Definition at line 31 of file moExponentialCoolingSchedule.h.
.PP
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which proceeds to the cooling.
Function which proceeds to the cooling.
.PP
It decreases the temperature and indicates if it is greater than the threshold.
.PP

View file

@ -1,4 +1,4 @@
.TH "moFirstImprSelect" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moFirstImprSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -30,7 +30,7 @@ Inherits \fBmoMoveSelect< M >< M >\fP.
.ti -1c
.RI "bool \fBupdate\fP (const M &__move, const typename M::EOType::Fitness &__fit)"
.br
.RI "\fI\fBFunction\fP that indicates if the current move has not improved the fitness. \fP"
.RI "\fIFunction that indicates if the current move has not improved the fitness. \fP"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
@ -80,7 +80,7 @@ Definition at line 35 of file moFirstImprSelect.h.
References moFirstImprSelect< M >::init_fit, and moFirstImprSelect< M >::valid.
.SS "template<class M> bool \fBmoFirstImprSelect\fP< M >::update (const M & __move, const typename M::EOType::Fitness & __fit)\fC [inline]\fP"
.PP
\fBFunction\fP that indicates if the current move has not improved the fitness.
Function that indicates if the current move has not improved the fitness.
.PP
If the given fitness enables an improvment, the move (\fBmoMove\fP) should be applied to the current solution.
.PP

View file

@ -1,4 +1,4 @@
.TH "moGenSolContinue" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moGenSolContinue" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -22,7 +22,7 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
.RI "\fI\fBFunction\fP that activates the stop criterion. \fP"
.RI "\fIFunction that activates the stop criterion. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
@ -67,7 +67,7 @@ Definition at line 30 of file moGenSolContinue.h.
.PP
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that activates the stop criterion.
Function that activates the stop criterion.
.PP
Increments the counter and returns TRUE if the current number of iteration is lower than the given maximum number of iterations.
.PP

View file

@ -1,4 +1,4 @@
.TH "moHC" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHC" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -26,7 +26,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (\fBEOT\fP &__sol)"
.br
.RI "\fI\fBFunction\fP which launches the HC. \fP"
.RI "\fIFunction which launches the HC. \fP"
.in -1c
.SS "Private Types"
@ -105,7 +105,7 @@ Definition at line 67 of file moHC.h.
.PP
.SS "template<class M> bool \fBmoHC\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which launches the HC.
Function which launches the HC.
.PP
The HC has to improve a current solution. As the \fBmoSA\fP and the mo TS, it can be used for HYBRIDATION in an evolutionnary algorithm.
.PP

View file

@ -1,4 +1,4 @@
.TH "moHCMoveLoopExpl" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHCMoveLoopExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moImprBestFitAspirCrit" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moImprBestFitAspirCrit" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -34,7 +34,7 @@ Inherits \fBmoAspirCrit< M >< M >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (const M &__move, const \fBFitness\fP &__fit)"
.br
.RI "\fI\fBFunction\fP that indicates if the fit is better that the already saved fit. \fP"
.RI "\fIFunction that indicates if the fit is better that the already saved fit. \fP"
.in -1c
.SS "Private Attributes"
@ -59,9 +59,9 @@ This criterion is satisfied when a given fitness is the best ever considered.
Definition at line 22 of file moImprBestFitAspirCrit.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoImprBestFitAspirCrit\fP< M >::operator() (const M & __move, const \fBFitness\fP & __fit)\fC [inline]\fP"
.SS "template<class M> bool \fBmoImprBestFitAspirCrit\fP< M >::operator() (const M & __move, const \fBFitness\fP & __fit)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that indicates if the fit is better that the already saved fit.
Function that indicates if the fit is better that the already saved fit.
.PP
The first time, the function only saved the current move and fitness.
.PP
@ -78,6 +78,8 @@ TRUE the first time and if __fit > best_fit, else FALSE.
.RE
.PP
.PP
Implements \fBeoBF< const M &, const M::EOType::Fitness &, bool >\fP.
.PP
Definition at line 52 of file moImprBestFitAspirCrit.h.
.PP

View file

@ -1,4 +1,4 @@
.TH "moItRandNextMove" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moItRandNextMove" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -77,7 +77,7 @@ The constructor.
Definition at line 37 of file moItRandNextMove.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoItRandNextMove\fP< M >::operator() (M & __move, const \fBEOT\fP & __sol)\fC [inline]\fP"
.SS "template<class M> bool \fBmoItRandNextMove\fP< M >::operator() (M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Generation of a new move.
.PP
@ -96,6 +96,8 @@ FALSE if the maximum number of iteration is reached, else TRUE.
.RE
.PP
.PP
Implements \fBeoBF< M &, const M::EOType &, bool >\fP.
.PP
Definition at line 52 of file moItRandNextMove.h.
.PP

View file

@ -1,4 +1,4 @@
.TH "moLSCheckPoint" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLSCheckPoint" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,7 +10,7 @@ moLSCheckPoint \- Class which allows a checkpointing system.
.PP
\fC#include <moLSCheckPoint.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, void >\fP.
Inherits \fBeoBF< const M &, const M::EOType &, void >\fP.
.PP
.SS "Public Member Functions"
@ -18,7 +18,7 @@ Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, void >\fP.
.ti -1c
.RI "void \fBoperator()\fP (const M &__move, const typename M::EOType &__sol)"
.br
.RI "\fI\fBFunction\fP which launches the checkpointing. \fP"
.RI "\fIFunction which launches the checkpointing. \fP"
.ti -1c
.RI "void \fBadd\fP (\fBeoBF\fP< const M &, const typename M::EOType &, void > &__f)"
.br
@ -45,7 +45,7 @@ Definition at line 21 of file moLSCheckPoint.h.
.PP
.SS "template<class M> void \fBmoLSCheckPoint\fP< M >::operator() (const M & __move, const typename M::EOType & __sol)\fC [inline]\fP"
.PP
\fBFunction\fP which launches the checkpointing.
Function which launches the checkpointing.
.PP
Each saved function is used on the current move and the current solution.
.PP

View file

@ -1,4 +1,4 @@
.TH "moLinearCoolingSchedule" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLinearCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -22,7 +22,7 @@ Inherits \fBmoCoolingSchedule\fP.
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
.RI "\fI\fBFunction\fP which proceeds to the cooling. \fP"
.RI "\fIFunction which proceeds to the cooling. \fP"
.in -1c
.SS "Private Attributes"
@ -63,7 +63,7 @@ Definition at line 31 of file moLinearCoolingSchedule.h.
.PP
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which proceeds to the cooling.
Function which proceeds to the cooling.
.PP
It decreases the temperature and indicates if it is greater than the threshold.
.PP

View file

@ -1,4 +1,4 @@
.TH "moMove" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMove" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moMoveExpl" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moMoveIncrEval" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveIncrEval" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,7 +10,7 @@ moMoveIncrEval \- (generally) Efficient evaluation function based a move and a s
.PP
\fC#include <moMoveIncrEval.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, M::EOType::Fitness >\fP.
Inherits \fBeoBF< const M &, const M::EOType &, M::EOType::Fitness >\fP.
.PP
.SH "Detailed Description"
.PP

View file

@ -1,4 +1,4 @@
.TH "moMoveInit" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveInit" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,7 +10,7 @@ moMoveInit \- Move (\fBmoMove\fP) initializer.
.PP
\fC#include <moMoveInit.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const M &, M::EOType &, void >\fP.
Inherits \fBeoBF< M &, const M::EOType &, void >\fP.
.PP
.SH "Detailed Description"
.PP

View file

@ -1,4 +1,4 @@
.TH "moMoveLoopExpl" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveLoopExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

View file

@ -1,4 +1,4 @@
.TH "moMoveSelect" 3 "5 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -32,7 +32,7 @@ Inherited by \fBmoBestImprSelect< M >\fP, \fBmoFirstImprSelect< M >\fP, and \fBm
.ti -1c
.RI "virtual bool \fBupdate\fP (const M &__move, const \fBFitness\fP &__fit)=0"
.br
.RI "\fI\fBFunction\fP which updates the best solutions. \fP"
.RI "\fIFunction which updates the best solutions. \fP"
.in -1c
.SH "Detailed Description"
.PP
@ -61,7 +61,7 @@ In order to know the fitness of the solution, for which the neighborhood will be
Implemented in \fBmoBestImprSelect< M >\fP, \fBmoFirstImprSelect< M >\fP, and \fBmoRandImprSelect< M >\fP.
.SS "template<class M> virtual bool \fBmoMoveSelect\fP< M >::update (const M & __move, const \fBFitness\fP & __fit)\fC [pure virtual]\fP"
.PP
\fBFunction\fP which updates the best solutions.
Function which updates the best solutions.
.PP
\fBParameters:\fP
.RS 4

Some files were not shown because too many files have changed in this diff Show more