Doc revised

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1819 331e1502-861f-0410-8da2-ba01fb791d7f

trunk/paradiseo-mo/src/algo/moDummyLS.h

@@ -64,7 +64,7 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // the explorer of the simple HC
+    // dummy Explorer
     moDummyExplorer<Neighbor> explorer;
 };
 

trunk/paradiseo-mo/src/algo/moFirstImprHC.h

@@ -38,7 +38,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 /**
  * First improvement HC:
- * Hill-Climber local search
+ * Hill-Climbing local search
  *
  * At each iteration,
  *   one of the random solution in the neighborhood is selected
@@ -93,7 +93,7 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // compare the fitness values of neighbors: true is strictly greater
+    // compare the fitness values of neighbors: true if strictly greater
     moNeighborComparator<Neighbor> defaultNeighborComp;
     // compare the fitness values of the solution and the neighbor: true if strictly greater
     moSolNeighborComparator<Neighbor> defaultSolNeighborComp;

trunk/paradiseo-mo/src/algo/moMetropolisHasting.h

@@ -99,11 +99,11 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // 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 explorer of the HC with neutral move (equals fitness move)
+    // MetropolisHasting explorer
     moMetropolisHastingExplorer<Neighbor> explorer;
 };
 

trunk/paradiseo-mo/src/algo/moNeutralHC.h

@@ -37,7 +37,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 #include <eoEvalFunc.h>
 
 /**
- * Hill-Climber local search
+ * Hill-Climbing local search
  *
  * At each iteration,
  *   one of the random best solution in the neighborhood is selected
@@ -95,9 +95,9 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // 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 explorer of the HC with neutral move (equals fitness move)
     moNeutralHCexplorer<Neighbor> explorer;

trunk/paradiseo-mo/src/algo/moRandomBestHC.h

@@ -38,7 +38,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 /**
  * Random Best HC:
- * Hill-Climber local search
+ * Hill-Climbing local search
  *
  * At each iteration,
  *   one of the random best solution in the neighborhood is selected
@@ -93,9 +93,9 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // 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 explorer of the HC with random choice of the best solution
     moRandomBestHCexplorer<Neighbor> explorer;

trunk/paradiseo-mo/src/algo/moRandomNeutralWalk.h

@@ -95,7 +95,7 @@ private:
     moTrueContinuator<Neighbor> trueCont;
     // the explorer of the random walk
     moRandomNeutralWalkExplorer<Neighbor> explorer;
-    // 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;
 };
 

trunk/paradiseo-mo/src/algo/moSimpleHC.h

@@ -38,7 +38,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 /**
  * Simple HC:
- * Hill-Climber local search
+ * Hill-Climbing local search
  *
  * At each iteration,
  *   the first best solution in the neighborhood is selected
@@ -93,9 +93,9 @@ public:
 private:
     // always true continuator
     moTrueContinuator<Neighbor> trueCont;
-    // 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 explorer of the simple HC
     moSimpleHCexplorer<Neighbor> explorer;

trunk/paradiseo-mo/src/comparator/moNeighborComparator.h

@@ -67,7 +67,7 @@ public:
     }
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/comparator/moSolComparator.h

@@ -51,7 +51,7 @@ public:
     }
 
     /**
-     * Compare two solutions
+     * Test the equality between two solutions
      * @param _sol1 the first solution
      * @param _sol2 the second solution
      * @return true if the solution2 is equal to solution1
@@ -61,7 +61,7 @@ public:
     }
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/comparator/moSolNeighborComparator.h

@@ -62,7 +62,7 @@ public:
     }
 
     /**
-     * Compare two neighbors
+     * Test the equality between two neighbors
      * @param _sol the solution
      * @param _neighbor the neighbor
      * @return true if the neighbor is equal to the solution
@@ -72,7 +72,7 @@ public:
     }
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h

@@ -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) {

trunk/paradiseo-mo/src/continuator/moCheckpoint.h

@@ -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
      */

trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h

@@ -35,8 +35,8 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 #include <vector>
 
 /**
- * Combined several continuators
+ * Combined several continuators.
- * Continue until one of the continuators is false
+ * 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) {

trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h

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

trunk/paradiseo-mo/src/continuator/moCounterStat.h

@@ -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) {

trunk/paradiseo-mo/src/continuator/moDistanceStat.h

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

trunk/paradiseo-mo/src/continuator/moFitnessStat.h

@@ -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"):

trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h

@@ -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
      */

trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h

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

trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h

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