Updated doc links

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@593 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2007-09-18 15:44:04 +00:00
commit 520b5a08e4
224 changed files with 3673 additions and 2476 deletions

View file

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

View file

@ -1,4 +1,4 @@
.TH "moAlgo" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAlgo" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ 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

View file

@ -1,4 +1,4 @@
.TH "moAspirCrit" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAspirCrit" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moAspirCrit \- Description of the conditions in which a tabu move could be accep
.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"

View file

@ -1,4 +1,4 @@
.TH "moBestImprSelect" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moBestImprSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -67,7 +67,7 @@ Definition at line 22 of file moBestImprSelect.h.
.PP
Function that indicates if the current move has not improved the fitness.
.PP
If the given fitness enables an improvement, the move (\fBmoMove\fP) and the fitness linked to this move are saved.
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
@ -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]\fP"
.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
@ -106,7 +106,9 @@ Procedure which saved the best move and fitness.
.PP
.PP
Definition at line 65 of file moBestImprSelect.h.
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 68 of file moBestImprSelect.h.
.PP
References moBestImprSelect< M >::best_fit, moBestImprSelect< M >::best_move, and moBestImprSelect< M >::first_time.

View file

@ -1,4 +1,4 @@
.TH "moCoolingSchedule" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ 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"

View file

@ -1,4 +1,4 @@
.TH "moExponentialCoolingSchedule" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moExponentialCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -18,7 +18,7 @@ Inherits \fBmoCoolingSchedule\fP.
.ti -1c
.RI "\fBmoExponentialCoolingSchedule\fP (double __threshold, double __ratio)"
.br
.RI "\fIBasic constructor. \fP"
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (double &__temp)"
.br
@ -47,7 +47,7 @@ Definition at line 22 of file moExponentialCoolingSchedule.h.
.PP
.SS "moExponentialCoolingSchedule::moExponentialCoolingSchedule (double __threshold, double __ratio)\fC [inline]\fP"
.PP
Basic constructor.
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
@ -61,7 +61,7 @@ Basic constructor.
Definition at line 31 of file moExponentialCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline]\fP"
.SS "bool moExponentialCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
Function which proceeds to the cooling.
.PP
@ -78,6 +78,8 @@ 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

View file

@ -1,4 +1,4 @@
.TH "moFirstImprSelect" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moFirstImprSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -62,7 +62,7 @@ Inherits \fBmoMoveSelect< M >< M >\fP.
.SS "template<class M> class moFirstImprSelect< M >"
One possible \fBmoMoveSelect\fP.
The neighborhood is explored until a move enables an improvement of the current solution.
The neighborhood is explored until a move enables an improvment of the current solution.
.PP
Definition at line 23 of file moFirstImprSelect.h.
.SH "Member Function Documentation"
@ -82,7 +82,7 @@ References moFirstImprSelect< M >::init_fit, and moFirstImprSelect< M >::valid.
.PP
Function that indicates if the current move has not improved the fitness.
.PP
If the given fitness enables an improvement, the move (\fBmoMove\fP) should be applied to the current solution.
If the given fitness enables an improvment, the move (\fBmoMove\fP) should be applied to the current solution.
.PP
\fBParameters:\fP
.RS 4
@ -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]\fP"
.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
@ -118,6 +118,8 @@ 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

View file

@ -1,8 +1,8 @@
.TH "moGenSolContinue" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moGenSolContinue" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moGenSolContinue \- One possible stopping criterion for a solution-based heuristic.
moGenSolContinue \- One possible stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
@ -18,7 +18,7 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.ti -1c
.RI "\fBmoGenSolContinue\fP (unsigned int __maxNumGen)"
.br
.RI "\fIBasic constructor. \fP"
.RI "\fISimple constructor. \fP"
.ti -1c
.RI "bool \fBoperator()\fP (const EOT &__sol)"
.br
@ -26,7 +26,7 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.ti -1c
.RI "void \fBinit\fP ()"
.br
.RI "\fIProcedure which allows to initialise all the stuff needed. \fP"
.RI "\fIProcedure which allows to initialise the generation counter. \fP"
.in -1c
.SS "Private Attributes"
@ -44,16 +44,16 @@ Inherits \fBmoSolContinue< EOT >< EOT >\fP.
.PP
.SS "template<class EOT> class moGenSolContinue< EOT >"
One possible stopping criterion for a solution-based heuristic.
One possible stop criterion for a solution-based heuristic.
The stopping criterion corresponds to a maximum number of iteration.
The stop criterion corresponds to a maximum number of iteration.
.PP
Definition at line 21 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
Basic constructor.
Simple constructor.
.PP
\fBParameters:\fP
.RS 4
@ -65,11 +65,11 @@ Basic 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]\fP"
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline, virtual]\fP"
.PP
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.
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
@ -78,23 +78,25 @@ Increments the counter and returns true if the current number of iteration is lo
.PP
\fBReturns:\fP
.RS 4
true or false according to the current generation number.
TRUE or FALSE according to the current generation number.
.RE
.PP
.PP
Definition at line 42 of file moGenSolContinue.h.
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 ()\fC [inline, virtual]\fP"
.PP
Procedure which allows to initialise all the stuff needed.
Procedure which allows to initialise the generation counter.
.PP
It can be also used to reinitialize the counter all the needed things.
It can also be used to reset the iteration counter.
.PP
Implements \fBmoSolContinue< EOT >\fP.
.PP
Definition at line 51 of file moGenSolContinue.h.
Definition at line 54 of file moGenSolContinue.h.
.PP
References moGenSolContinue< EOT >::numGen.

View file

@ -1,4 +1,4 @@
.TH "moHC" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHC" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -16,11 +16,11 @@ 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, eoEvalFunc< \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, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fIFull constructor. \fP"
.ti -1c
.RI "\fBmoHC\fP (\fBmoMoveExpl\fP< M > &__move_expl, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.RI "\fBmoHC\fP (\fBmoMoveExpl\fP< M > &__move_expl, \fBeoEvalFunc\fP< \fBEOT\fP > &__full_eval)"
.br
.RI "\fILight constructor. \fP"
.ti -1c
@ -48,7 +48,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.br
.RI "\fIComplete exploration of the neighborhood. \fP"
.ti -1c
.RI "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.RI "\fBeoEvalFunc\fP< \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, eoEvalFunc< \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, \fBeoEvalFunc\fP< \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, eoEvalFunc< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.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
@ -103,7 +103,7 @@ 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]\fP"
.SS "template<class M> bool \fBmoHC\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Function which launches the HC.
.PP
@ -120,6 +120,8 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 82 of file moHC.h.
.PP

View file

@ -1,4 +1,4 @@
.TH "moHCMoveLoopExpl" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHCMoveLoopExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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]\fP"
.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
@ -101,6 +101,8 @@ 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

View file

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

View file

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

View file

@ -1,4 +1,4 @@
.TH "moLSCheckPoint" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLSCheckPoint" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moLSCheckPoint \- Class which allows a checkpointing system.
.PP
\fC#include <moLSCheckPoint.h>\fP
.PP
Inherits \fBeoBF< const M &, const M::EOType &, void >\fP.
.PP
.SS "Public Member Functions"
.in +1c
@ -18,7 +20,7 @@ moLSCheckPoint \- Class which allows a checkpointing system.
.br
.RI "\fIFunction which launches the checkpointing. \fP"
.ti -1c
.RI "void \fBadd\fP (eoBF< const M &, const typename M::EOType &, void > &__f)"
.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
@ -26,7 +28,7 @@ moLSCheckPoint \- Class which allows a checkpointing system.
.in +1c
.ti -1c
.RI "std::vector< eoBF< const M &, const typename M::EOType &, void > * > \fBfunc\fP"
.RI "std::vector< \fBeoBF\fP< const M &, const typename M::EOType &, void > * > \fBfunc\fP"
.br
.RI "\fIvector of function \fP"
.in -1c
@ -59,7 +61,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 (eoBF< const M &, const typename M::EOType &, void > & __f)\fC [inline]\fP"
.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

View file

@ -1,4 +1,4 @@
.TH "moLinearCoolingSchedule" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLinearCoolingSchedule" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -61,7 +61,7 @@ Simple constructor.
Definition at line 31 of file moLinearCoolingSchedule.h.
.SH "Member Function Documentation"
.PP
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline]\fP"
.SS "bool moLinearCoolingSchedule::operator() (double & __temp)\fC [inline, virtual]\fP"
.PP
Function which proceeds to the cooling.
.PP
@ -78,6 +78,8 @@ 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

View file

@ -1,4 +1,4 @@
.TH "moMove" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMove" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moMove \- Definition of a move.
.PP
\fC#include <moMove.h>\fP
.PP
Inherits \fBeoUF< EOT &, void >\fP.
.PP
.SS "Public Types"
.in +1c

View file

@ -1,4 +1,4 @@
.TH "moMoveExpl" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ 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"

View file

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

View file

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

View file

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

View file

@ -1,4 +1,4 @@
.TH "moMoveSelect" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ 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"

View file

@ -1,4 +1,4 @@
.TH "moNextMove" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moNextMove" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moNextMove \- Class which allows to generate a new move (\fBmoMove\fP).
.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"

View file

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

View file

@ -1,4 +1,4 @@
.TH "moRandImprSelect" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moRandImprSelect" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -58,7 +58,7 @@ Inherits \fBmoMoveSelect< M >< M >\fP.
.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 improvement of the objective function is choosen.
All the neighbors are considered. One of them that enables an improvment of the objective function is choosen.
.PP
Definition at line 25 of file moRandImprSelect.h.
.SH "Member Function Documentation"
@ -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]\fP"
.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
@ -125,10 +125,12 @@ 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 moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
References eoRng::random(), moRandImprSelect< M >::vect_better_fit, and moRandImprSelect< M >::vect_better_moves.
.SH "Author"
.PP

View file

@ -1,4 +1,4 @@
.TH "moRandMove" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moRandMove" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moRandMove \- Random move generator.
.PP
\fC#include <moRandMove.h>\fP
.PP
Inherits \fBeoUF< M &, void >\fP.
.PP
.SH "Detailed Description"
.PP

View file

@ -1,4 +1,4 @@
.TH "moSA" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSA" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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, eoEvalFunc< \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, \fBeoEvalFunc\fP< \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 "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.RI "\fBeoEvalFunc\fP< \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 30 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, eoEvalFunc< \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, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
SA constructor.
.PP
@ -98,10 +98,10 @@ All the boxes used by a SA need to be given.
.PP
.PP
Definition at line 52 of file moSA.h.
Definition at line 58 of file moSA.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoSA\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\fP"
.SS "template<class M> bool \fBmoSA\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
function that launches the SA algorithm.
.PP
@ -119,9 +119,11 @@ TRUE.
.PP
.PP
Definition at line 74 of file moSA.h.
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
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.
Definition at line 80 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

View file

@ -1,4 +1,4 @@
.TH "moSimpleMoveTabuList" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSimpleMoveTabuList" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -77,7 +77,7 @@ Class describing a move tabu list with a limited memory.
Definition at line 22 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]\fP"
.SS "template<class M> bool \fBmoSimpleMoveTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Function that indicates if, in a given state, the _move is tabu or not.
.PP
@ -94,6 +94,8 @@ true or false.
.RE
.PP
.PP
Implements \fBeoBF< const M &, const M::EOType &, bool >\fP.
.PP
Definition at line 46 of file moSimpleMoveTabuList.h.
.PP

View file

@ -1,4 +1,4 @@
.TH "moSimpleSolutionTabuList" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSimpleSolutionTabuList" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -93,7 +93,7 @@ Definition at line 34 of file moSimpleSolutionTabuList.h.
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]\fP"
.SS "template<class M> bool \fBmoSimpleSolutionTabuList\fP< M >::operator() (const M & __move, const \fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Function that indicates if, in a given state, the _move is tabu or not.
.PP
@ -110,6 +110,8 @@ true or false.
.RE
.PP
.PP
Implements \fBeoBF< const M &, const M::EOType &, bool >\fP.
.PP
Definition at line 45 of file moSimpleSolutionTabuList.h.
.PP

View file

@ -1,8 +1,8 @@
.TH "moSolContinue" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSolContinue" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moSolContinue \- Class that describes a stopping criterion for a solution-based heuristic.
moSolContinue \- Class that describes a stop criterion for a solution-based heuristic.
.PP
.SH SYNOPSIS
@ -10,7 +10,9 @@ moSolContinue \- Class that describes a stopping criterion for a solution-based
.PP
\fC#include <moSolContinue.h>\fP
.PP
Inherited by \fBmoFitSolContinue< EOT >\fP, \fBmoGenSolContinue< EOT >\fP, \fBmoNoFitImprSolContinue< EOT >\fP, and \fBmoSteadyFitSolContinue< EOT >\fP.
Inherits \fBeoUF< const EOT &, bool >\fP.
.PP
Inherited by \fBmoGenSolContinue< EOT >\fP.
.PP
.SS "Public Member Functions"
@ -18,26 +20,26 @@ Inherited by \fBmoFitSolContinue< EOT >\fP, \fBmoGenSolContinue< EOT >\fP, \fBmo
.ti -1c
.RI "virtual void \fBinit\fP ()=0"
.br
.RI "\fIProcedure which initialises all that the stopping criterion needs. \fP"
.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 stopping criterion for a solution-based heuristic.
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 (eoUF).
It allows to add an initialisation procedure to an object that is a unary function (\fBeoUF\fP).
.PP
Definition at line 22 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 stopping criterion needs.
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.
Implemented in \fBmoGenSolContinue< EOT >\fP.
.SH "Author"
.PP

View file

@ -1,4 +1,4 @@
.TH "moTS" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTS" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -16,11 +16,11 @@ 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, eoEvalFunc< \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, \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, eoEvalFunc< \fBEOT\fP > &__full_eval)"
.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
@ -52,7 +52,7 @@ Inherits \fBmoAlgo< M::EOType >\fP.
.br
.RI "\fIStop criterion. \fP"
.ti -1c
.RI "eoEvalFunc< \fBEOT\fP > & \fBfull_eval\fP"
.RI "\fBeoEvalFunc\fP< \fBEOT\fP > & \fBfull_eval\fP"
.br
.RI "\fIFull evaluation function. \fP"
.in -1c
@ -67,7 +67,7 @@ Generic algorithm that describes a tabu search.
Definition at line 29 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, eoEvalFunc< \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, \fBeoEvalFunc\fP< \fBEOT\fP > & __full_eval)\fC [inline]\fP"
.PP
Constructor of a \fBmoTS\fP specifying all the boxes.
.PP
@ -93,7 +93,7 @@ In this constructor, a \fBmoTSMoveLoopExpl\fP is instanciated.
.PP
Definition at line 58 of file moTS.h.
.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"
.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
@ -113,7 +113,7 @@ The explorer is given in the parameters.
Definition at line 71 of file moTS.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\fP"
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline, virtual]\fP"
.PP
Function which launchs the Tabu Search.
.PP
@ -130,6 +130,8 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 85 of file moTS.h.
.PP

View file

@ -1,4 +1,4 @@
.TH "moTSMoveLoopExpl" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTSMoveLoopExpl" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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]\fP"
.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
@ -113,6 +113,8 @@ 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

View file

@ -1,4 +1,4 @@
.TH "moTabuList" 3 "14 Sep 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTabuList" 3 "6 Jul 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moTabuList \- Class describing a tabu list that a \fBmoTS\fP uses.
.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"