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

Doc revised

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

6
trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h
View file

@ -51,14 +51,14 @@ public :
using moStat< EOT, double >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moAverageFitnessNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):
moStat<EOT, double >(0.0, "average"), nhStat(_nhStat) {}
/**
* Set the average and the standard deviation of fitness in the neighborhood
* Set the average of fitness in the neighborhood
* @param _sol the first solution
*/
virtual void init(EOT & _sol) {
@ -66,7 +66,7 @@ public :
}
/**
* Set the average and the standard deviation of fitness in the neighborhood
* Set the average of fitness in the neighborhood
* @param _sol the corresponding solution
*/
virtual void operator()(EOT & _sol) {

2
trunk/paradiseo-mo/src/continuator/moCheckpoint.h
View file

@ -51,7 +51,7 @@ public :
typedef typename Neighbor::EOT EOT ;
/**
* Default constructor (moCheckpoint must have at least one continuator)
* Constructor (moCheckpoint must have at least one continuator)
* @param _cont a continuator
* @param _interval frequency to compute statistical operators
*/

6
trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h
View file

@ -35,8 +35,8 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <vector>
/**
* Combined several continuators
* Continue until one of the continuators is false
* Combined several continuators.
* Continue until one of the continuators returns false
*/
template< class Neighbor >
class moCombinedContinuator : public moContinuator<Neighbor>
@ -45,7 +45,7 @@ public:
typedef typename Neighbor::EOT EOT ;
/**
* Default constructor (moCheckpoint must have at least one continuator)
* Constructor (moCheckpoint must have at least one continuator)
* @param _cont a continuator
*/
moCombinedContinuator(moContinuator<Neighbor>& _cont) {

2
trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h
View file

@ -45,7 +45,7 @@ class moCounterMonitorSaver : public eoUpdater {
public :
/**
* Default Constructor
* Constructor
* @param _interval frequency to call monitors
* @param _mon a monitor
*/

4
trunk/paradiseo-mo/src/continuator/moCounterStat.h
View file

@ -53,7 +53,7 @@ public :
}
/**
* Give the number of iteration
* Init the number of iteration
* @param _sol a solution
*/
virtual void init(EOT & _sol) {
@ -61,7 +61,7 @@ public :
}
/**
* Give the number of iteration
* Set the number of iteration
* @param _sol a solution
*/
virtual void operator()(EOT & _sol) {

2
trunk/paradiseo-mo/src/continuator/moDistanceStat.h
View file

@ -50,7 +50,7 @@ public :
using moStat< EOT, T >::value;
/**
* Default Constructor
* Constructor
* @param _dist a distance
* @param _ref the reference solution
*/

2
trunk/paradiseo-mo/src/continuator/moFitnessStat.h
View file

@ -48,7 +48,7 @@ public :
using moStat< EOT, Fitness >::value;
/**
* Default Constructor
* Constructor
* @param _description a description of the stat
*/
moFitnessStat(std::string _description = "fitness"):

2
trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h
View file

@ -47,7 +47,7 @@ public:
typedef typename Neighbor::EOT EOT ;
/**
* Default constructor
* Constructor
* @param _eval evaluation function to count
* @param _maxFullEval number maximum of iterations
*/

2
trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h
View file

@ -52,7 +52,7 @@ public :
using moStat< EOT, Fitness >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moMaxNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

2
trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h
View file

@ -52,7 +52,7 @@ public :
using moStat< EOT, Fitness >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moMinNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

4
trunk/paradiseo-mo/src/continuator/moMinusOneCounterStat.h
View file

@ -55,7 +55,7 @@ public :
}
/**
* Give the number of iteration
* Init the number of iteration
* @param _sol a solution
*/
virtual void init(EOT & _sol) {
@ -64,7 +64,7 @@ public :
}
/**
* Give the number of iteration
* Set the number of iteration
* @param _sol a solution
*/
virtual void operator()(EOT & _sol) {

2
trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h
View file

@ -53,7 +53,7 @@ public :
using moStat< EOT, unsigned >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moNbInfNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

2
trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h
View file

@ -53,7 +53,7 @@ public :
using moStat< EOT, unsigned >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moNbSupNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

6
trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h
View file

@ -56,7 +56,7 @@ public :
using moStat< EOT, Fitness >::value;
/**
* Default Constructor
* Constructor
* @param _neighborhood a neighborhood
* @param _eval an evaluation function
* @param _neighborComparator a neighbor Comparator
@ -155,9 +155,9 @@ private:
moSolNeighborComparator<Neighbor>& solNeighborComparator;
// default comparators
// compare the fitness values of neighbors: true is strictly greater
// compare the fitness values of neighbors
moNeighborComparator<Neighbor> defaultNeighborComp;
// compare the fitness values of the solution and the neighbor: true if strictly greater
// compare the fitness values of the solution and the neighbor
moSolNeighborComparator<Neighbor> defaultSolNeighborComp;
// number of neighbor to explore

2
trunk/paradiseo-mo/src/continuator/moNeighborEvalContinuator.h
View file

@ -47,7 +47,7 @@ public:
typedef typename Neighbor::EOT EOT ;
/**
* Default constructor
* Constructor
* @param _eval neighbor evaluation function to count
* @param _maxNeighborEval number maximum of iterations
*/

6
trunk/paradiseo-mo/src/continuator/moNeighborFitnessStat.h
View file

@ -53,7 +53,7 @@ public :
using moStat< EOT, Fitness >::value;
/**
* Default Constructor
* Constructor
* @param _neighborhood a neighborhood
* @param _eval an evaluation function
*/
@ -82,7 +82,7 @@ public :
if (neighborhood.hasNeighbor(_solution)) {
Neighbor current ;
//init the first neighbor which is suppoed to be random
//init the first neighbor which is supposed to be random
neighborhood.init(_solution, current);
//eval the _solution moved with the neighbor and stock the result in the neighbor
@ -104,7 +104,7 @@ public :
}
private:
// to explore the neighborhood
// the neighborhood
Neighborhood& neighborhood ;
moEval<Neighbor>& eval;

8
trunk/paradiseo-mo/src/continuator/moNeighborhoodStat.h
View file

@ -57,7 +57,7 @@ public :
using moStat< EOT, bool >::value;
/**
* Default Constructor
* Constructor
* @param _neighborhood a neighborhood
* @param _eval an evaluation function
* @param _neighborComparator a neighbor Comparator
@ -235,7 +235,7 @@ public :
private:
// to explore the neighborhood
//the neighborhood
Neighborhood& neighborhood ;
moEval<Neighbor>& eval;
@ -244,9 +244,9 @@ private:
moSolNeighborComparator<Neighbor>& solNeighborComparator;
// default comparators
// compare the fitness values of neighbors: true is strictly greater
// compare the fitness values of neighbors
moNeighborComparator<Neighbor> defaultNeighborComp;
// compare the fitness values of the solution and the neighbor: true if strictly greater
// compare the fitness values of the solution and the neighbor
moSolNeighborComparator<Neighbor> defaultSolNeighborComp;
// the stastics of the fitness

2
trunk/paradiseo-mo/src/continuator/moNeutralDegreeNeighborStat.h
View file

@ -53,7 +53,7 @@ public :
using moStat< EOT, unsigned >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moNeutralDegreeNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

2
trunk/paradiseo-mo/src/continuator/moSecondMomentNeighborStat.h
View file

@ -51,7 +51,7 @@ public :
using moStat< EOT, std::pair<double, double> >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moSecondMomentNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

2
trunk/paradiseo-mo/src/continuator/moSizeNeighborStat.h
View file

@ -52,7 +52,7 @@ public :
using moStat< EOT, unsigned >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moSizeNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

6
trunk/paradiseo-mo/src/continuator/moSolutionStat.h
View file

@ -38,8 +38,8 @@
#include <continuator/moStat.h>
/**
* The statistic which only give the current solution
* be careful, the solution is given by copy
* The statistic which only give the current solution.
* Be careful, the solution is given by copy
*
*/
template <class EOT>
@ -49,7 +49,7 @@ public :
using moStat< EOT, EOT >::value;
/**
* Default Constructor
* Constructor
* @param _description a description of the parameter
*/
moSolutionStat(std::string _description = "solution"):

2
trunk/paradiseo-mo/src/continuator/moStat.h
View file

@ -48,7 +48,7 @@ class moStat : public eoValueParam<T>, public moStatBase<EOT>
public:
/**
* Default Constructor
* Constructor
* @param _value a default parameter's value
* @param _description a description of the parameter
*/

2
trunk/paradiseo-mo/src/continuator/moStatFromStat.h
View file

@ -47,7 +47,7 @@ public :
using moStat< EOT , T >::value;
/**
* Default Constructor
* Constructor
* @param _stat a stat
*/
moStatFromStat(moStat<EOT,T> & _stat): moStat<EOT, T>(0, _stat.description()), stat(_stat) {

2
trunk/paradiseo-mo/src/continuator/moStdFitnessNeighborStat.h
View file

@ -51,7 +51,7 @@ public :
using moStat< EOT, double >::value;
/**
* Default Constructor
* Constructor
* @param _nhStat a neighborhoodStat
*/
moStdFitnessNeighborStat(moNeighborhoodStat<Neighbor> & _nhStat):

4
trunk/paradiseo-mo/src/continuator/moTimeContinuator.h
View file

@ -43,8 +43,8 @@ public:
typedef typename Neighbor::EOT EOT;
/**
* Ctor.
* @param _max maximum running time$
* Constructor
* @param _max maximum running time
* @param _verbose verbose mode true/false -> on/off
*/
moTimeContinuator(time_t _max, bool _verbose=true): max(_max), verbose(_verbose) {

2
trunk/paradiseo-mo/src/continuator/moVectorMonitor.h
View file

@ -50,7 +50,7 @@ class moVectorMonitor : public eoMonitor
public:
/**
* Default Constructor
* Constructor
* @param _param the parameter of type double to save in the vector
*/
moVectorMonitor(eoValueParam<double> & _param) : doubleParam(&_param), intParam(NULL), eotParam(NULL)