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

docs is again updated

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@288 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-04-23 07:29:08 +00:00
commit 8a7ec960b3
214 changed files with 1226 additions and 507 deletions
Download patch file Download diff file Expand all files Collapse all files

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

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

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

@ -1,4 +1,4 @@
.TH "moAlgo" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAlgo" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moAspirCrit" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moAspirCrit" 3 "23 Apr 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< A1, A2, R >< const const M &, M::EOType::Fitness &, bool >\fP.
.PP
Inherited by \fBmoImprBestFitAspirCrit< M >\fP, and \fBmoNoAspirCrit< M >\fP.
.PP
.SS "Public Member Functions"

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

@ -1,4 +1,4 @@
.TH "moBestImprSelect" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moBestImprSelect" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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
@ -105,6 +105,8 @@ Procedure which saved the best move and fitness.
.RE
.PP
.PP
Implements \fBeoBF< M &, M::EOType::Fitness &, void >\fP.
.PP
Definition at line 68 of file moBestImprSelect.h.
.PP

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

@ -1,4 +1,4 @@
.TH "moCoolingSchedule" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moCoolingSchedule" 3 "23 Apr 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"

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

@ -1,4 +1,4 @@
.TH "moExponentialCoolingSchedule" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moExponentialCoolingSchedule" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -61,7 +61,7 @@ Simple 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

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

@ -1,4 +1,4 @@
.TH "moFirstImprSelect" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moFirstImprSelect" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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

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

@ -1,4 +1,4 @@
.TH "moGenSolContinue" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moGenSolContinue" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -65,7 +65,7 @@ Simple constructor.
Definition at line 30 of file moGenSolContinue.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoGenSolContinue\fP< EOT >::operator() (const EOT & __sol)\fC [inline]\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
@ -82,6 +82,8 @@ TRUE or FALSE according to the current generation number.
.RE
.PP
.PP
Implements \fBeoUF< const EOT &, bool >\fP.
.PP
Definition at line 44 of file moGenSolContinue.h.
.PP

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

@ -1,4 +1,4 @@
.TH "moHC" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHC" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moHCMoveLoopExpl" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moHCMoveLoopExpl" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moImprBestFitAspirCrit" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moImprBestFitAspirCrit" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

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

@ -1,4 +1,4 @@
.TH "moItRandNextMove" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moItRandNextMove" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moLSCheckPoint" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLSCheckPoint" 3 "23 Apr 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< A1, A2, R >< const const M &, 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

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

@ -1,4 +1,4 @@
.TH "moLinearCoolingSchedule" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moLinearCoolingSchedule" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moMove" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMove" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moMoveExpl" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveExpl" 3 "23 Apr 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"

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

@ -1,4 +1,4 @@
.TH "moMoveIncrEval" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveIncrEval" 3 "23 Apr 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< A1, A2, R >< const const M &, M::EOType &, M::EOType::Fitness >\fP.
.PP
.SH "Detailed Description"
.PP

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

@ -1,4 +1,4 @@
.TH "moMoveInit" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveInit" 3 "23 Apr 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< A1, A2, R >< const M &, M::EOType &, void >\fP.
.PP
.SH "Detailed Description"
.PP

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

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

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

@ -1,4 +1,4 @@
.TH "moMoveSelect" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moMoveSelect" 3 "23 Apr 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"

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

@ -1,4 +1,4 @@
.TH "moNextMove" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moNextMove" 3 "23 Apr 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< A1, A2, R >< const M &, M::EOType &, bool >\fP.
.PP
Inherited by \fBmoItRandNextMove< M >\fP.
.PP
.SH "Detailed Description"

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

@ -1,4 +1,4 @@
.TH "moNoAspirCrit" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moNoAspirCrit" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

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

@ -1,4 +1,4 @@
.TH "moRandImprSelect" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moRandImprSelect" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -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

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

@ -1,4 +1,4 @@
.TH "moRandMove" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moRandMove" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moSA" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSA" 3 "23 Apr 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 32 of file moSA.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoSA\fP< M >::\fBmoSA\fP (\fBmoRandMove\fP< M > & __move_rand, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, double __init_temp, \fBmoCoolingSchedule\fP & __cool_sched, 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
@ -101,7 +101,7 @@ All the boxes used by a SA need to be given.
Definition at line 60 of file moSA.h.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoSA\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\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
@ -118,10 +118,12 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 82 of file moSA.h.
.PP
References moSA< M >::cont, moSA< M >::cool_sched, moSA< M >::full_eval, moSA< M >::incr_eval, moSA< M >::init_temp, and moSA< M >::move_rand.
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

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

@ -1,4 +1,4 @@
.TH "moSimpleMoveTabuList" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSimpleMoveTabuList" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

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

@ -1,4 +1,4 @@
.TH "moSimpleSolutionTabuList" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSimpleSolutionTabuList" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME

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

@ -1,4 +1,4 @@
.TH "moSolContinue" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moSolContinue" 3 "23 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@ -10,6 +10,8 @@ moSolContinue \- Class that describes a stop criterion for a solution-based heur
.PP
\fC#include <moSolContinue.h>\fP
.PP
Inherits \fBeoUF< const EOT &, bool >\fP.
.PP
Inherited by \fBmoGenSolContinue< EOT >\fP.
.PP
.SS "Public Member Functions"
@ -26,7 +28,7 @@ Inherited by \fBmoGenSolContinue< EOT >\fP.
.SS "template<class EOT> class moSolContinue< EOT >"
Class that describes a stop criterion for a solution-based heuristic.
It allows to add an initialisation procedure to an object that is a unary function (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"

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

@ -1,4 +1,4 @@
.TH "moTS" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTS" 3 "23 Apr 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
@ -79,7 +79,7 @@ Generic algorithm that describes a tabu search.
Definition at line 30 of file moTS.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveInit\fP< M > & __move_init, \fBmoNextMove\fP< M > & __next_move, \fBmoMoveIncrEval\fP< M > & __incr_eval, \fBmoTabuList\fP< M > & __tabu_list, \fBmoAspirCrit\fP< M > & __aspir_crit, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, 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
@ -107,7 +107,7 @@ In this constructor, a \fBmoTSMoveLoopExpl\fP is instanciated.
Definition at line 59 of file moTS.h.
.PP
References moTS< M >::first_time, and moTS< M >::mutex.
.SS "template<class M> \fBmoTS\fP< M >::\fBmoTS\fP (\fBmoMoveExpl\fP< M > & __move_expl, \fBmoSolContinue\fP< \fBEOT\fP > & __cont, 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
@ -129,7 +129,7 @@ Definition at line 81 of file moTS.h.
References moTS< M >::first_time, and moTS< M >::mutex.
.SH "Member Function Documentation"
.PP
.SS "template<class M> bool \fBmoTS\fP< M >::operator() (\fBEOT\fP & __sol)\fC [inline]\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
@ -146,6 +146,8 @@ TRUE.
.RE
.PP
.PP
Implements \fBeoUF< M::EOType &, bool >\fP.
.PP
Definition at line 104 of file moTS.h.
.PP

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

@ -1,4 +1,4 @@
.TH "moTSMoveLoopExpl" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTSMoveLoopExpl" 3 "23 Apr 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

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

@ -1,4 +1,4 @@
.TH "moTabuList" 3 "20 Apr 2007" "Version 0.1" "PARADISEO-MO" \" -*- nroff -*-
.TH "moTabuList" 3 "23 Apr 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< A1, A2, R >< const const M &, M::EOType &, bool >\fP.
.PP
Inherited by \fBmoSimpleMoveTabuList< M >\fP, and \fBmoSimpleSolutionTabuList< M >\fP.
.PP
.SS "Public Types"