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

docs are updated (corrected more exactly)

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@287 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-04-20 09:38:14 +00:00
commit 20c8316125
212 changed files with 564 additions and 1285 deletions
Download patch file Download diff file Expand all files Collapse all files

2
trunk/paradiseo-mo/docs/man/man3/moAlgo.3
View file

@ -10,8 +10,6 @@ moAlgo \- Description of an algorithm of the paradiseo-mo library.
.PP
\fC#include <moAlgo.h>\fP
.PP
Inherits \fBeoMonOp< EOT >\fP.
.PP
.SH "Detailed Description"
.PP

2
trunk/paradiseo-mo/docs/man/man3/moAspirCrit.3
View file

@ -10,8 +10,6 @@ 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.
.PP
Inherited by \fBmoImprBestFitAspirCrit< M >\fP, and \fBmoNoAspirCrit< M >\fP.
.PP
.SS "Public Member Functions"

8
trunk/paradiseo-mo/docs/man/man3/moBestImprSelect.3
View file

@ -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
@ -88,7 +88,7 @@ Implements \fBmoMoveSelect< M >\fP.
Definition at line 47 of file moBestImprSelect.h.
.PP
References moBestImprSelect< M >::best_fit, moBestImprSelect< M >::best_move, and moBestImprSelect< M >::first_time.
.SS "template<class M> void \fBmoBestImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline, virtual]\fP"
.SS "template<class M> void \fBmoBestImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline]\fP"
.PP
Procedure which saved the best move and fitness.
.PP
@ -105,8 +105,6 @@ Procedure which saved the best move and fitness.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 68 of file moBestImprSelect.h.
.PP

2
trunk/paradiseo-mo/docs/man/man3/moCoolingSchedule.3
View file

@ -10,8 +10,6 @@ moCoolingSchedule \- This class gives the description of a cooling schedule.
.PP
\fC#include <moCoolingSchedule.h>\fP
.PP
Inherits \fBeoUF< double &, bool >\fP.
.PP
Inherited by \fBmoExponentialCoolingSchedule\fP, and \fBmoLinearCoolingSchedule\fP.
.PP
.SH "Detailed Description"

8
trunk/paradiseo-mo/docs/man/man3/moExponentialCoolingSchedule.3
View file

@ -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"
@ -61,9 +61,9 @@ Simple constructor.
Definition at line 31 of file moExponentialCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline]\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
@ -78,8 +78,6 @@ if the new temperature (current temperature * ratio) is greater than the thresho
.RE
.PP
.PP
Implements \fBeoUF< double &, bool >\fP.
.PP
Definition at line 41 of file moExponentialCoolingSchedule.h.
.PP

8
trunk/paradiseo-mo/docs/man/man3/moFirstImprSelect.3
View file

@ -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
@ -101,7 +101,7 @@ TRUE if the move does not improve the fitness.
Definition at line 52 of file moFirstImprSelect.h.
.PP
References moFirstImprSelect< M >::best_fit, moFirstImprSelect< M >::best_move, moFirstImprSelect< M >::init_fit, and moFirstImprSelect< M >::valid.
.SS "template<class M> void \fBmoFirstImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline, virtual]\fP"
.SS "template<class M> void \fBmoFirstImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline]\fP"
.PP
Procedure which saved the best move and fitness.
.PP
@ -118,8 +118,6 @@ Procedure which saved the best move and fitness.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 76 of file moFirstImprSelect.h.
.PP

10
trunk/paradiseo-mo/docs/man/man3/moGenSolContinue.3
View file

@ -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
@ -65,9 +65,9 @@ Simple constructor.
Definition at line 30 of file moGenSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline]\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
@ -82,13 +82,11 @@ TRUE or FALSE according to the current generation number.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 44 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::maxNumGen, and moGenSolContinue< EOT >::numGen.
.SS "template<class EOT> void \fBmoGenSolContinue\fP< EOT >::init (void)\fC [inline, virtual]\fP"
.SS "template<class EOT> void \fBmoGenSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise the generation counter.
.PP

18
trunk/paradiseo-mo/docs/man/man3/moHC.3
View file

@ -16,17 +16,17 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.in +1c
.ti -1c
.RI "\fBmoHC\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoMoveSelect\fP< M > &__move_select, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.RI "\fBmoHC\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoMoveSelect\fP< M > &__move_select, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIFull constructor. \fP"
.ti -1c
.RI "\fBmoHC\fP (\fBmoMoveExpl\fP< M > &__move_expl, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.RI "\fBmoHC\fP (\fBmoMoveExpl\fP< M > &__move_expl, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.br
.RI "\fILight constructor. \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"
@ -48,7 +48,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.br
.RI "\fIComplete exploration of the neighborhood. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.RI "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIA full evaluation function. \fP"
.in -1c
@ -63,7 +63,7 @@ Class which describes the algorithm for a hill climbing.
Definition at line 26 of file moHC.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoHC\fP< M >::\fBmoHC\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoMoveSelect\fP< M > & __move_select, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.SS "template<class M> \fBmoHC\fP< M >::\fBmoHC\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoMoveSelect\fP< M > & __move_select, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Full constructor.
.PP
@ -85,7 +85,7 @@ All the boxes are given in order the HC to use a \fBmoHCMoveLoopExpl\fP.
.PP
Definition at line 53 of file moHC.h.
.SS "template<class M> \fBmoHC\fP< M >::\fBmoHC\fP (\fBmoMoveExpl\fP< M > & __move_expl, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.SS "template<class M> \fBmoHC\fP< M >::\fBmoHC\fP (\fBmoMoveExpl\fP< M > & __move_expl, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Light constructor.
.PP
@ -103,9 +103,9 @@ This constructor allow to use another \fBmoMoveExpl\fP (generally not a \fBmoHCM
Definition at line 67 of file moHC.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoHC\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.SS "template<class M> bool \fBmoHC\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\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
@ -120,8 +120,6 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 82 of file moHC.h.
.PP

4
trunk/paradiseo-mo/docs/man/man3/moHCMoveLoopExpl.3
View file

@ -87,7 +87,7 @@ All the boxes have to be specified.
Definition at line 43 of file moHCMoveLoopExpl.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> void \fBmoHCMoveLoopExpl\fP< M >::operator() (const \fBEOT\fP & __old_sol, \fBEOT\fP & __new_sol)\fC [inline, virtual]\fP"
.SS "template<class M> void \fBmoHCMoveLoopExpl\fP< M >::operator() (const \fBEOT\fP & __old_sol, \fBEOT\fP & __new_sol)\fC [inline]\fP"
.PP
Procedure which launches the explorer.
.PP
@ -101,8 +101,6 @@ The exploration starts from an old solution and provides a new solution.
.RE
.PP
.PP
Implements \fBeoBF< const M::EOType &, M::EOType &, void >\fP.
.PP
Definition at line 59 of file moHCMoveLoopExpl.h.
.PP

4
trunk/paradiseo-mo/docs/man/man3/moImprBestFitAspirCrit.3
View file

@ -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"
@ -61,7 +61,7 @@ Definition at line 22 of file moImprBestFitAspirCrit.h.
.PP
.SS "template<class M> bool \fBmoImprBestFitAspirCrit\fP< M >::operator() (const M & __move, const \fBFitness\fP & __fit)\fC [inline]\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

2
trunk/paradiseo-mo/docs/man/man3/moItRandNextMove.3
View file

@ -63,7 +63,7 @@ Definition at line 22 of file moItRandNextMove.h.
.PP
The constructor.
.PP
\fBParameters\fP only for initialising the attributes.
Parameters only for initialising the attributes.
.PP
\fBParameters:\fP
.RS 4

12
trunk/paradiseo-mo/docs/man/man3/moLSCheckPoint.3
View file

@ -10,17 +10,15 @@ 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.
.PP
.SS "Public Member Functions"
.in +1c
.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)"
.RI "void \fBadd\fP (eoBF< const M &, const typename M::EOType &, void > &__f)"
.br
.RI "\fIProcedure which add a new function to the function vector. \fP"
.in -1c
@ -28,7 +26,7 @@ Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, void >\fP.
.in +1c
.ti -1c
.RI "std::vector< \fBeoBF\fP< const M &, const typename M::EOType &, void > * > \fBfunc\fP"
.RI "std::vector< eoBF< const M &, const typename M::EOType &, void > * > \fBfunc\fP"
.br
.RI "\fIvector of function \fP"
.in -1c
@ -45,7 +43,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
@ -61,7 +59,7 @@ Each saved function is used on the current move and the current solution.
Definition at line 34 of file moLSCheckPoint.h.
.PP
References moLSCheckPoint< M >::func.
.SS "template<class M> void \fBmoLSCheckPoint\fP< M >::add (\fBeoBF\fP< const M &, const typename M::EOType &, void > & __f)\fC [inline]\fP"
.SS "template<class M> void \fBmoLSCheckPoint\fP< M >::add (eoBF< const M &, const typename M::EOType &, void > & __f)\fC [inline]\fP"
.PP
Procedure which add a new function to the function vector.
.PP

8
trunk/paradiseo-mo/docs/man/man3/moLinearCoolingSchedule.3
View file

@ -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"
@ -61,9 +61,9 @@ Simple constructor.
Definition at line 31 of file moLinearCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline]\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
@ -78,8 +78,6 @@ if the new temperature (current temperature - quantity) is greater than the thre
.RE
.PP
.PP
Implements \fBeoUF< double &, bool >\fP.
.PP
Definition at line 41 of file moLinearCoolingSchedule.h.
.PP

2
trunk/paradiseo-mo/docs/man/man3/moMove.3
View file

@ -10,8 +10,6 @@ moMove \- Definition of a move.
.PP
\fC#include <moMove.h>\fP
.PP
Inherits \fBeoUF< EOT &, void >\fP.
.PP
.SS "Public Types"
.in +1c

2
trunk/paradiseo-mo/docs/man/man3/moMoveExpl.3
View file

@ -10,8 +10,6 @@ moMoveExpl \- Description of a move (\fBmoMove\fP) explorer.
.PP
\fC#include <moMoveExpl.h>\fP
.PP
Inherits \fBeoBF< const M::EOType &, M::EOType &, void >\fP.
.PP
Inherited by \fBmoMoveLoopExpl< M >\fP.
.PP
.SH "Detailed Description"

2
trunk/paradiseo-mo/docs/man/man3/moMoveIncrEval.3
View file

@ -10,8 +10,6 @@ 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.
.PP
.SH "Detailed Description"
.PP

2
trunk/paradiseo-mo/docs/man/man3/moMoveInit.3
View file

@ -10,8 +10,6 @@ moMoveInit \- Move (\fBmoMove\fP) initializer.
.PP
\fC#include <moMoveInit.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const M &, M::EOType &, void >\fP.
.PP
.SH "Detailed Description"
.PP

6
trunk/paradiseo-mo/docs/man/man3/moMoveSelect.3
View file

@ -10,8 +10,6 @@ moMoveSelect \- Class that describes a move selector (\fBmoMove\fP).
.PP
\fC#include <moMoveSelect.h>\fP
.PP
Inherits \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Inherited by \fBmoBestImprSelect< M >\fP, \fBmoFirstImprSelect< M >\fP, and \fBmoRandImprSelect< M >\fP.
.PP
.SS "Public Types"
@ -32,7 +30,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 +59,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

2
trunk/paradiseo-mo/docs/man/man3/moNextMove.3
View file

@ -10,8 +10,6 @@ moNextMove \- Class which allows to generate a new move (\fBmoMove\fP).
.PP
\fC#include <moNextMove.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const M &, M::EOType &, bool >\fP.
.PP
Inherited by \fBmoItRandNextMove< M >\fP.
.PP
.SH "Detailed Description"

6
trunk/paradiseo-mo/docs/man/man3/moNoAspirCrit.3
View file

@ -18,7 +18,7 @@ Inherits \fBmoAspirCrit< M >< M >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (const M &__move, const typename M::EOType::Fitness &__sol)"
.br
.RI "\fI\fBFunction\fP which describes the aspiration criterion behaviour. \fP"
.RI "\fIFunction which describes the aspiration criterion behaviour. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
@ -37,7 +37,7 @@ Definition at line 21 of file moNoAspirCrit.h.
.PP
.SS "template<class M> bool \fBmoNoAspirCrit\fP< M >::operator() (const M & __move, const typename M::EOType::Fitness & __sol)\fC [inline, private]\fP"
.PP
\fBFunction\fP which describes the aspiration criterion behaviour.
Function which describes the aspiration criterion behaviour.
.PP
Does nothing.
.PP
@ -56,7 +56,7 @@ FALSE.
.PP
Definition at line 32 of file moNoAspirCrit.h.
.SS "template<class M> void \fBmoNoAspirCrit\fP< M >::init (void)\fC [inline, private, virtual]\fP"
.SS "template<class M> void \fBmoNoAspirCrit\fP< M >::init ()\fC [inline, private, virtual]\fP"
.PP
Procedure which initialises all that needs a \fBmoNoAspirCrit\fP.
.PP

10
trunk/paradiseo-mo/docs/man/man3/moRandImprSelect.3
View file

@ -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 updates the fitness and move vectors. \fP"
.RI "\fIFunction that updates the fitness and move vectors. \fP"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
@ -83,7 +83,7 @@ Definition at line 40 of file moRandImprSelect.h.
References moRandImprSelect< M >::init_fit, moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
.SS "template<class M> bool \fBmoRandImprSelect\fP< M >::update (const M & __move, const \fBFitness\fP & __fit)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that updates the fitness and move vectors.
Function that updates the fitness and move vectors.
.PP
if a move give a better fitness than the initial fitness, it is saved and the fitness too.
.PP
@ -106,7 +106,7 @@ Implements \fBmoMoveSelect< M >\fP.
Definition at line 56 of file moRandImprSelect.h.
.PP
References moRandImprSelect< M >::init_fit, moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
.SS "template<class M> void \fBmoRandImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline, virtual]\fP"
.SS "template<class M> void \fBmoRandImprSelect\fP< M >::operator() (M & __move, \fBFitness\fP & __fit) throw (\fBEmptySelection\fP)\fC [inline]\fP"
.PP
The move selection.
.PP
@ -125,12 +125,10 @@ One the saved move is randomly chosen.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 77 of file moRandImprSelect.h.
.PP
References eoRng::random(), moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
References moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
.SH "Author"
.PP

2
trunk/paradiseo-mo/docs/man/man3/moRandMove.3
View file

@ -10,8 +10,6 @@ moRandMove \- Random move generator.
.PP
\fC#include <moRandMove.h>\fP
.PP
Inherits \fBeoUF< M &, void >\fP.
.PP
.SH "Detailed Description"
.PP

12
trunk/paradiseo-mo/docs/man/man3/moSA.3
View file

@ -16,7 +16,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.in +1c
.ti -1c
.RI "\fBmoSA\fP (\fBmoRandMove\fP< M > &__move_rand, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, double __init_temp, \fBmoCoolingSchedule\fP &__cool_sched, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.RI "\fBmoSA\fP (\fBmoRandMove\fP< M > &__move_rand, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, double __init_temp, \fBmoCoolingSchedule\fP &__cool_sched, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.br
.RI "\fISA constructor. \fP"
.ti -1c
@ -60,7 +60,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.br
.RI "\fIThe cooling schedule. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.RI "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIA full evaluation function. \fP"
.in -1c
@ -75,7 +75,7 @@ Class that describes a Simulated Annealing algorithm.
Definition at line 32 of file moSA.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoSA\fP< M >::\fBmoSA\fP (\fBmoRandMove\fP< M > & __move_rand, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, double __init_temp, \fBmoCoolingSchedule\fP & __cool_sched, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.SS "template<class M> \fBmoSA\fP< M >::\fBmoSA\fP (\fBmoRandMove\fP< M > & __move_rand, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, double __init_temp, \fBmoCoolingSchedule\fP & __cool_sched, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
SA constructor.
.PP
@ -101,7 +101,7 @@ All the boxes used by a SA need to be given.
Definition at line 60 of file moSA.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoSA\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.SS "template<class M> bool \fBmoSA\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\fP"
.PP
function that launches the SA algorithm.
.PP
@ -118,12 +118,10 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 82 of file moSA.h.
.PP
References moSA< M >::cont, moSA< M >::cool_sched, moSA< M >::full_eval, moSA< M >::incr_eval, moSA< M >::init_temp, moSA< M >::move_rand, and eoRng::uniform().
References moSA< M >::cont, moSA< M >::cool_sched, moSA< M >::full_eval, moSA< M >::incr_eval, moSA< M >::init_temp, and moSA< M >::move_rand.
.SH "Author"
.PP

4
trunk/paradiseo-mo/docs/man/man3/moSimpleMoveTabuList.3
View file

@ -30,7 +30,7 @@ Inherits \fBmoTabuList< M >< M >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
.RI "\fI\fBFunction\fP that indicates if, in a given state, the _move is tabu or not. \fP"
.RI "\fIFunction that indicates if, in a given state, the _move is tabu or not. \fP"
.ti -1c
.RI "void \fBadd\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
@ -79,7 +79,7 @@ Definition at line 22 of file moSimpleMoveTabuList.h.
.PP
.SS "template<class M> bool \fBmoSimpleMoveTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline]\fP"
.PP
\fBFunction\fP that indicates if, in a given state, the _move is tabu or not.
Function that indicates if, in a given state, the _move is tabu or not.
.PP
\fBParameters:\fP
.RS 4

4
trunk/paradiseo-mo/docs/man/man3/moSimpleSolutionTabuList.3
View file

@ -30,7 +30,7 @@ Inherits \fBmoTabuList< M >< M >\fP.
.ti -1c
.RI "bool \fBoperator()\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
.RI "\fI\fBFunction\fP that indicates if, in a given state, the _move is tabu or not. \fP"
.RI "\fIFunction that indicates if, in a given state, the _move is tabu or not. \fP"
.ti -1c
.RI "void \fBadd\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
@ -95,7 +95,7 @@ References moSimpleSolutionTabuList< M >::currentSize.
.PP
.SS "template<class M> bool \fBmoSimpleSolutionTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline]\fP"
.PP
\fBFunction\fP that indicates if, in a given state, the _move is tabu or not.
Function that indicates if, in a given state, the _move is tabu or not.
.PP
\fBParameters:\fP
.RS 4

4
trunk/paradiseo-mo/docs/man/man3/moSolContinue.3
View file

@ -10,8 +10,6 @@ moSolContinue \- Class that describes a stop criterion for a solution-based heur
.PP
\fC#include <moSolContinue.h>\fP
.PP
Inherits \fBeoUF< const EOT &, bool >\fP.
.PP
Inherited by \fBmoGenSolContinue< EOT >\fP.
.PP
.SS "Public Member Functions"
@ -28,7 +26,7 @@ Inherited by \fBmoGenSolContinue< EOT >\fP.
.SS "template<class EOT> class moSolContinue< EOT >"
Class that describes a stop criterion for a solution-based heuristic.
It allows to add an initialisation procedure to an object that is a unary function (\fBeoUF\fP).
It allows to add an initialisation procedure to an object that is a unary function (eoUF).
.PP
Definition at line 22 of file moSolContinue.h.
.SH "Member Function Documentation"

18
trunk/paradiseo-mo/docs/man/man3/moTS.3
View file

@ -16,17 +16,17 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.in +1c
.ti -1c
.RI "\fBmoTS\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoTabuList\fP< M > &__tabu_list, \fBmoAspirCrit\fP< M > &__aspir_crit, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.RI "\fBmoTS\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoTabuList\fP< M > &__tabu_list, \fBmoAspirCrit\fP< M > &__aspir_crit, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIConstructor of a \fBmoTS\fP specifying all the boxes. \fP"
.ti -1c
.RI "\fBmoTS\fP (\fBmoMoveExpl\fP< M > &__move_expl, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.RI "\fBmoTS\fP (\fBmoMoveExpl\fP< M > &__move_expl, \fBmoSolContinue\fP< \fBEOT\fP > &__cont, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIConstructor with less parameters. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (\fBEOT\fP &__sol)"
.br
.RI "\fI\fBFunction\fP which launchs the Tabu Search. \fP"
.RI "\fIFunction which launchs the Tabu Search. \fP"
.in -1c
.SS "Private Types"
@ -52,7 +52,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.br
.RI "\fIStop criterion. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.RI "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIFull evaluation function. \fP"
.in -1c
@ -79,7 +79,7 @@ Generic algorithm that describes a tabu search.
Definition at line 30 of file moTS.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoTabuList\fP< M > & __tabu_list, \fBmoAspirCrit\fP< M > & __aspir_crit, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoTabuList\fP< M > & __tabu_list, \fBmoAspirCrit\fP< M > & __aspir_crit, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor of a \fBmoTS\fP specifying all the boxes.
.PP
@ -107,7 +107,7 @@ In this constructor, a \fBmoTSMoveLoopExpl\fP is instanciated.
Definition at line 59 of file moTS.h.
.PP
References moTS< M >::first_time, and moTS< M >::mutex.
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveExpl\fP< M > & __move_expl, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveExpl\fP< M > & __move_expl, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor with less parameters.
.PP
@ -129,9 +129,9 @@ Definition at line 81 of file moTS.h.
References moTS< M >::first_time, and moTS< M >::mutex.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\fP"
.PP
\fBFunction\fP which launchs the Tabu Search.
Function which launchs the Tabu Search.
.PP
Algorithm of the tabu search. As a \fBmoSA\fP or a \fBmoHC\fP, it can be used for HYBRIDATION in an evolutionary algorithm. For security a lock (pthread_mutex_t) is closed during the algorithm.
.PP
@ -146,8 +146,6 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 104 of file moTS.h.
.PP

4
trunk/paradiseo-mo/docs/man/man3/moTSMoveLoopExpl.3
View file

@ -99,7 +99,7 @@ Definition at line 49 of file moTSMoveLoopExpl.h.
References moTSMoveLoopExpl< M >::aspir_crit, and moTSMoveLoopExpl< M >::tabu_list.
.SH "Member Function Documentation"
.PP
.SS "template<class M> void \fBmoTSMoveLoopExpl\fP< M >::operator() (const \fBEOT\fP & __old_sol, \fBEOT\fP & __new_sol)\fC [inline, virtual]\fP"
.SS "template<class M> void \fBmoTSMoveLoopExpl\fP< M >::operator() (const \fBEOT\fP & __old_sol, \fBEOT\fP & __new_sol)\fC [inline]\fP"
.PP
Procedure which lauches the exploration.
.PP
@ -113,8 +113,6 @@ The exploration continues while the chosen move is not in the tabu list or the a
.RE
.PP
.PP
Implements \fBeoBF< const M::EOType &, M::EOType &, void >\fP.
.PP
Definition at line 69 of file moTSMoveLoopExpl.h.
.PP

2
trunk/paradiseo-mo/docs/man/man3/moTabuList.3
View file

@ -10,8 +10,6 @@ moTabuList \- Class describing a tabu list that a \fBmoTS\fP uses.
.PP
\fC#include <moTabuList.h>\fP
.PP
Inherits \fBeoBF< A1, A2, R >< const const M &, M::EOType &, bool >\fP.
.PP
Inherited by \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.PP
.SS "Public Types"