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

New doc is made

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@742 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-10-23 13:38:14 +00:00
commit 25cf44c291
296 changed files with 28291 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
trunk/paradiseo-mo/doc/man/man3/EmptySelection.3 Normal file
View file

@ -0,0 +1,23 @@
.TH "EmptySelection" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
EmptySelection \- Special class that describes the case of no selection.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moMoveSelect.h>\fP
.PP
.SH "Detailed Description"
.PP
Special class that describes the case of no selection.
This class is used as an exception that can be thrown if a solution selector has completly failed.
.PP
Definition at line 46 of file moMoveSelect.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

27
trunk/paradiseo-mo/doc/man/man3/moAlgo.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "moAlgo" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moAlgo \- Description of an algorithm of the paradiseo-mo library.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moAlgo.h>\fP
.PP
Inherits \fBeoMonOp< EOT >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moAlgo< EOT >"
Description of an algorithm of the paradiseo-mo library.
\fBmoHC\fP, \fBmoTS\fP and \fBmoSA\fP are 3 examples of algorithm of the paradiseo-mo library.
.PP
Definition at line 46 of file moAlgo.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

46
trunk/paradiseo-mo/doc/man/man3/moAspirCrit.3 Normal file
View file

@ -0,0 +1,46 @@
.TH "moAspirCrit" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moAspirCrit \- Description of the conditions in which a tabu move could be accepted.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moAspirCrit.h>\fP
.PP
Inherits \fBeoBF< const M &, const M::EOType::Fitness &, bool >\fP.
.PP
Inherited by \fBmoImprBestFitAspirCrit< M >\fP, and \fBmoNoAspirCrit< M >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBinit\fP ()=0"
.br
.RI "\fIProcedure which initialises all that needs a aspiration criterion. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moAspirCrit< M >"
Description of the conditions in which a tabu move could be accepted.
It is only a description... An object that herits from this class is needed to be used in a \fBmoTS\fP. See moNoAspriCrit for example.
.PP
Definition at line 47 of file moAspirCrit.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> virtual void \fBmoAspirCrit\fP< M >::init ()\fC [pure virtual]\fP"
.PP
Procedure which initialises all that needs a aspiration criterion.
.PP
It can be possible that this procedure do nothing...
.PP
Implemented in \fBmoImprBestFitAspirCrit< M >\fP, and \fBmoNoAspirCrit< M >\fP.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

117
trunk/paradiseo-mo/doc/man/man3/moBestImprSelect.3 Normal file
View file

@ -0,0 +1,117 @@
.TH "moBestImprSelect" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moBestImprSelect \- One of the possible \fBmoMoveSelect\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moBestImprSelect.h>\fP
.PP
Inherits \fBmoMoveSelect< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBinit\fP (const \fBFitness\fP &__fit)"
.br
.RI "\fIProcedure which initialise the exploration. \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"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
.RI "\fIProcedure which saved the best move and fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "bool \fBfirst_time\fP"
.br
.RI "\fIAllowing to know if at least one move has been generated. \fP"
.ti -1c
.RI "M \fBbest_move\fP"
.br
.RI "\fIThe best move. \fP"
.ti -1c
.RI "\fBFitness\fP \fBbest_fit\fP"
.br
.RI "\fIThe best fitness. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moBestImprSelect< M >"
One of the possible \fBmoMoveSelect\fP.
All neighbors are considered, and the movement which enables the best improvement is selected.
.PP
Definition at line 47 of file moBestImprSelect.h.
.SH "Member Function Documentation"
.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.
.PP
If the given fitness enables an improvment, the move (\fBmoMove\fP) and the fitness linked to this move are saved.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a move.
.br
\fI__fit\fP a fitness linked to the move.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if the move does not improve the fitness.
.RE
.PP
.PP
Implements \fBmoMoveSelect< M >\fP.
.PP
Definition at line 72 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"
.PP
Procedure which saved the best move and fitness.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP the current move (result of the procedure).
.br
\fI__fit\fP the current fitness (result of the procedure).
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBEmptySelection\fP\fP if no move has improved the fitness.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 93 of file moBestImprSelect.h.
.PP
References moBestImprSelect< M >::best_fit, moBestImprSelect< M >::best_move, and moBestImprSelect< M >::first_time.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

29
trunk/paradiseo-mo/doc/man/man3/moComparator.3 Normal file
View file

@ -0,0 +1,29 @@
.TH "moComparator" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moComparator \- Template for classes which need to compare two EOT and indicate if the first is 'better' than the second.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moComparator.h>\fP
.PP
Inherits \fBeoBF< const EOT &, const EOT &, bool >\fP.
.PP
Inherited by \fBmoFitComparator< EOT >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moComparator< EOT >"
Template for classes which need to compare two EOT and indicate if the first is 'better' than the second.
The objects that extend this template describe how an EOT is 'better' than an other.
.PP
Definition at line 46 of file moComparator.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

27
trunk/paradiseo-mo/doc/man/man3/moCoolingSchedule.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "moCoolingSchedule" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moCoolingSchedule \- This class gives the description of a cooling schedule.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moCoolingSchedule.h>\fP
.PP
Inherits \fBeoUF< double &, bool >\fP.
.PP
Inherited by \fBmoExponentialCoolingSchedule\fP, and \fBmoLinearCoolingSchedule\fP.
.PP
.SH "Detailed Description"
.PP
This class gives the description of a cooling schedule.
It is only a description... An object that herits from this class is needed to be used in a \fBmoSA\fP. See \fBmoExponentialCoolingSchedule\fP or \fBmoLinearCoolingSchedule\fP for example.
.PP
Definition at line 47 of file moCoolingSchedule.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

90
trunk/paradiseo-mo/doc/man/man3/moExponentialCoolingSchedule.3 Normal file
View file

@ -0,0 +1,90 @@
.TH "moExponentialCoolingSchedule" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moExponentialCoolingSchedule \- One of the possible \fBmoCoolingSchedule\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moExponentialCoolingSchedule.h>\fP
.PP
Inherits \fBmoCoolingSchedule\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoExponentialCoolingSchedule\fP (double __threshold, double __ratio)"
.br
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
.RI "\fI\fBFunction\fP which proceeds to the cooling. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBthreshold\fP"
.br
.RI "\fIThe temperature threhold. \fP"
.ti -1c
.RI "double \fBratio\fP"
.br
.RI "\fIThe decreasing factor of the temperature. \fP"
.in -1c
.SH "Detailed Description"
.PP
One of the possible \fBmoCoolingSchedule\fP.
An other very simple cooling schedule, the temperature decrease according to a ratio while the temperature is greater than a given threshold.
.PP
Definition at line 47 of file moExponentialCoolingSchedule.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "moExponentialCoolingSchedule::moExponentialCoolingSchedule (double __threshold, double __ratio)\fC [inline]\fP"
.PP
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__threshold\fP the threshold.
.br
\fI__ratio\fP the ratio used to descrease the temperature.
.RE
.PP
.PP
Definition at line 56 of file moExponentialCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which proceeds to the cooling.
.PP
It decreases the temperature and indicates if it is greater than the threshold.
.PP
\fBParameters:\fP
.RS 4
\fI__temp\fP the current temperature.
.RE
.PP
\fBReturns:\fP
.RS 4
if the new temperature (current temperature * ratio) is greater than the threshold.
.RE
.PP
.PP
Implements \fBeoUF< double &, bool >\fP.
.PP
Definition at line 66 of file moExponentialCoolingSchedule.h.
.PP
References ratio, and threshold.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

130
trunk/paradiseo-mo/doc/man/man3/moFirstImprSelect.3 Normal file
View file

@ -0,0 +1,130 @@
.TH "moFirstImprSelect" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moFirstImprSelect \- One possible \fBmoMoveSelect\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moFirstImprSelect.h>\fP
.PP
Inherits \fBmoMoveSelect< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBinit\fP (const \fBFitness\fP &__fit)"
.br
.RI "\fIProcedure which initialise the exploration. \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"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
.RI "\fIProcedure which saved the best move and fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "bool \fBvalid\fP"
.br
.RI "\fIAllow to know if at least one move has improved the solution. \fP"
.ti -1c
.RI "M \fBbest_move\fP"
.br
.RI "\fIBest stored movement. \fP"
.ti -1c
.RI "\fBFitness\fP \fBinit_fit\fP"
.br
.RI "\fIInitial fitness. \fP"
.ti -1c
.RI "\fBFitness\fP \fBbest_fit\fP"
.br
.RI "\fIBest stored fitness. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moFirstImprSelect< M >"
One possible \fBmoMoveSelect\fP.
The neighborhood is explored until a move enables an improvment of the current solution.
.PP
Definition at line 48 of file moFirstImprSelect.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> virtual void \fBmoFirstImprSelect\fP< M >::init (const \fBFitness\fP & __fit)\fC [inline, virtual]\fP"
.PP
Procedure which initialise the exploration.
.PP
It save the current fitness as the initial value for the fitness.
.PP
Implements \fBmoMoveSelect< M >\fP.
.PP
Definition at line 60 of file moFirstImprSelect.h.
.PP
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.
.PP
If the given fitness enables an improvment, the move (\fBmoMove\fP) should be applied to the current solution.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a move.
.br
\fI__fit\fP a fitness linked to the move.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE if the move does not improve the fitness.
.RE
.PP
.PP
Definition at line 77 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"
.PP
Procedure which saved the best move and fitness.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP the current move (result of the procedure).
.br
\fI__fit\fP the current fitness (result of the procedure).
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBEmptySelection\fP\fP if no move has improved the fitness.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 101 of file moFirstImprSelect.h.
.PP
References moFirstImprSelect< M >::best_fit, moFirstImprSelect< M >::best_move, and moFirstImprSelect< M >::valid.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

58
trunk/paradiseo-mo/doc/man/man3/moFitComparator.3 Normal file
View file

@ -0,0 +1,58 @@
.TH "moFitComparator" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moFitComparator \- Comparison according to the fitness.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moFitComparator.h>\fP
.PP
Inherits \fBmoComparator< EOT >< EOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &_solution1, const EOT &_solution2)"
.br
.RI "\fI\fBFunction\fP which makes the comparison and gives the result. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moFitComparator< EOT >"
Comparison according to the fitness.
An EOT is better than an other if its fitness is better.
.PP
Definition at line 45 of file moFitComparator.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoFitComparator\fP< EOT >::operator() (const EOT & _solution1, const EOT & _solution2)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which makes the comparison and gives the result.
.PP
\fBParameters:\fP
.RS 4
\fI_solution1\fP The first solution.
.br
\fI_solution2\fP The second solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true if the fitness of the first solution is better than the second solution, false else.
.RE
.PP
.PP
Implements \fBeoBF< const EOT &, const EOT &, bool >\fP.
.PP
Definition at line 55 of file moFitComparator.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

107
trunk/paradiseo-mo/doc/man/man3/moFitSolContinue.3 Normal file
View file

@ -0,0 +1,107 @@
.TH "moFitSolContinue" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moFitSolContinue \- One possible stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moFitSolContinue.h>\fP
.PP
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoFitSolContinue\fP (\fBFitness\fP __fitness)"
.br
.RI "\fIBasic constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
.RI "\fI\fBFunction\fP that activates the stopping criterion. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise all the stuff needed. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBFitness\fP \fBfitness\fP"
.br
.RI "\fIFitness target. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moFitSolContinue< EOT >"
One possible stop criterion for a solution-based heuristic.
The stop criterion corresponds to a fitness threshold gained.
.PP
Definition at line 46 of file moFitSolContinue.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBmoFitSolContinue\fP< EOT >::\fBmoFitSolContinue\fP (\fBFitness\fP __fitness)\fC [inline]\fP"
.PP
Basic constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__fitness\fP The fitness to reach.
.RE
.PP
.PP
Definition at line 58 of file moFitSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoFitSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that activates the stopping criterion.
.PP
Indicates if the fitness threshold has not yet been reached.
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP the current solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true or false according to the value of the fitness.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 68 of file moFitSolContinue.h.
.PP
References moFitSolContinue< EOT >::fitness.
.SS "template<class EOT> void \fBmoFitSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise all the stuff needed.
.PP
It can be also used to reinitialize all the needed things.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 82 of file moFitSolContinue.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

105
trunk/paradiseo-mo/doc/man/man3/moGenSolContinue.3 Normal file
View file

@ -0,0 +1,105 @@
.TH "moGenSolContinue" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moGenSolContinue \- One possible stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moGenSolContinue.h>\fP
.PP
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoGenSolContinue\fP (unsigned int __maxNumGen)"
.br
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
.RI "\fI\fBFunction\fP that activates the stop criterion. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise the generation counter. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned int \fBmaxNumGen\fP"
.br
.RI "\fIIteration maximum number. \fP"
.ti -1c
.RI "unsigned int \fBnumGen\fP"
.br
.RI "\fIIteration current number. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moGenSolContinue< EOT >"
One possible stop criterion for a solution-based heuristic.
The stop criterion corresponds to a maximum number of iteration.
.PP
Definition at line 46 of file moGenSolContinue.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBmoGenSolContinue\fP< EOT >::\fBmoGenSolContinue\fP (unsigned int __maxNumGen)\fC [inline]\fP"
.PP
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__maxNumGen\fP the maximum number of generation.
.RE
.PP
.PP
Definition at line 55 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"
.PP
\fBFunction\fP 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
\fBParameters:\fP
.RS 4
\fI__sol\fP the current solution.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE or FALSE according to the current generation number.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 69 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::maxNumGen, and moGenSolContinue< EOT >::numGen.
.SS "template<class EOT> void \fBmoGenSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise the generation counter.
.PP
It can also be used to reset the iteration counter.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 79 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::numGen.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

132
trunk/paradiseo-mo/doc/man/man3/moHC.3 Normal file
View file

@ -0,0 +1,132 @@
.TH "moHC" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moHC \- Hill Climbing (HC).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moHC.h>\fP
.PP
Inherits \fBmoAlgo< M::EOType >\fP.
.PP
.SS "Public Member Functions"
.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)"
.br
.RI "\fIFull constructor. \fP"
.ti -1c
.RI "\fBmoHC\fP (\fBmoMoveExpl\fP< M > &__move_expl, \fBeoEvalFunc\fP< \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"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoMoveExpl\fP< M > & \fBmove_expl\fP"
.br
.RI "\fIComplete exploration of the neighborhood. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIA full evaluation function. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moHC< M >"
Hill Climbing (HC).
Class which describes the algorithm for a hill climbing.
.PP
Definition at line 50 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"
.PP
Full constructor.
.PP
All the boxes are given in order the HC to use a \fBmoHCMoveLoopExpl\fP.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP a move initialiser.
.br
\fI__next_move\fP a neighborhood explorer.
.br
\fI__incr_eval\fP a (generally) efficient evaluation function.
.br
\fI__move_select\fP a move selector.
.br
\fI__full_eval\fP a full evaluation function.
.RE
.PP
.PP
Definition at line 77 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"
.PP
Light constructor.
.PP
This constructor allow to use another \fBmoMoveExpl\fP (generally not a \fBmoHCMoveLoopExpl\fP).
.PP
\fBParameters:\fP
.RS 4
\fI__move_expl\fP a complete explorer.
.br
\fI__full_eval\fP a full evaluation function.
.RE
.PP
.PP
Definition at line 91 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"
.PP
\fBFunction\fP 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
\fBParameters:\fP
.RS 4
\fI__sol\fP a current solution to improve.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 106 of file moHC.h.
.PP
References moHC< M >::full_eval, and moHC< M >::move_expl.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

113
trunk/paradiseo-mo/doc/man/man3/moHCMoveLoopExpl.3 Normal file
View file

@ -0,0 +1,113 @@
.TH "moHCMoveLoopExpl" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moHCMoveLoopExpl \- Iterative explorer used by a \fBmoHC\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moHCMoveLoopExpl.h>\fP
.PP
Inherits \fBmoMoveLoopExpl< M >< M >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoHCMoveLoopExpl\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoMoveSelect\fP< M > &__move_select)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "void \fBoperator()\fP (const \fBEOT\fP &__old_sol, \fBEOT\fP &__new_sol)"
.br
.RI "\fIProcedure which launches the explorer. \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoMoveInit\fP< M > & \fBmove_init\fP"
.br
.RI "\fIMove initialiser. \fP"
.ti -1c
.RI "\fBmoNextMove\fP< M > & \fBnext_move\fP"
.br
.RI "\fINeighborhood explorer. \fP"
.ti -1c
.RI "\fBmoMoveIncrEval\fP< M > & \fBincr_eval\fP"
.br
.RI "\fI(generally) Efficient evaluation. \fP"
.ti -1c
.RI "\fBmoMoveSelect\fP< M > & \fBmove_select\fP"
.br
.RI "\fIMove selector. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moHCMoveLoopExpl< M >"
Iterative explorer used by a \fBmoHC\fP.
.PP
Definition at line 48 of file moHCMoveLoopExpl.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoHCMoveLoopExpl\fP< M >::\fBmoHCMoveLoopExpl\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoMoveSelect\fP< M > & __move_select)\fC [inline]\fP"
.PP
Constructor.
.PP
All the boxes have to be specified.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP the move initialiser.
.br
\fI__next_move\fP the neighborhood explorer.
.br
\fI__incr_eval\fP (generally) efficient evaluation function.
.br
\fI__move_select\fP the move selector.
.RE
.PP
.PP
Definition at line 68 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"
.PP
Procedure which launches the explorer.
.PP
The exploration starts from an old solution and provides a new solution.
.PP
\fBParameters:\fP
.RS 4
\fI__old_sol\fP the current solution.
.br
\fI__new_sol\fP the new_sol (result of the procedure).
.RE
.PP
.PP
Implements \fBeoBF< const M::EOType &, M::EOType &, void >\fP.
.PP
Definition at line 84 of file moHCMoveLoopExpl.h.
.PP
References moHCMoveLoopExpl< M >::incr_eval, moHCMoveLoopExpl< M >::move_init, moHCMoveLoopExpl< M >::move_select, and moHCMoveLoopExpl< M >::next_move.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

220
trunk/paradiseo-mo/doc/man/man3/moILS.3 Normal file
View file

@ -0,0 +1,220 @@
.TH "moILS" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moILS \- Iterated Local Search (ILS).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moILS.h>\fP
.PP
Inherits \fBmoAlgo< M::EOType >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoILS\fP (\fBmoAlgo\fP< \fBEOT\fP > &__algo, \fBmoSolContinue\fP< \fBEOT\fP > &__continue, \fBmoComparator\fP< \fBEOT\fP > &__acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > &__perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIGeneric constructor. \fP"
.ti -1c
.RI "\fBmoILS\fP (\fBmoMoveInit\fP< M > &__move_init, \fBmoNextMove\fP< M > &__next_move, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoMoveSelect\fP< M > &__move_select, \fBmoSolContinue\fP< \fBEOT\fP > &__continue, \fBmoComparator\fP< \fBEOT\fP > &__acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > &__perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIConstructor for using a \fBmoHC\fP for the \fBmoAlgo\fP. \fP"
.ti -1c
.RI "\fBmoILS\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 > &__moTS_continue, \fBmoSolContinue\fP< \fBEOT\fP > &__continue, \fBmoComparator\fP< \fBEOT\fP > &__acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > &__perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIConstructor for using a \fBmoTS\fP for the \fBmoAlgo\fP. \fP"
.ti -1c
.RI "\fBmoILS\fP (\fBmoRandMove\fP< M > &__move_rand, \fBmoMoveIncrEval\fP< M > &__incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > &__moSA_continue, double __init_temp, \fBmoCoolingSchedule\fP &__cool_sched, \fBmoSolContinue\fP< \fBEOT\fP > &__continue, \fBmoComparator\fP< \fBEOT\fP > &__acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > &__perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIConstructor for using a \fBmoSA\fP for the \fBmoAlgo\fP. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (\fBEOT\fP &__sol)"
.br
.RI "\fI\fBFunction\fP which launches the ILS. \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoAlgo\fP< \fBEOT\fP > & \fBalgo\fP"
.br
.RI "\fIThe solution based heuristic. \fP"
.ti -1c
.RI "\fBmoSolContinue\fP< \fBEOT\fP > & \fBcont\fP"
.br
.RI "\fIThe stopping criterion. \fP"
.ti -1c
.RI "\fBmoComparator\fP< \fBEOT\fP > & \fBacceptance_criterion\fP"
.br
.RI "\fIThe acceptance criterion. \fP"
.ti -1c
.RI "\fBeoMonOp\fP< \fBEOT\fP > & \fBperturbation\fP"
.br
.RI "\fIThe perturbation generator. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIThe full evaluation function. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moILS< M >"
Iterated Local Search (ILS).
Class which describes the algorithm for a iterated local search.
.PP
Definition at line 50 of file moILS.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoILS\fP< M >::\fBmoILS\fP (\fBmoAlgo\fP< \fBEOT\fP > & __algo, \fBmoSolContinue\fP< \fBEOT\fP > & __continue, \fBmoComparator\fP< \fBEOT\fP > & __acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > & __perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Generic constructor.
.PP
Generic constructor using a \fBmoAlgo\fP
.PP
\fBParameters:\fP
.RS 4
\fI__algo\fP The solution based heuristic to use.
.br
\fI__continue\fP The stopping criterion.
.br
\fI__acceptance_criterion\fP The acceptance criterion.
.br
\fI__perturbation\fP The pertubation generator.
.br
\fI__full_eval\fP The evaluation function.
.RE
.PP
.PP
Definition at line 71 of file moILS.h.
.SS "template<class M> \fBmoILS\fP< M >::\fBmoILS\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoMoveSelect\fP< M > & __move_select, \fBmoSolContinue\fP< \fBEOT\fP > & __continue, \fBmoComparator\fP< \fBEOT\fP > & __acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > & __perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor for using a \fBmoHC\fP for the \fBmoAlgo\fP.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP The move initialisation (for the \fBmoHC\fP).
.br
\fI__next_move\fP The move generator (for the \fBmoHC\fP).
.br
\fI__incr_eval\fP The partial evaluation function (for the \fBmoHC\fP).
.br
\fI__move_select\fP The move selection strategy (for the \fBmoHC\fP).
.br
\fI__continue\fP The stopping criterion.
.br
\fI__acceptance_criterion\fP The acceptance criterion.
.br
\fI__perturbation\fP The pertubation generator.
.br
\fI__full_eval\fP The evaluation function.
.RE
.PP
.PP
Definition at line 87 of file moILS.h.
.SS "template<class M> \fBmoILS\fP< M >::\fBmoILS\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 > & __moTS_continue, \fBmoSolContinue\fP< \fBEOT\fP > & __continue, \fBmoComparator\fP< \fBEOT\fP > & __acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > & __perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor for using a \fBmoTS\fP for the \fBmoAlgo\fP.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP The move initialisation (for the \fBmoTS\fP).
.br
\fI__next_move\fP The move generator (for the \fBmoTS\fP).
.br
\fI__incr_eval\fP The partial evaluation function (for the \fBmoTS\fP).
.br
\fI__tabu_list\fP The tabu list (for the \fBmoTS\fP !!!!).
.br
\fI__aspir_crit\fP The aspiration criterion (for the \fBmoTS\fP).
.br
\fI__moTS_continue\fP The stopping criterion (for the \fBmoTS\fP).
.br
\fI__continue\fP The stopping criterion.
.br
\fI__acceptance_criterion\fP The acceptance criterion.
.br
\fI__perturbation\fP The pertubation generator.
.br
\fI__full_eval\fP The evaluation function.
.RE
.PP
.PP
Definition at line 107 of file moILS.h.
.SS "template<class M> \fBmoILS\fP< M >::\fBmoILS\fP (\fBmoRandMove\fP< M > & __move_rand, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > & __moSA_continue, double __init_temp, \fBmoCoolingSchedule\fP & __cool_sched, \fBmoSolContinue\fP< \fBEOT\fP > & __continue, \fBmoComparator\fP< \fBEOT\fP > & __acceptance_criterion, \fBeoMonOp\fP< \fBEOT\fP > & __perturbation, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor for using a \fBmoSA\fP for the \fBmoAlgo\fP.
.PP
\fBParameters:\fP
.RS 4
\fI__move_rand\fP The random move generator (for the \fBmoSA\fP).
.br
\fI__incr_eval\fP The partial evaluation function (for the \fBmoSA\fP).
.br
\fI__moSA_continue\fP The stopping criterion (for the \fBmoSA\fP).
.br
\fI__init_temp\fP The initial temperature (for the \fBmoSA\fP).
.br
\fI__cool_sched\fP The cooling scheduler (for the \fBmoSA\fP).
.br
\fI__continue\fP The stopping criterion.
.br
\fI__acceptance_criterion\fP The acceptance criterion.
.br
\fI__perturbation\fP The pertubation generator.
.br
\fI__full_eval\fP The evaluation function.
.RE
.PP
.PP
Definition at line 127 of file moILS.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoILS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which launches the ILS.
.PP
The ILS has to improve a current solution. As the \fBmoSA\fP, the \fBmoTS\fP and the \fBmoHC\fP, it can be used for HYBRIDATION in an evolutionnary algorithm.
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP a current solution to improve.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 144 of file moILS.h.
.PP
References moILS< M >::acceptance_criterion, moILS< M >::algo, moILS< M >::cont, moILS< M >::full_eval, and moILS< M >::perturbation.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

90
trunk/paradiseo-mo/doc/man/man3/moImprBestFitAspirCrit.3 Normal file
View file

@ -0,0 +1,90 @@
.TH "moImprBestFitAspirCrit" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moImprBestFitAspirCrit \- One of the possible \fBmoAspirCrit\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moImprBestFitAspirCrit.h>\fP
.PP
Inherits \fBmoAspirCrit< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoImprBestFitAspirCrit\fP ()"
.br
.RI "\fIContructor. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIInitialisation procedure. \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"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBFitness\fP \fBbest_fit\fP"
.br
.RI "\fIBest fitness found until now. \fP"
.ti -1c
.RI "bool \fBfirst_time\fP"
.br
.RI "\fIIndicates that a fitness has been already saved or not. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moImprBestFitAspirCrit< M >"
One of the possible \fBmoAspirCrit\fP.
This criterion is satisfied when a given fitness is the best ever considered.
.PP
Definition at line 47 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, virtual]\fP"
.PP
\fBFunction\fP 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
\fBParameters:\fP
.RS 4
\fI__move\fP a move.
.br
\fI__fit\fP a fitnes linked to the move.
.RE
.PP
\fBReturns:\fP
.RS 4
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 77 of file moImprBestFitAspirCrit.h.
.PP
References moImprBestFitAspirCrit< M >::best_fit, and moImprBestFitAspirCrit< M >::first_time.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

108
trunk/paradiseo-mo/doc/man/man3/moItRandNextMove.3 Normal file
View file

@ -0,0 +1,108 @@
.TH "moItRandNextMove" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moItRandNextMove \- One of the possible \fBmoNextMove\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moItRandNextMove.h>\fP
.PP
Inherits \fBmoNextMove< M >< M >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoItRandNextMove\fP (\fBmoRandMove\fP< M > &__rand_move, unsigned int __max_iter)"
.br
.RI "\fIThe constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (M &__move, const \fBEOT\fP &__sol)"
.br
.RI "\fIGeneration of a new move. \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoRandMove\fP< M > & \fBrand_move\fP"
.br
.RI "\fIA move generator (generally randomly). \fP"
.ti -1c
.RI "unsigned int \fBmax_iter\fP"
.br
.RI "\fIIteration maximum number. \fP"
.ti -1c
.RI "unsigned int \fBnum_iter\fP"
.br
.RI "\fIIteration current number. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moItRandNextMove< M >"
One of the possible \fBmoNextMove\fP.
This class is a move (\fBmoMove\fP) generator with a bound for the maximum number of iterations.
.PP
Definition at line 47 of file moItRandNextMove.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoItRandNextMove\fP< M >::\fBmoItRandNextMove\fP (\fBmoRandMove\fP< M > & __rand_move, unsigned int __max_iter)\fC [inline]\fP"
.PP
The constructor.
.PP
\fBParameters\fP only for initialising the attributes.
.PP
\fBParameters:\fP
.RS 4
\fI__rand_move\fP the random move generator.
.br
\fI__max_iter\fP the iteration maximum number.
.RE
.PP
.PP
Definition at line 62 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, virtual]\fP"
.PP
Generation of a new move.
.PP
If the maximum number is not already reached, the current move is forgotten and remplaced by another one.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP the current move.
.br
\fI__sol\fP the current solution.
.RE
.PP
\fBReturns:\fP
.RS 4
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 77 of file moItRandNextMove.h.
.PP
References moItRandNextMove< M >::max_iter, moItRandNextMove< M >::num_iter, and moItRandNextMove< M >::rand_move.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

83
trunk/paradiseo-mo/doc/man/man3/moLSCheckPoint.3 Normal file
View file

@ -0,0 +1,83 @@
.TH "moLSCheckPoint" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moLSCheckPoint \- Class which allows a checkpointing system.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moLSCheckPoint.h>\fP
.PP
Inherits \fBeoBF< const M &, const 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"
.ti -1c
.RI "void \fBadd\fP (\fBeoBF\fP< const M &, const typename M::EOType &, void > &__f)"
.br
.RI "\fIProcedure which add a new function to the function vector. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::vector< \fBeoBF\fP< const M &, const typename M::EOType &, void > * > \fBfunc\fP"
.br
.RI "\fIvector of function \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moLSCheckPoint< M >"
Class which allows a checkpointing system.
Thanks to this class, at each iteration, additionnal function can be used (and not only one).
.PP
Definition at line 46 of file moLSCheckPoint.h.
.SH "Member Function Documentation"
.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.
.PP
Each saved function is used on the current move and the current solution.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a move.
.br
\fI__sol\fP a solution.
.RE
.PP
.PP
Definition at line 59 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"
.PP
Procedure which add a new function to the function vector.
.PP
The new function is added at the end of the vector.
.PP
\fBParameters:\fP
.RS 4
\fI__f\fP a new function to add.
.RE
.PP
.PP
Definition at line 74 of file moLSCheckPoint.h.
.PP
References moLSCheckPoint< M >::func.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

90
trunk/paradiseo-mo/doc/man/man3/moLinearCoolingSchedule.3 Normal file
View file

@ -0,0 +1,90 @@
.TH "moLinearCoolingSchedule" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moLinearCoolingSchedule \- One of the possible \fBmoCoolingSchedule\fP.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moLinearCoolingSchedule.h>\fP
.PP
Inherits \fBmoCoolingSchedule\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoLinearCoolingSchedule\fP (double __threshold, double __quantity)"
.br
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
.RI "\fI\fBFunction\fP which proceeds to the cooling. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBthreshold\fP"
.br
.RI "\fIThe temperature threhold. \fP"
.ti -1c
.RI "double \fBquantity\fP"
.br
.RI "\fIThe quantity that allows the temperature to decrease. \fP"
.in -1c
.SH "Detailed Description"
.PP
One of the possible \fBmoCoolingSchedule\fP.
An another very simple cooling schedule, the temperature decrease according to a quantity while the temperature is greater than a threshold.
.PP
Definition at line 47 of file moLinearCoolingSchedule.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "moLinearCoolingSchedule::moLinearCoolingSchedule (double __threshold, double __quantity)\fC [inline]\fP"
.PP
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__threshold\fP the threshold.
.br
\fI__quantity\fP the quantity used to descrease the temperature.
.RE
.PP
.PP
Definition at line 56 of file moLinearCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP which proceeds to the cooling.
.PP
It decreases the temperature and indicates if it is greater than the threshold.
.PP
\fBParameters:\fP
.RS 4
\fI__temp\fP the current temperature.
.RE
.PP
\fBReturns:\fP
.RS 4
if the new temperature (current temperature - quantity) is greater than the threshold.
.RE
.PP
.PP
Implements \fBeoUF< double &, bool >\fP.
.PP
Definition at line 66 of file moLinearCoolingSchedule.h.
.PP
References quantity, and threshold.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

35
trunk/paradiseo-mo/doc/man/man3/moMove.3 Normal file
View file

@ -0,0 +1,35 @@
.TH "moMove" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMove \- Definition of a move.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moMove.h>\fP
.PP
Inherits \fBeoUF< EOT &, void >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef EOT \fBEOType\fP"
.br
.RI "\fIAlias for the type. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moMove< EOT >"
Definition of a move.
A move transforms a solution to another close solution. It describes how a solution can be modified to another one.
.PP
Definition at line 48 of file moMove.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

29
trunk/paradiseo-mo/doc/man/man3/moMoveExpl.3 Normal file
View file

@ -0,0 +1,29 @@
.TH "moMoveExpl" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMoveExpl \- Description of a move (\fBmoMove\fP) explorer.
.PP
.SH SYNOPSIS
.br
.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"
.PP
.SS "template<class M> class moMoveExpl< M >"
Description of a move (\fBmoMove\fP) explorer.
Only a description...See \fBmoMoveLoopExpl\fP.
.PP
Definition at line 46 of file moMoveExpl.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

27
trunk/paradiseo-mo/doc/man/man3/moMoveIncrEval.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "moMoveIncrEval" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMoveIncrEval \- (generally) Efficient evaluation function based a move and a solution.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moMoveIncrEval.h>\fP
.PP
Inherits \fBeoBF< const M &, const M::EOType &, M::EOType::Fitness >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class M> class moMoveIncrEval< M >"
(generally) Efficient evaluation function based a move and a solution.
From a move and a solution, it computes a new fitness that could be associated to the solution if this one is updated.
.PP
Definition at line 49 of file moMoveIncrEval.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

27
trunk/paradiseo-mo/doc/man/man3/moMoveInit.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "moMoveInit" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMoveInit \- Move (\fBmoMove\fP) initializer.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moMoveInit.h>\fP
.PP
Inherits \fBeoBF< M &, const M::EOType &, void >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class M> class moMoveInit< M >"
Move (\fBmoMove\fP) initializer.
Class which allows to initiase a move. Only a description... An object that herits from this class needs to be designed to be used.
.PP
Definition at line 47 of file moMoveInit.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

29
trunk/paradiseo-mo/doc/man/man3/moMoveLoopExpl.3 Normal file
View file

@ -0,0 +1,29 @@
.TH "moMoveLoopExpl" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMoveLoopExpl \- Class which describes an iterative explorer.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moMoveLoopExpl.h>\fP
.PP
Inherits \fBmoMoveExpl< M >< M >\fP.
.PP
Inherited by \fBmoHCMoveLoopExpl< M >\fP, and \fBmoTSMoveLoopExpl< M >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class M> class moMoveLoopExpl< M >"
Class which describes an iterative explorer.
Only a description... \fBmoHCMoveLoopExpl\fP and \fBmoTSMoveLoopExpl\fP are exemples of class that are a \fBmoMoveLoopExpl\fP.
.PP
Definition at line 46 of file moMoveLoopExpl.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

84
trunk/paradiseo-mo/doc/man/man3/moMoveSelect.3 Normal file
View file

@ -0,0 +1,84 @@
.TH "moMoveSelect" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moMoveSelect \- Class that describes a move selector (\fBmoMove\fP).
.PP
.SH SYNOPSIS
.br
.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"
.in +1c
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBinit\fP (const \fBFitness\fP &__fit)=0"
.br
.RI "\fIProcedure which initialises all that the move selector needs including the initial fitness. \fP"
.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"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moMoveSelect< M >"
Class that describes a move selector (\fBmoMove\fP).
It iteratively considers some moves (\fBmoMove\fP) and their associated fitnesses. The best move is so regularly updated. At any time, it could be accessed.
.PP
Definition at line 57 of file moMoveSelect.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> virtual void \fBmoMoveSelect\fP< M >::init (const \fBFitness\fP & __fit)\fC [pure virtual]\fP"
.PP
Procedure which initialises all that the move selector needs including the initial fitness.
.PP
In order to know the fitness of the solution, for which the neighborhood will be soon explored
.PP
\fBParameters:\fP
.RS 4
\fI__fit\fP the current fitness.
.RE
.PP
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a new move.
.br
\fI__fit\fP a fitness linked to the new move.
.RE
.PP
\fBReturns:\fP
.RS 4
a boolean that expresses the need to resume the exploration.
.RE
.PP
.PP
Implemented in \fBmoBestImprSelect< M >\fP, and \fBmoRandImprSelect< M >\fP.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

29
trunk/paradiseo-mo/doc/man/man3/moNextMove.3 Normal file
View file

@ -0,0 +1,29 @@
.TH "moNextMove" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moNextMove \- Class which allows to generate a new move (\fBmoMove\fP).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moNextMove.h>\fP
.PP
Inherits \fBeoBF< M &, const M::EOType &, bool >\fP.
.PP
Inherited by \fBmoItRandNextMove< M >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class M> class moNextMove< M >"
Class which allows to generate a new move (\fBmoMove\fP).
Useful for the explorer (for \fBmoTS\fP or \fBmoHC\fP). Does nothing... An object that herits from this class needs to be designed for being used.
.PP
Definition at line 47 of file moNextMove.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

71
trunk/paradiseo-mo/doc/man/man3/moNoAspirCrit.3 Normal file
View file

@ -0,0 +1,71 @@
.TH "moNoAspirCrit" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moNoAspirCrit \- One of the possible aspiration criterion (\fBmoAspirCrit\fP).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moNoAspirCrit.h>\fP
.PP
Inherits \fBmoAspirCrit< M >< M >\fP.
.PP
.SS "Private Member Functions"
.in +1c
.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"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which initialises all that needs a \fBmoNoAspirCrit\fP. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moNoAspirCrit< M >"
One of the possible aspiration criterion (\fBmoAspirCrit\fP).
The simplest : never satisfied.
.PP
Definition at line 46 of file moNoAspirCrit.h.
.SH "Member Function Documentation"
.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.
.PP
Does nothing.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a move.
.br
\fI__sol\fP a fitness.
.RE
.PP
\fBReturns:\fP
.RS 4
FALSE.
.RE
.PP
.PP
Definition at line 57 of file moNoAspirCrit.h.
.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
Nothing...
.PP
Implements \fBmoAspirCrit< M >\fP.
.PP
Definition at line 68 of file moNoAspirCrit.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

121
trunk/paradiseo-mo/doc/man/man3/moNoFitImprSolContinue.3 Normal file
View file

@ -0,0 +1,121 @@
.TH "moNoFitImprSolContinue" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moNoFitImprSolContinue \- One possible stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moNoFitImprSolContinue.h>\fP
.PP
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoNoFitImprSolContinue\fP (unsigned int __maxNumberOfIterationWithoutImprovement)"
.br
.RI "\fIBasic constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
.RI "\fI\fBFunction\fP that activates the stopping criterion. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise all the stuff needed. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned int \fBmaxNumberOfIterationsWithoutImprovement\fP"
.br
.RI "\fIMaximum number of iterations without improvement allowed. \fP"
.ti -1c
.RI "bool \fBfirstFitnessSaved\fP"
.br
.RI "\fIFlag that this is the first time that the fitness is used. \fP"
.ti -1c
.RI "\fBFitness\fP \fBfitness\fP"
.br
.RI "\fICurrent Fitness. \fP"
.ti -1c
.RI "unsigned int \fBcounter\fP"
.br
.RI "\fIThe iteration couter. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moNoFitImprSolContinue< EOT >"
One possible stop criterion for a solution-based heuristic.
The stop criterion corresponds to a maximum number of iterations without improvement.
.PP
Definition at line 46 of file moNoFitImprSolContinue.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBmoNoFitImprSolContinue\fP< EOT >::\fBmoNoFitImprSolContinue\fP (unsigned int __maxNumberOfIterationWithoutImprovement)\fC [inline]\fP"
.PP
Basic constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__maxNumberOfIterationWithoutImprovement\fP The number of iterations without fitness improvement to reach for stop.
.RE
.PP
.PP
Definition at line 58 of file moNoFitImprSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoNoFitImprSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that activates the stopping criterion.
.PP
Indicates if the fitness has not been improved since a given number of iterations (after a minimum of iterations).
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP the current solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true or false.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 68 of file moNoFitImprSolContinue.h.
.PP
References moNoFitImprSolContinue< EOT >::counter, moNoFitImprSolContinue< EOT >::firstFitnessSaved, moNoFitImprSolContinue< EOT >::fitness, and moNoFitImprSolContinue< EOT >::maxNumberOfIterationsWithoutImprovement.
.SS "template<class EOT> void \fBmoNoFitImprSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise all the stuff needed.
.PP
It can be also used to reinitialize all the needed things.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 102 of file moNoFitImprSolContinue.h.
.PP
References moNoFitImprSolContinue< EOT >::counter, and moNoFitImprSolContinue< EOT >::firstFitnessSaved.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

137
trunk/paradiseo-mo/doc/man/man3/moRandImprSelect.3 Normal file
View file

@ -0,0 +1,137 @@
.TH "moRandImprSelect" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moRandImprSelect \- One of the possible \fBmoMove\fP selector (\fBmoMoveSelect\fP).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moRandImprSelect.h>\fP
.PP
Inherits \fBmoMoveSelect< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "void \fBinit\fP (const \fBFitness\fP &__fit)"
.br
.RI "\fIProcedure which all that needs a \fBmoRandImprSelect\fP. \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"
.ti -1c
.RI "void \fBoperator()\fP (M &__move, \fBFitness\fP &__fit) throw (EmptySelection)"
.br
.RI "\fIThe move selection. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBFitness\fP \fBinit_fit\fP"
.br
.RI "\fIFitness of the current solution. \fP"
.ti -1c
.RI "std::vector< \fBFitness\fP > \fBvect_better_fit\fP"
.br
.RI "\fICandidate fitnesse vector. \fP"
.ti -1c
.RI "std::vector< M > \fBvect_better_moves\fP"
.br
.RI "\fICandidate move vector. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moRandImprSelect< M >"
One of the possible \fBmoMove\fP selector (\fBmoMoveSelect\fP).
All the neighbors are considered. One of them that enables an improvment of the objective function is choosen.
.PP
Definition at line 50 of file moRandImprSelect.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> void \fBmoRandImprSelect\fP< M >::init (const \fBFitness\fP & __fit)\fC [inline, virtual]\fP"
.PP
Procedure which all that needs a \fBmoRandImprSelect\fP.
.PP
Give a value to the initialise fitness. Clean the move and fitness vectors.
.PP
\fBParameters:\fP
.RS 4
\fI__fit\fP the current best fitness
.RE
.PP
.PP
Implements \fBmoMoveSelect< M >\fP.
.PP
Definition at line 65 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> 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.
.PP
if a move give a better fitness than the initial fitness, it is saved and the fitness too.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a new move.
.br
\fI__fit\fP a new fitness associated to the new move.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE.
.RE
.PP
.PP
Implements \fBmoMoveSelect< M >\fP.
.PP
Definition at line 81 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"
.PP
The move selection.
.PP
One the saved move is randomly chosen.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP the reference of the move that can be initialised by the function.
.br
\fI__fit\fP the reference of the fitness that can be initialised by the function.
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBEmptySelection\fP\fP If no move which improves the current fitness are found.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 102 of file moRandImprSelect.h.
.PP
References eoRng::random(), moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

27
trunk/paradiseo-mo/doc/man/man3/moRandMove.3 Normal file
View file

@ -0,0 +1,27 @@
.TH "moRandMove" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moRandMove \- Random move generator.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moRandMove.h>\fP
.PP
Inherits \fBeoUF< M &, void >\fP.
.PP
.SH "Detailed Description"
.PP
.SS "template<class M> class moRandMove< M >"
Random move generator.
Only a description... An object that herits from this class needs to be designed in order to use a \fBmoSA\fP.
.PP
Definition at line 46 of file moRandMove.h.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

130
trunk/paradiseo-mo/doc/man/man3/moSA.3 Normal file
View file

@ -0,0 +1,130 @@
.TH "moSA" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSA \- Simulated Annealing (SA).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moSA.h>\fP
.PP
Inherits \fBmoAlgo< M::EOType >\fP.
.PP
.SS "Public Member Functions"
.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)"
.br
.RI "\fISA constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (\fBEOT\fP &__sol)"
.br
.RI "\fIfunction that launches the SA algorithm. \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoRandMove\fP< M > & \fBmove_rand\fP"
.br
.RI "\fIA move generator (generally randomly). \fP"
.ti -1c
.RI "\fBmoMoveIncrEval\fP< M > & \fBincr_eval\fP"
.br
.RI "\fIA (generally) efficient evaluation function. \fP"
.ti -1c
.RI "\fBmoSolContinue\fP< \fBEOT\fP > & \fBcont\fP"
.br
.RI "\fIStopping criterion before temperature update. \fP"
.ti -1c
.RI "double \fBinit_temp\fP"
.br
.RI "\fIInitial temperature. \fP"
.ti -1c
.RI "\fBmoCoolingSchedule\fP & \fBcool_sched\fP"
.br
.RI "\fIThe cooling schedule. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIA full evaluation function. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moSA< M >"
Simulated Annealing (SA).
Class that describes a Simulated Annealing algorithm.
.PP
Definition at line 55 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"
.PP
SA constructor.
.PP
All the boxes used by a SA need to be given.
.PP
\fBParameters:\fP
.RS 4
\fI__move_rand\fP a move generator (generally randomly).
.br
\fI__incr_eval\fP a (generaly) efficient evaluation function
.br
\fI__cont\fP a stopping criterion.
.br
\fI__init_temp\fP the initial temperature.
.br
\fI__cool_sched\fP a cooling schedule, describes how the temperature is modified.
.br
\fI__full_eval\fP a full evaluation function.
.RE
.PP
.PP
Definition at line 83 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"
.PP
function that launches the SA algorithm.
.PP
As a \fBmoTS\fP or a \fBmoHC\fP, the SA can be used for HYBRIDATION in an evolutionary algorithm.
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP a solution to improve.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 105 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().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

160
trunk/paradiseo-mo/doc/man/man3/moSimpleMoveTabuList.3 Normal file
View file

@ -0,0 +1,160 @@
.TH "moSimpleMoveTabuList" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSimpleMoveTabuList \- Class describing a move tabu list with a limited memory.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moSimpleMoveTabuList.h>\fP
.PP
Inherits \fBmoTabuList< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoSimpleMoveTabuList\fP (unsigned int __size)"
.br
.RI "\fIConstructor. \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"
.ti -1c
.RI "void \fBadd\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
.RI "\fIProcedure to add a move in the tabu list. \fP"
.ti -1c
.RI "void \fBupdate\fP ()"
.br
.RI "\fIProcedure that updates the tabu list content. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which initialises the tabu list. \fP"
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "void \fBremoveMove\fP (const M &__move)"
.br
.RI "\fIProcedure that removes a given move from the tabu list (if it is into, else do nothing). \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned int \fBmaxSize\fP"
.br
.RI "\fIThe maximum size of the tabu list. \fP"
.ti -1c
.RI "unsigned int \fBcurrentSize\fP"
.br
.RI "\fIThe current size of the tabu list. \fP"
.ti -1c
.RI "std::list< M > \fBtabuList\fP"
.br
.RI "\fIThe move tabu list. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moSimpleMoveTabuList< M >"
Class describing a move tabu list with a limited memory.
.PP
Definition at line 47 of file moSimpleMoveTabuList.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoSimpleMoveTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that indicates if, in a given state, the _move is tabu or not.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP A given \fBmoMove\fP.
.br
\fI__sol\fP A solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true or false.
.RE
.PP
.PP
Implements \fBeoBF< const M &, const M::EOType &, bool >\fP.
.PP
Definition at line 71 of file moSimpleMoveTabuList.h.
.PP
References moSimpleMoveTabuList< M >::tabuList.
.SS "template<class M> void \fBmoSimpleMoveTabuList\fP< M >::add (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Procedure to add a move in the tabu list.
.PP
The two parameters have not to be modified so they are constant parameters.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a new tabu move.
.br
\fI__sol\fP the origianl solution associated to this move.
.RE
.PP
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 85 of file moSimpleMoveTabuList.h.
.PP
References moSimpleMoveTabuList< M >::currentSize, moSimpleMoveTabuList< M >::maxSize, moSimpleMoveTabuList< M >::removeMove(), and moSimpleMoveTabuList< M >::tabuList.
.SS "template<class M> void \fBmoSimpleMoveTabuList\fP< M >::update ()\fC [inline, virtual]\fP"
.PP
Procedure that updates the tabu list content.
.PP
Generally, a counter associated to each saved move is decreased by one.
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 107 of file moSimpleMoveTabuList.h.
.SS "template<class M> void \fBmoSimpleMoveTabuList\fP< M >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which initialises the tabu list.
.PP
Can be useful if the data structure needs to be allocated before being used.
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 113 of file moSimpleMoveTabuList.h.
.SS "template<class M> void \fBmoSimpleMoveTabuList\fP< M >::removeMove (const M & __move)\fC [inline, private]\fP"
.PP
Procedure that removes a given move from the tabu list (if it is into, else do nothing).
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP A given \fBmoMove\fP.
.RE
.PP
.PP
Definition at line 125 of file moSimpleMoveTabuList.h.
.PP
References moSimpleMoveTabuList< M >::tabuList.
.PP
Referenced by moSimpleMoveTabuList< M >::add().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

176
trunk/paradiseo-mo/doc/man/man3/moSimpleSolutionTabuList.3 Normal file
View file

@ -0,0 +1,176 @@
.TH "moSimpleSolutionTabuList" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSimpleSolutionTabuList \- Class describing a solution tabu list with limited length.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moSimpleSolutionTabuList.h>\fP
.PP
Inherits \fBmoTabuList< M >< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoSimpleSolutionTabuList\fP (unsigned int __size)"
.br
.RI "\fIConstructor. \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"
.ti -1c
.RI "void \fBadd\fP (const M &__move, const \fBEOT\fP &__sol)"
.br
.RI "\fIProcedure to add a move in the tabu list. \fP"
.ti -1c
.RI "void \fBupdate\fP ()"
.br
.RI "\fIProcedure that updates the tabu list content. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which initialises the tabu list. \fP"
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "void \fBremoveSolution\fP (const \fBEOT\fP &__sol)"
.br
.RI "\fIProcedure that removes a given solution from the tabu list (if it is into, else does nothing). \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned int \fBmaxSize\fP"
.br
.RI "\fIThe maximum size of the tabu list. \fP"
.ti -1c
.RI "unsigned int \fBcurrentSize\fP"
.br
.RI "\fIThe current size of the tabu list. \fP"
.ti -1c
.RI "std::list< \fBEOT\fP > \fBtabuList\fP"
.br
.RI "\fIThe solution tabu list. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moSimpleSolutionTabuList< M >"
Class describing a solution tabu list with limited length.
.PP
Definition at line 47 of file moSimpleSolutionTabuList.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoSimpleSolutionTabuList\fP< M >::\fBmoSimpleSolutionTabuList\fP (unsigned int __size)\fC [inline]\fP"
.PP
Constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__size\fP The maximum size of the solution tabu list.
.RE
.PP
.PP
Definition at line 59 of file moSimpleSolutionTabuList.h.
.PP
References moSimpleSolutionTabuList< M >::currentSize.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoSimpleSolutionTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that indicates if, in a given state, the _move is tabu or not.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP A given \fBmoMove\fP.
.br
\fI__sol\fP A solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true or false.
.RE
.PP
.PP
Implements \fBeoBF< const M &, const M::EOType &, bool >\fP.
.PP
Definition at line 70 of file moSimpleSolutionTabuList.h.
.PP
References moSimpleSolutionTabuList< M >::tabuList.
.SS "template<class M> void \fBmoSimpleSolutionTabuList\fP< M >::add (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Procedure to add a move in the tabu list.
.PP
The two parameters have not to be modified so they are constant parameters.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a new tabu move.
.br
\fI__sol\fP the origianl solution associated to this move.
.RE
.PP
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 89 of file moSimpleSolutionTabuList.h.
.PP
References moSimpleSolutionTabuList< M >::currentSize, moSimpleSolutionTabuList< M >::maxSize, moSimpleSolutionTabuList< M >::removeSolution(), and moSimpleSolutionTabuList< M >::tabuList.
.SS "template<class M> void \fBmoSimpleSolutionTabuList\fP< M >::update ()\fC [inline, virtual]\fP"
.PP
Procedure that updates the tabu list content.
.PP
Generally, a counter associated to each saved move is decreased by one.
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 116 of file moSimpleSolutionTabuList.h.
.SS "template<class M> void \fBmoSimpleSolutionTabuList\fP< M >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which initialises the tabu list.
.PP
Can be useful if the data structure needs to be allocated before being used.
.PP
Implements \fBmoTabuList< M >\fP.
.PP
Definition at line 122 of file moSimpleSolutionTabuList.h.
.SS "template<class M> void \fBmoSimpleSolutionTabuList\fP< M >::removeSolution (const \fBEOT\fP & __sol)\fC [inline, private]\fP"
.PP
Procedure that removes a given solution from the tabu list (if it is into, else does nothing).
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP A given solution.
.RE
.PP
.PP
Definition at line 134 of file moSimpleSolutionTabuList.h.
.PP
References moSimpleSolutionTabuList< M >::tabuList.
.PP
Referenced by moSimpleSolutionTabuList< M >::add().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

46
trunk/paradiseo-mo/doc/man/man3/moSolContinue.3 Normal file
View file

@ -0,0 +1,46 @@
.TH "moSolContinue" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSolContinue \- Class that describes a stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moSolContinue.h>\fP
.PP
Inherits \fBeoUF< const EOT &, bool >\fP.
.PP
Inherited by \fBmoFitSolContinue< EOT >\fP, \fBmoGenSolContinue< EOT >\fP, \fBmoNoFitImprSolContinue< EOT >\fP, and \fBmoSteadyFitSolContinue< EOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBinit\fP ()=0"
.br
.RI "\fIProcedure which initialises all that the stop criterion needs. \fP"
.in -1c
.SH "Detailed Description"
.PP
.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).
.PP
Definition at line 47 of file moSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> virtual void \fBmoSolContinue\fP< EOT >::init ()\fC [pure virtual]\fP"
.PP
Procedure which initialises all that the stop criterion needs.
.PP
Generally, it allocates some data structures or initialises some counters.
.PP
Implemented in \fBmoFitSolContinue< EOT >\fP, \fBmoGenSolContinue< EOT >\fP, \fBmoNoFitImprSolContinue< EOT >\fP, and \fBmoSteadyFitSolContinue< EOT >\fP.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

131
trunk/paradiseo-mo/doc/man/man3/moSteadyFitSolContinue.3 Normal file
View file

@ -0,0 +1,131 @@
.TH "moSteadyFitSolContinue" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSteadyFitSolContinue \- One possible stopping criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moSteadyFitSolContinue.h>\fP
.PP
Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoSteadyFitSolContinue\fP (unsigned int __maxNumberOfIterations, unsigned int __maxNumberOfIterationWithoutImprovement)"
.br
.RI "\fIBasic constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
.RI "\fI\fBFunction\fP that activates the stopping criterion. \fP"
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise the stuff needed. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned int \fBmaxNumberOfIterations\fP"
.br
.RI "\fIMaximum number of iterations before considering the fitness. \fP"
.ti -1c
.RI "unsigned int \fBmaxNumberOfIterationsWithoutImprovement\fP"
.br
.RI "\fIMaximum number of iterations without improvement allowed. \fP"
.ti -1c
.RI "bool \fBmaxNumberOfIterationsReached\fP"
.br
.RI "\fIFlag that indicates that the maxNumberIteration have been reached. \fP"
.ti -1c
.RI "bool \fBfirstFitnessSaved\fP"
.br
.RI "\fIFlag that this is the first time that the fitness is used. \fP"
.ti -1c
.RI "\fBFitness\fP \fBfitness\fP"
.br
.RI "\fICurrent Fitness. \fP"
.ti -1c
.RI "unsigned int \fBcounter\fP"
.br
.RI "\fIThe iteration couter. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moSteadyFitSolContinue< EOT >"
One possible stopping criterion for a solution-based heuristic.
The stop criterion corresponds to a maximum number of iterations without improvement (after a minimum number of iterations).
.PP
Definition at line 46 of file moSteadyFitSolContinue.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBmoSteadyFitSolContinue\fP< EOT >::\fBmoSteadyFitSolContinue\fP (unsigned int __maxNumberOfIterations, unsigned int __maxNumberOfIterationWithoutImprovement)\fC [inline]\fP"
.PP
Basic constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__maxNumberOfIterations\fP The number of iterations to reach before looking for the fitness.
.br
\fI__maxNumberOfIterationWithoutImprovement\fP The number of iterations without fitness improvement to reach for stop.
.RE
.PP
.PP
Definition at line 59 of file moSteadyFitSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoSteadyFitSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP that activates the stopping criterion.
.PP
Indicates if the fitness has not been improved since a number of iterations (after a minimum of iterations).
.PP
\fBParameters:\fP
.RS 4
\fI__sol\fP the current solution.
.RE
.PP
\fBReturns:\fP
.RS 4
true or false.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 71 of file moSteadyFitSolContinue.h.
.PP
References moSteadyFitSolContinue< EOT >::counter, moSteadyFitSolContinue< EOT >::firstFitnessSaved, moSteadyFitSolContinue< EOT >::fitness, moSteadyFitSolContinue< EOT >::maxNumberOfIterations, moSteadyFitSolContinue< EOT >::maxNumberOfIterationsReached, and moSteadyFitSolContinue< EOT >::maxNumberOfIterationsWithoutImprovement.
.SS "template<class EOT> void \fBmoSteadyFitSolContinue\fP< EOT >::init ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise the stuff needed.
.PP
It can be also used to reinitialize the counter all the needed things.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 115 of file moSteadyFitSolContinue.h.
.PP
References moSteadyFitSolContinue< EOT >::counter, moSteadyFitSolContinue< EOT >::firstFitnessSaved, and moSteadyFitSolContinue< EOT >::maxNumberOfIterationsReached.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

142
trunk/paradiseo-mo/doc/man/man3/moTS.3 Normal file
View file

@ -0,0 +1,142 @@
.TH "moTS" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moTS \- Tabu Search (TS).
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moTS.h>\fP
.PP
Inherits \fBmoAlgo< M::EOType >\fP.
.PP
.SS "Public Member Functions"
.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)"
.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)"
.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"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef EOT::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoMoveExpl\fP< M > & \fBmove_expl\fP"
.br
.RI "\fINeighborhood explorer. \fP"
.ti -1c
.RI "\fBmoSolContinue\fP< \fBEOT\fP > & \fBcont\fP"
.br
.RI "\fIStop criterion. \fP"
.ti -1c
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIFull evaluation function. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moTS< M >"
Tabu Search (TS).
Generic algorithm that describes a tabu search.
.PP
Definition at line 54 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"
.PP
Constructor of a \fBmoTS\fP specifying all the boxes.
.PP
In this constructor, a \fBmoTSMoveLoopExpl\fP is instanciated.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP move initialisation
.br
\fI__next_move\fP neighborhood explorer
.br
\fI__incr_eval\fP efficient evaluation
.br
\fI__tabu_list\fP tabu list
.br
\fI__aspir_crit\fP aspiration criterion
.br
\fI__cont\fP stop criterion
.br
\fI__full_eval\fP full evaluation function
.RE
.PP
.PP
Definition at line 83 of file moTS.h.
.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"
.PP
Constructor with less parameters.
.PP
The explorer is given in the parameters.
.PP
\fBParameters:\fP
.RS 4
\fI__move_expl\fP the explorer (generally different that a \fBmoTSMoveLoopExpl\fP)
.br
\fI__cont\fP stop criterion
.br
\fI__full_eval\fP full evaluation function
.RE
.PP
.PP
Definition at line 96 of file moTS.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
\fBFunction\fP 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
\fBParameters:\fP
.RS 4
\fI__sol\fP a solution to improve.
.RE
.PP
\fBReturns:\fP
.RS 4
TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 110 of file moTS.h.
.PP
References moTS< M >::cont, moTS< M >::full_eval, and moTS< M >::move_expl.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

125
trunk/paradiseo-mo/doc/man/man3/moTSMoveLoopExpl.3 Normal file
View file

@ -0,0 +1,125 @@
.TH "moTSMoveLoopExpl" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moTSMoveLoopExpl \- Explorer for a Tabu Search algorithm.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moTSMoveLoopExpl.h>\fP
.PP
Inherits \fBmoMoveLoopExpl< M >< M >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoTSMoveLoopExpl\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)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "void \fBoperator()\fP (const \fBEOT\fP &__old_sol, \fBEOT\fP &__new_sol)"
.br
.RI "\fIProcedure which lauches the exploration. \fP"
.in -1c
.SS "Private Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.ti -1c
.RI "typedef M::EOType::Fitness \fBFitness\fP"
.br
.RI "\fIAlias for the fitness. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBmoMoveInit\fP< M > & \fBmove_init\fP"
.br
.RI "\fIMove initialisation. \fP"
.ti -1c
.RI "\fBmoNextMove\fP< M > & \fBnext_move\fP"
.br
.RI "\fINeighborhood explorer. \fP"
.ti -1c
.RI "\fBmoMoveIncrEval\fP< M > & \fBincr_eval\fP"
.br
.RI "\fIEfficient evaluation. \fP"
.ti -1c
.RI "\fBmoBestImprSelect\fP< M > \fBmove_select\fP"
.br
.RI "\fIMove selector. \fP"
.ti -1c
.RI "\fBmoTabuList\fP< M > & \fBtabu_list\fP"
.br
.RI "\fITabu list. \fP"
.ti -1c
.RI "\fBmoAspirCrit\fP< M > & \fBaspir_crit\fP"
.br
.RI "\fIAspiration criterion. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moTSMoveLoopExpl< M >"
Explorer for a Tabu Search algorithm.
It is used by a \fBmoTS\fP.
.PP
Definition at line 55 of file moTSMoveLoopExpl.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoTSMoveLoopExpl\fP< M >::\fBmoTSMoveLoopExpl\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)\fC [inline]\fP"
.PP
Constructor.
.PP
\fBParameters:\fP
.RS 4
\fI__move_init\fP move initialisation
.br
\fI__next_move\fP neighborhood explorer
.br
\fI__incr_eval\fP efficient evaluation
.br
\fI__tabu_list\fP tabu list
.br
\fI__aspir_crit\fP aspiration criterion
.RE
.PP
.PP
Definition at line 74 of file moTSMoveLoopExpl.h.
.PP
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"
.PP
Procedure which lauches the exploration.
.PP
The exploration continues while the chosen move is not in the tabu list or the aspiration criterion is true. If these 2 conditions are not true, the exploration stops if the move selector update function returns false.
.PP
\fBParameters:\fP
.RS 4
\fI__old_sol\fP the initial solution
.br
\fI__new_sol\fP the new solution
.RE
.PP
.PP
Implements \fBeoBF< const M::EOType &, M::EOType &, void >\fP.
.PP
Definition at line 94 of file moTSMoveLoopExpl.h.
.PP
References moTSMoveLoopExpl< M >::aspir_crit, moTSMoveLoopExpl< M >::incr_eval, moTSMoveLoopExpl< M >::move_init, moTSMoveLoopExpl< M >::move_select, moTSMoveLoopExpl< M >::next_move, and moTSMoveLoopExpl< M >::tabu_list.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.

85
trunk/paradiseo-mo/doc/man/man3/moTabuList.3 Normal file
View file

@ -0,0 +1,85 @@
.TH "moTabuList" 3 "23 Oct 2007" "Version 1.0" "ParadisEO-MOMovingObjects" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moTabuList \- Class describing a tabu list that a \fBmoTS\fP uses.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moTabuList.h>\fP
.PP
Inherits \fBeoBF< const M &, const M::EOType &, bool >\fP.
.PP
Inherited by \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef M::EOType \fBEOT\fP"
.br
.RI "\fIAlias for the type. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBadd\fP (const M &__move, const \fBEOT\fP &__sol)=0"
.br
.RI "\fIProcedure to add a move in the tabu list. \fP"
.ti -1c
.RI "virtual void \fBupdate\fP ()=0"
.br
.RI "\fIProcedure that updates the tabu list content. \fP"
.ti -1c
.RI "virtual void \fBinit\fP ()=0"
.br
.RI "\fIProcedure which initialises the tabu list. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class M> class moTabuList< M >"
Class describing a tabu list that a \fBmoTS\fP uses.
It is only a description, does nothing... A new object that herits from this class has to be defined in order to be used in a \fBmoTS\fP.
.PP
Definition at line 47 of file moTabuList.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> virtual void \fBmoTabuList\fP< M >::add (const M & __move, const \fBEOT\fP & __sol)\fC [pure virtual]\fP"
.PP
Procedure to add a move in the tabu list.
.PP
The two parameters have not to be modified so they are constant parameters.
.PP
\fBParameters:\fP
.RS 4
\fI__move\fP a new tabu move.
.br
\fI__sol\fP the origianl solution associated to this move.
.RE
.PP
.PP
Implemented in \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.SS "template<class M> virtual void \fBmoTabuList\fP< M >::update ()\fC [pure virtual]\fP"
.PP
Procedure that updates the tabu list content.
.PP
Generally, a counter associated to each saved move is decreased by one.
.PP
Implemented in \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.SS "template<class M> virtual void \fBmoTabuList\fP< M >::init ()\fC [pure virtual]\fP"
.PP
Procedure which initialises the tabu list.
.PP
Can be useful if the data structure needs to be allocated before being used.
.PP
Implemented in \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOMovingObjects from the source code.