Doc revised

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1819 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jhumeau 2010-05-21 12:37:41 +00:00
commit 93533e5fad
88 changed files with 188 additions and 190 deletions

View file

@ -58,7 +58,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood giving neighbor in random order
* @param _fullEval Fitness function, full evaluation function
@ -73,7 +73,7 @@ public:
moSampling<Neighbor>(_init, * new moRandomWalk<Neighbor>(_neighborhood, _fullEval, _eval, _nbStep), fitnessStat) {}
/**
* default destructor
* Destructor
*/
~moAutocorrelationSampling() {
// delete the pointer on the local search which has been constructed in the constructor

View file

@ -56,7 +56,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _fullEval Fitness function, full evaluation function
* @param _nbSol Number of solutions in the sample

View file

@ -60,7 +60,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _fullEval a full evaluation function
* @param _dist the distance function between solution
@ -79,7 +79,7 @@ public:
}
/**
* default destructor
* Destructor
*/
~moFDCsampling() {
// delete the pointer on the local search which has been constructed in the constructor

View file

@ -60,7 +60,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to get a neighbor
* @param _fullEval Fitness function, full evaluation function

View file

@ -63,7 +63,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood giving neighbor in random order
* @param _fullEval a full evaluation function
@ -89,7 +89,7 @@ public:
}
/**
* default destructor
* Destructor
*/
~moHillClimberSampling() {
// delete the pointer on the local search which has been constructed in the constructor

View file

@ -68,7 +68,7 @@ public:
using moFitnessCloudSampling<Neighbor>::fitnessStat;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to get one random neighbor (supposed to be random neighborhood)
* @param _fullEval Fitness function, full evaluation function

View file

@ -68,7 +68,7 @@ public:
using moFitnessCloudSampling<Neighbor>::fitnessStat;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to get one random neighbor (supposed to be random neighborhood)
* @param _fullEval Fitness function, full evaluation function

View file

@ -61,7 +61,7 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to compute the neutral degree
* @param _fullEval Fitness function, full evaluation function

View file

@ -81,12 +81,12 @@ public:
using moSampling<Neighbor>::localSearch;
/**
* Default Constructor
* @param _initSol the first the solution of the walk
* Constructor
* @param _initSol the first solution of the walk
* @param _neighborhood neighborhood giving neighbor in random order
* @param _fullEval Fitness function, full evaluation function
* @param _eval neighbor evaluation, incremental evaluation function
* @param _distance the distance to measure the distance from the initial solution
* @param _distance component to measure the distance from the initial solution
* @param _nbStep Number of steps of the random walk
*/
moNeutralWalkSampling(EOT & _initSol,

View file

@ -66,7 +66,7 @@ public:
using moFitnessCloudSampling<Neighbor>::fitnessStat;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to get one random neighbor (supposed to be random neighborhood)
* @param _fullEval Fitness function, full evaluation function

View file

@ -66,7 +66,7 @@ public:
using moFitnessCloudSampling<Neighbor>::fitnessStat;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _neighborhood neighborhood to get one random neighbor (supposed to be random neighborhood)
* @param _fullEval Fitness function, full evaluation function

View file

@ -61,7 +61,7 @@ public:
typedef typename Neighbor::EOT EOT ;
/**
* Default Constructor
* Constructor
* @param _init initialisation method of the solution
* @param _localSearch local search to sample the search space
* @param _stat statistic to compute during the search
@ -103,8 +103,7 @@ public:
}
/**
* To sample the search and get the statistics
* the statistics are stored in the moVectorMonitor vector
* To sample the search and get the statistics which are stored in the moVectorMonitor vector
*/
void operator()(void) {
// clear all statistic vectors
@ -172,7 +171,7 @@ public:
/**
* to get one vector of values
* @param _numStat number of stattistics to get (in order of creation)
* @param _numStat number of statistics to get (in the order of creation)
* @return the vector of value (all values are converted in double)
*/
const std::vector<double> & getValues(unsigned int _numStat) {
@ -181,7 +180,7 @@ public:
/**
* to get one vector of solutions values
* @param _numStat number of stattistics to get (in order of creation)
* @param _numStat number of statistics to get (in the order of creation)
* @return the vector of value (all values are converted in double)
*/
const std::vector<EOT> & getSolutions(unsigned int _numStat) {
@ -202,7 +201,6 @@ protected:
moContinuator<Neighbor> * continuator;
moCheckpoint<Neighbor> * checkpoint;
// std::vector<moStatBase<EOT>*> statVec;
std::vector< moVectorMonitor<EOT> *> monitorVec;
};

View file

@ -150,7 +150,7 @@ public:
rho.resize(nbS+1);
phi.resize(nbS+1);
rho[0] = 1.0;
phi[0] = 1.0; // ?
phi[0] = 1.0;
unsigned s, k;