Début du nettoyage et verif de la doc

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1811 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jhumeau 2010-05-12 16:06:23 +00:00
commit c4b0699f53
25 changed files with 66 additions and 61 deletions

View file

@ -34,11 +34,11 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <explorer/moDummyExplorer.h>
#include <continuator/moTrueContinuator.h>
/********************************************************
/**
* Dummy Local Search:
*
* To do nothing, only the full evaluation of the solution if necessary ;-)
********************************************************/
*/
template<class Neighbor>
class moDummyLS: public moLocalSearch<Neighbor>
{

View file

@ -36,7 +36,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* First improvement HC:
* Hill-Climber local search
*
@ -45,7 +45,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
* if the selected neighbor have higher fitness than the current solution
* then the solution is replaced by the selected neighbor
* the algorithm stops when there is no higher neighbor
********************************************************/
*/
template<class Neighbor>
class moFirstImprHC: public moLocalSearch<Neighbor>
{
@ -54,7 +54,7 @@ public:
typedef moNeighborhood<Neighbor> Neighborhood ;
/**
* Simple constructor for a hill-climber
* Basic constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function
@ -77,7 +77,7 @@ public:
{}
/**
* Simple constructor for a hill-climber
* General constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -53,7 +53,10 @@ public:
typedef typename Neighbor::EOT EOT ;
/**
* Constructor of a moLocalSearch needs a NeighborhooExplorer and a Continuator
* Constructor of a moLocalSearch
* @param _searchExpl a neighborhood explorer
* @param _cont an external continuator (can be a checkpoint!)
* @param _fullEval a full evaluation function
*/
moLocalSearch(NeighborhoodExplorer& _searchExpl, moContinuator<Neighbor> & _cont, eoEvalFunc<EOT>& _fullEval) : searchExplorer(_searchExpl), cont(&_cont), fullEval(_fullEval) { } ;
@ -99,8 +102,8 @@ public:
};
/**
* external continuator object
* @return the external continuator
* Set an external continuator
* @param _cont the external continuator
*/
void setContinuator(moContinuator<Neighbor> & _cont) {
cont = &_cont ;

View file

@ -36,7 +36,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Metropolis-Hasting local search
* Only the symetric case is considered when Q(x,y) = Q(y,x)
* Fitness must be > 0
@ -48,7 +48,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
* if a random number from [0,1] is lower than fitness(neighbor) / fitness(solution)
* then the solution is replaced by the selected neighbor
* the algorithm stops when the number of iterations is too large
********************************************************/
*/
template<class Neighbor>
class moMetropolisHasting: public moLocalSearch<Neighbor>
{
@ -57,7 +57,7 @@ public:
typedef moNeighborhood<Neighbor> Neighborhood ;
/**
* Simple constructor of the Metropolis-Hasting
* Basic constructor of the Metropolis-Hasting
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function
@ -82,7 +82,7 @@ public:
{}
/**
* Simple constructor of the Metropolis-Hasting
* General constructor of the Metropolis-Hasting
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -36,7 +36,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Hill-Climber local search
*
* At each iteration,
@ -44,7 +44,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
* if the selected neighbor have higher or equal fitness than the current solution
* then the solution is replaced by the selected neighbor
* the algorithm stops when there is no higher or equal neighbor, or if the number of iterations is too large
********************************************************/
*/
template<class Neighbor>
class moNeutralHC: public moLocalSearch<Neighbor>
{
@ -53,7 +53,7 @@ public:
typedef moNeighborhood<Neighbor> Neighborhood ;
/**
* Simple constructor for a hill-climber
* Basic constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function
@ -78,7 +78,7 @@ public:
{}
/**
* Simple constructor for a hill-climber
* General constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -36,7 +36,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Random Best HC:
* Hill-Climber local search
*
@ -45,7 +45,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
* if the selected neighbor have higher fitness than the current solution
* then the solution is replaced by the selected neighbor
* the algorithm stops when there is no higher neighbor
********************************************************/
*/
template<class Neighbor>
class moRandomBestHC: public moLocalSearch<Neighbor>
{
@ -54,7 +54,7 @@ public:
typedef moNeighborhood<Neighbor> Neighborhood ;
/**
* Simple constructor for a hill-climber
* Basic constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function
@ -77,7 +77,7 @@ public:
{}
/**
* Simple constructor for a hill-climber
* General constructor for a hill-climber
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -36,14 +36,14 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Random Neutral Walk:
* Random Neutral walk local search
*
* At each iteration,
* one random neighbor with the same fitness is selected and replace the current solution
* the algorithm stops when the number of steps is reached
********************************************************/
*/
template<class Neighbor>
class moRandomNeutralWalk: public moLocalSearch<Neighbor>
{
@ -52,7 +52,7 @@ public:
typedef moNeighborhood<Neighbor> Neighborhood ;
/**
* Simple constructor for a random walk
* Basic constructor for a random walk
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function
@ -77,7 +77,7 @@ public:
{}
/**
* Simple constructor for a random walk
* General constructor for a random walk
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -36,14 +36,14 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eoInit.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Random Search:
* Pure random search local search
*
* At each iteration,
* one random solution is selected and replace the current solution
* the algorithm stops when the number of solution is reached
********************************************************/
*/
template<class Neighbor>
class moRandomSearch: public moLocalSearch<Neighbor>
{
@ -62,10 +62,11 @@ public:
{}
/**
* Simple constructor for a random search
* General constructor for a random search
* @param _init the solution initializer, to explore at random the search space
* @param _fullEval the full evaluation function
* @param _nbSolMax number of solutions
* @param _cont external continuator
*/
moRandomSearch(eoInit<EOT> & _init, eoEvalFunc<EOT>& _fullEval, unsigned _nbSolMax, moContinuator<Neighbor>& _cont):
moLocalSearch<Neighbor>(explorer, _cont, _fullEval),

View file

@ -36,14 +36,14 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Random Walk:
* Random walk local search
*
* At each iteration,
* one random neighbor is selected and replace the current solution
* the algorithm stops when the number of steps is reached
********************************************************/
*/
template<class Neighbor>
class moRandomWalk: public moLocalSearch<Neighbor>
{
@ -64,7 +64,7 @@ public:
{}
/**
* Simple constructor for a random walk
* General constructor for a random walk
* @param _neighborhood the neighborhood
* @param _fullEval the full evaluation function
* @param _eval neighbor's evaluation function

View file

@ -38,6 +38,9 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/**
* Simulated Annealing
*/
template<class Neighbor>
class moSA: public moLocalSearch<Neighbor>
{

View file

@ -36,7 +36,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/********************************************************
/**
* Simple HC:
* Hill-Climber local search
*
@ -45,7 +45,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
* if the selected neighbor have higher fitness than the current solution
* then the solution is replaced by the selected neighbor
* the algorithm stops when there is no higher neighbor
********************************************************/
*/
template<class Neighbor>
class moSimpleHC: public moLocalSearch<Neighbor>
{

View file

@ -43,6 +43,9 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <eval/moEval.h>
#include <eoEvalFunc.h>
/**
* Tabu Search
*/
template<class Neighbor>
class moTS: public moLocalSearch<Neighbor>
{