From 93533e5fad33ea1488e5fbddbdfa1427a84a656c Mon Sep 17 00:00:00 2001 From: jhumeau Date: Fri, 21 May 2010 12:37:41 +0000 Subject: [PATCH] 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 | 2 +- trunk/paradiseo-mo/src/algo/moFirstImprHC.h | 4 ++-- .../paradiseo-mo/src/algo/moMetropolisHasting.h | 6 +++--- trunk/paradiseo-mo/src/algo/moNeutralHC.h | 6 +++--- trunk/paradiseo-mo/src/algo/moRandomBestHC.h | 6 +++--- .../paradiseo-mo/src/algo/moRandomNeutralWalk.h | 2 +- trunk/paradiseo-mo/src/algo/moSimpleHC.h | 6 +++--- .../src/comparator/moNeighborComparator.h | 2 +- .../src/comparator/moSolComparator.h | 4 ++-- .../src/comparator/moSolNeighborComparator.h | 4 ++-- .../continuator/moAverageFitnessNeighborStat.h | 6 +++--- .../paradiseo-mo/src/continuator/moCheckpoint.h | 2 +- .../src/continuator/moCombinedContinuator.h | 6 +++--- .../src/continuator/moCounterMonitorSaver.h | 2 +- .../paradiseo-mo/src/continuator/moCounterStat.h | 4 ++-- .../src/continuator/moDistanceStat.h | 2 +- .../paradiseo-mo/src/continuator/moFitnessStat.h | 2 +- .../src/continuator/moFullEvalContinuator.h | 2 +- .../src/continuator/moMaxNeighborStat.h | 2 +- .../src/continuator/moMinNeighborStat.h | 2 +- .../src/continuator/moMinusOneCounterStat.h | 4 ++-- .../src/continuator/moNbInfNeighborStat.h | 2 +- .../src/continuator/moNbSupNeighborStat.h | 2 +- .../src/continuator/moNeighborBestStat.h | 6 +++--- .../src/continuator/moNeighborEvalContinuator.h | 2 +- .../src/continuator/moNeighborFitnessStat.h | 6 +++--- .../src/continuator/moNeighborhoodStat.h | 8 ++++---- .../continuator/moNeutralDegreeNeighborStat.h | 2 +- .../src/continuator/moSecondMomentNeighborStat.h | 2 +- .../src/continuator/moSizeNeighborStat.h | 2 +- .../src/continuator/moSolutionStat.h | 6 +++--- trunk/paradiseo-mo/src/continuator/moStat.h | 2 +- .../src/continuator/moStatFromStat.h | 2 +- .../src/continuator/moStdFitnessNeighborStat.h | 2 +- .../src/continuator/moTimeContinuator.h | 4 ++-- .../src/continuator/moVectorMonitor.h | 2 +- .../src/coolingSchedule/moCoolingSchedule.h | 2 +- .../coolingSchedule/moSimpleCoolingSchedule.h | 4 ++-- trunk/paradiseo-mo/src/eval/moDummyEval.h | 4 ++-- .../paradiseo-mo/src/explorer/moDummyExplorer.h | 16 ++++++++-------- .../src/explorer/moFirstImprHCexplorer.h | 10 +++++----- trunk/paradiseo-mo/src/explorer/moILSexplorer.h | 4 ++-- .../src/explorer/moMetropolisHastingExplorer.h | 10 +++++----- .../src/explorer/moNeighborhoodExplorer.h | 6 ++---- .../src/explorer/moNeutralHCexplorer.h | 2 +- .../src/explorer/moRandomBestHCexplorer.h | 8 ++++---- .../src/explorer/moRandomNeutralWalkExplorer.h | 8 ++++---- .../src/explorer/moRandomSearchExplorer.h | 8 ++++---- .../src/explorer/moRandomWalkExplorer.h | 10 +++++----- trunk/paradiseo-mo/src/explorer/moSAexplorer.h | 8 ++++---- .../src/explorer/moSimpleHCexplorer.h | 15 ++++++++------- trunk/paradiseo-mo/src/explorer/moTSexplorer.h | 2 +- .../paradiseo-mo/src/memory/moCountMoveMemory.h | 4 ++-- trunk/paradiseo-mo/src/memory/moMemory.h | 2 +- .../src/memory/moMonOpDiversification.h | 2 +- .../src/memory/moNeighborVectorTabuList.h | 8 ++++---- .../src/memory/moSolVectorTabuList.h | 2 +- .../src/neighborhood/moBackableNeighbor.h | 2 +- .../src/neighborhood/moDummyNeighborhood.h | 12 ++++++------ .../src/neighborhood/moIndexNeighbor.h | 2 +- trunk/paradiseo-mo/src/neighborhood/moNeighbor.h | 5 +++-- .../src/neighborhood/moNeighborhood.h | 8 ++++---- .../src/neighborhood/moOrderNeighborhood.h | 6 +++--- .../src/neighborhood/moRndWithReplNeighborhood.h | 2 +- .../neighborhood/moRndWithoutReplNeighborhood.h | 2 +- .../paradiseo-mo/src/perturb/moLocalSearchInit.h | 2 +- trunk/paradiseo-mo/src/perturb/moMonOpPerturb.h | 2 +- .../src/perturb/moNeighborhoodPerturb.h | 2 +- .../paradiseo-mo/src/perturb/moRestartPerturb.h | 2 +- trunk/paradiseo-mo/src/perturb/moSolInit.h | 6 +++--- .../src/problems/bitString/moBitNeighbor.h | 6 +++--- .../src/problems/eval/moMaxSATincrEval.h | 2 +- .../src/problems/eval/moRoyalRoadIncrEval.h | 4 ++-- .../src/problems/permutation/moSwapNeighbor.h | 2 +- .../problems/permutation/moSwapNeighborhood.h | 6 +++--- .../src/sampling/moAutocorrelationSampling.h | 4 ++-- .../src/sampling/moDensityOfStatesSampling.h | 2 +- trunk/paradiseo-mo/src/sampling/moFDCsampling.h | 4 ++-- .../src/sampling/moFitnessCloudSampling.h | 2 +- .../src/sampling/moHillClimberSampling.h | 4 ++-- .../src/sampling/moMHBestFitnessCloudSampling.h | 2 +- .../src/sampling/moMHRndFitnessCloudSampling.h | 2 +- .../src/sampling/moNeutralDegreeSampling.h | 2 +- .../src/sampling/moNeutralWalkSampling.h | 6 +++--- .../src/sampling/moRndBestFitnessCloudSampling.h | 2 +- .../src/sampling/moRndRndFitnessCloudSampling.h | 2 +- trunk/paradiseo-mo/src/sampling/moSampling.h | 10 ++++------ trunk/paradiseo-mo/src/sampling/moStatistics.h | 2 +- 88 files changed, 188 insertions(+), 190 deletions(-) diff --git a/trunk/paradiseo-mo/src/algo/moDummyLS.h b/trunk/paradiseo-mo/src/algo/moDummyLS.h index 259b8eada..fd24d3575 100644 --- a/trunk/paradiseo-mo/src/algo/moDummyLS.h +++ b/trunk/paradiseo-mo/src/algo/moDummyLS.h @@ -64,7 +64,7 @@ public: private: // always true continuator moTrueContinuator trueCont; - // the explorer of the simple HC + // dummy Explorer moDummyExplorer explorer; }; diff --git a/trunk/paradiseo-mo/src/algo/moFirstImprHC.h b/trunk/paradiseo-mo/src/algo/moFirstImprHC.h index 28f141bfd..197fc3cae 100644 --- a/trunk/paradiseo-mo/src/algo/moFirstImprHC.h +++ b/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 trueCont; - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors: true if strictly greater moNeighborComparator defaultNeighborComp; // compare the fitness values of the solution and the neighbor: true if strictly greater moSolNeighborComparator defaultSolNeighborComp; diff --git a/trunk/paradiseo-mo/src/algo/moMetropolisHasting.h b/trunk/paradiseo-mo/src/algo/moMetropolisHasting.h index 99426c24b..5b4292459 100644 --- a/trunk/paradiseo-mo/src/algo/moMetropolisHasting.h +++ b/trunk/paradiseo-mo/src/algo/moMetropolisHasting.h @@ -99,11 +99,11 @@ public: private: // always true continuator moTrueContinuator trueCont; - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; - // the explorer of the HC with neutral move (equals fitness move) + // MetropolisHasting explorer moMetropolisHastingExplorer explorer; }; diff --git a/trunk/paradiseo-mo/src/algo/moNeutralHC.h b/trunk/paradiseo-mo/src/algo/moNeutralHC.h index 881980a66..2fd2583d5 100644 --- a/trunk/paradiseo-mo/src/algo/moNeutralHC.h +++ b/trunk/paradiseo-mo/src/algo/moNeutralHC.h @@ -37,7 +37,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr #include /** - * 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 trueCont; - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; // the explorer of the HC with neutral move (equals fitness move) moNeutralHCexplorer explorer; diff --git a/trunk/paradiseo-mo/src/algo/moRandomBestHC.h b/trunk/paradiseo-mo/src/algo/moRandomBestHC.h index 0e3f8bbbf..3e7a32d62 100644 --- a/trunk/paradiseo-mo/src/algo/moRandomBestHC.h +++ b/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 trueCont; - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; // the explorer of the HC with random choice of the best solution moRandomBestHCexplorer explorer; diff --git a/trunk/paradiseo-mo/src/algo/moRandomNeutralWalk.h b/trunk/paradiseo-mo/src/algo/moRandomNeutralWalk.h index 2071f93a8..4f21588c5 100644 --- a/trunk/paradiseo-mo/src/algo/moRandomNeutralWalk.h +++ b/trunk/paradiseo-mo/src/algo/moRandomNeutralWalk.h @@ -95,7 +95,7 @@ private: moTrueContinuator trueCont; // the explorer of the random walk moRandomNeutralWalkExplorer 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 defaultSolNeighborComp; }; diff --git a/trunk/paradiseo-mo/src/algo/moSimpleHC.h b/trunk/paradiseo-mo/src/algo/moSimpleHC.h index a8c9c6093..c334d0629 100644 --- a/trunk/paradiseo-mo/src/algo/moSimpleHC.h +++ b/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 trueCont; - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; // the explorer of the simple HC moSimpleHCexplorer explorer; diff --git a/trunk/paradiseo-mo/src/comparator/moNeighborComparator.h b/trunk/paradiseo-mo/src/comparator/moNeighborComparator.h index 19fbcd49b..869adbb5c 100644 --- a/trunk/paradiseo-mo/src/comparator/moNeighborComparator.h +++ b/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 { diff --git a/trunk/paradiseo-mo/src/comparator/moSolComparator.h b/trunk/paradiseo-mo/src/comparator/moSolComparator.h index c9f9eff5d..d7f30c2f8 100644 --- a/trunk/paradiseo-mo/src/comparator/moSolComparator.h +++ b/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 { diff --git a/trunk/paradiseo-mo/src/comparator/moSolNeighborComparator.h b/trunk/paradiseo-mo/src/comparator/moSolNeighborComparator.h index cd131dd09..1a49e8970 100644 --- a/trunk/paradiseo-mo/src/comparator/moSolNeighborComparator.h +++ b/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 { diff --git a/trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h index 2e678ecd4..4c268d6d3 100644 --- a/trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h +++ b/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 & _nhStat): moStat(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) { diff --git a/trunk/paradiseo-mo/src/continuator/moCheckpoint.h b/trunk/paradiseo-mo/src/continuator/moCheckpoint.h index f6fd2c53b..6c849fe59 100644 --- a/trunk/paradiseo-mo/src/continuator/moCheckpoint.h +++ b/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 */ diff --git a/trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h b/trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h index 5d85d4179..7533bd4fa 100644 --- a/trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h +++ b/trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h @@ -35,8 +35,8 @@ Contact: paradiseo-help@lists.gforge.inria.fr #include /** - * 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 @@ -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& _cont) { diff --git a/trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h b/trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h index 70e2a1c90..f57e05d2d 100644 --- a/trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h +++ b/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 */ diff --git a/trunk/paradiseo-mo/src/continuator/moCounterStat.h b/trunk/paradiseo-mo/src/continuator/moCounterStat.h index 7db90f916..85534e67e 100644 --- a/trunk/paradiseo-mo/src/continuator/moCounterStat.h +++ b/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) { diff --git a/trunk/paradiseo-mo/src/continuator/moDistanceStat.h b/trunk/paradiseo-mo/src/continuator/moDistanceStat.h index ffb877f0e..06cfe0007 100644 --- a/trunk/paradiseo-mo/src/continuator/moDistanceStat.h +++ b/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 */ diff --git a/trunk/paradiseo-mo/src/continuator/moFitnessStat.h b/trunk/paradiseo-mo/src/continuator/moFitnessStat.h index 9deb77eec..d4f2f4bea 100644 --- a/trunk/paradiseo-mo/src/continuator/moFitnessStat.h +++ b/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"): diff --git a/trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h b/trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h index bf78f9294..9f0014812 100644 --- a/trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h +++ b/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 */ diff --git a/trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h index 051b01f53..d0dbd8136 100644 --- a/trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h +++ b/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 & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h index 538b521ad..bd1cae1f9 100644 --- a/trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h +++ b/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 & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moMinusOneCounterStat.h b/trunk/paradiseo-mo/src/continuator/moMinusOneCounterStat.h index 0e32f3b9e..dfb9be881 100644 --- a/trunk/paradiseo-mo/src/continuator/moMinusOneCounterStat.h +++ b/trunk/paradiseo-mo/src/continuator/moMinusOneCounterStat.h @@ -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) { diff --git a/trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h index a1280369b..1fa6783bb 100644 --- a/trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h @@ -53,7 +53,7 @@ public : using moStat< EOT, unsigned >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moNbInfNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h index db49fca06..027d8f1e8 100644 --- a/trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h @@ -53,7 +53,7 @@ public : using moStat< EOT, unsigned >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moNbSupNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h b/trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h index d96ddaadb..7aa4b2ed6 100644 --- a/trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h @@ -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& solNeighborComparator; // default comparators - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; // number of neighbor to explore diff --git a/trunk/paradiseo-mo/src/continuator/moNeighborEvalContinuator.h b/trunk/paradiseo-mo/src/continuator/moNeighborEvalContinuator.h index 6b42086f2..b94bccbeb 100644 --- a/trunk/paradiseo-mo/src/continuator/moNeighborEvalContinuator.h +++ b/trunk/paradiseo-mo/src/continuator/moNeighborEvalContinuator.h @@ -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 */ diff --git a/trunk/paradiseo-mo/src/continuator/moNeighborFitnessStat.h b/trunk/paradiseo-mo/src/continuator/moNeighborFitnessStat.h index 239f60326..ab0d3bcb9 100644 --- a/trunk/paradiseo-mo/src/continuator/moNeighborFitnessStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNeighborFitnessStat.h @@ -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& eval; diff --git a/trunk/paradiseo-mo/src/continuator/moNeighborhoodStat.h b/trunk/paradiseo-mo/src/continuator/moNeighborhoodStat.h index 25ea7661e..efc8efbb5 100644 --- a/trunk/paradiseo-mo/src/continuator/moNeighborhoodStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNeighborhoodStat.h @@ -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& eval; @@ -244,9 +244,9 @@ private: moSolNeighborComparator& solNeighborComparator; // default comparators - // compare the fitness values of neighbors: true is strictly greater + // compare the fitness values of neighbors moNeighborComparator 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 defaultSolNeighborComp; // the stastics of the fitness diff --git a/trunk/paradiseo-mo/src/continuator/moNeutralDegreeNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moNeutralDegreeNeighborStat.h index ba4e5fb3b..88ab663b4 100644 --- a/trunk/paradiseo-mo/src/continuator/moNeutralDegreeNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moNeutralDegreeNeighborStat.h @@ -53,7 +53,7 @@ public : using moStat< EOT, unsigned >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moNeutralDegreeNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moSecondMomentNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moSecondMomentNeighborStat.h index 9d79ba5d1..c5b1009f7 100644 --- a/trunk/paradiseo-mo/src/continuator/moSecondMomentNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moSecondMomentNeighborStat.h @@ -51,7 +51,7 @@ public : using moStat< EOT, std::pair >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moSecondMomentNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moSizeNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moSizeNeighborStat.h index 1f17710e5..6e7ae60f1 100644 --- a/trunk/paradiseo-mo/src/continuator/moSizeNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moSizeNeighborStat.h @@ -52,7 +52,7 @@ public : using moStat< EOT, unsigned >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moSizeNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moSolutionStat.h b/trunk/paradiseo-mo/src/continuator/moSolutionStat.h index 2b488dcfa..f28f0c8a5 100644 --- a/trunk/paradiseo-mo/src/continuator/moSolutionStat.h +++ b/trunk/paradiseo-mo/src/continuator/moSolutionStat.h @@ -38,8 +38,8 @@ #include /** - * 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 @@ -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"): diff --git a/trunk/paradiseo-mo/src/continuator/moStat.h b/trunk/paradiseo-mo/src/continuator/moStat.h index bfbd4e620..b986166f3 100644 --- a/trunk/paradiseo-mo/src/continuator/moStat.h +++ b/trunk/paradiseo-mo/src/continuator/moStat.h @@ -48,7 +48,7 @@ class moStat : public eoValueParam, public moStatBase public: /** - * Default Constructor + * Constructor * @param _value a default parameter's value * @param _description a description of the parameter */ diff --git a/trunk/paradiseo-mo/src/continuator/moStatFromStat.h b/trunk/paradiseo-mo/src/continuator/moStatFromStat.h index 02eb0c70f..e8da634ad 100644 --- a/trunk/paradiseo-mo/src/continuator/moStatFromStat.h +++ b/trunk/paradiseo-mo/src/continuator/moStatFromStat.h @@ -47,7 +47,7 @@ public : using moStat< EOT , T >::value; /** - * Default Constructor + * Constructor * @param _stat a stat */ moStatFromStat(moStat & _stat): moStat(0, _stat.description()), stat(_stat) { diff --git a/trunk/paradiseo-mo/src/continuator/moStdFitnessNeighborStat.h b/trunk/paradiseo-mo/src/continuator/moStdFitnessNeighborStat.h index 5f9d9433d..b9a547954 100644 --- a/trunk/paradiseo-mo/src/continuator/moStdFitnessNeighborStat.h +++ b/trunk/paradiseo-mo/src/continuator/moStdFitnessNeighborStat.h @@ -51,7 +51,7 @@ public : using moStat< EOT, double >::value; /** - * Default Constructor + * Constructor * @param _nhStat a neighborhoodStat */ moStdFitnessNeighborStat(moNeighborhoodStat & _nhStat): diff --git a/trunk/paradiseo-mo/src/continuator/moTimeContinuator.h b/trunk/paradiseo-mo/src/continuator/moTimeContinuator.h index 7c137cee6..fce709dee 100644 --- a/trunk/paradiseo-mo/src/continuator/moTimeContinuator.h +++ b/trunk/paradiseo-mo/src/continuator/moTimeContinuator.h @@ -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) { diff --git a/trunk/paradiseo-mo/src/continuator/moVectorMonitor.h b/trunk/paradiseo-mo/src/continuator/moVectorMonitor.h index dc6a24eaa..7ee99a806 100644 --- a/trunk/paradiseo-mo/src/continuator/moVectorMonitor.h +++ b/trunk/paradiseo-mo/src/continuator/moVectorMonitor.h @@ -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 & _param) : doubleParam(&_param), intParam(NULL), eotParam(NULL) diff --git a/trunk/paradiseo-mo/src/coolingSchedule/moCoolingSchedule.h b/trunk/paradiseo-mo/src/coolingSchedule/moCoolingSchedule.h index 149304f93..9d3c8b02b 100644 --- a/trunk/paradiseo-mo/src/coolingSchedule/moCoolingSchedule.h +++ b/trunk/paradiseo-mo/src/coolingSchedule/moCoolingSchedule.h @@ -46,7 +46,7 @@ class moCoolingSchedule : public eoUF { public: /** - * Initial temperature + * Init the solution with the initial temperature * @param _solution initial solution */ virtual double init(EOT & _solution) = 0; diff --git a/trunk/paradiseo-mo/src/coolingSchedule/moSimpleCoolingSchedule.h b/trunk/paradiseo-mo/src/coolingSchedule/moSimpleCoolingSchedule.h index 4bab840d9..0c1446ba4 100644 --- a/trunk/paradiseo-mo/src/coolingSchedule/moSimpleCoolingSchedule.h +++ b/trunk/paradiseo-mo/src/coolingSchedule/moSimpleCoolingSchedule.h @@ -46,7 +46,7 @@ class moSimpleCoolingSchedule : public moCoolingSchedule { public: /** - * default constructor + * Constructor * @param _initT initial temperature * @param _alpha factor of decreasing * @param _span number of iteration with equal temperature @@ -55,7 +55,7 @@ public: moSimpleCoolingSchedule(double _initT, double _alpha, unsigned _span, double _finalT) : initT(_initT), alpha(_alpha), span(_span), finalT(_finalT) {} /** - * Initial temperature + * Getter on the initial temperature * @param _solution initial solution * @return the initial temperature */ diff --git a/trunk/paradiseo-mo/src/eval/moDummyEval.h b/trunk/paradiseo-mo/src/eval/moDummyEval.h index cb2a946b2..2809f12a3 100644 --- a/trunk/paradiseo-mo/src/eval/moDummyEval.h +++ b/trunk/paradiseo-mo/src/eval/moDummyEval.h @@ -43,8 +43,8 @@ public: /** * NOTHING TO DO - * @param _sol a solution (unused) - * @param _n a neighbor (unused) + * @param _sol unused solution + * @param _n unused neighbor */ void operator()(EOT& _sol, Neighbor& _n) {} diff --git a/trunk/paradiseo-mo/src/explorer/moDummyExplorer.h b/trunk/paradiseo-mo/src/explorer/moDummyExplorer.h index 623dfc8e6..3d58dbb08 100644 --- a/trunk/paradiseo-mo/src/explorer/moDummyExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moDummyExplorer.h @@ -52,19 +52,19 @@ public: /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ void initParam (EOT& _solution) { } ; /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ void updateParam (EOT& _solution) { } ; /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution * @return always false */ bool isContinue(EOT& _solution) { @@ -73,13 +73,13 @@ public: /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ void move(EOT& _solution) { } ; /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution * @return always false */ virtual bool accept(EOT& _solution) { @@ -88,18 +88,18 @@ public: /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT& _solution) { } ; /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ void operator()(EOT & _solution) { } /** - * Return the class id. + * Return the class name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/explorer/moFirstImprHCexplorer.h b/trunk/paradiseo-mo/src/explorer/moFirstImprHCexplorer.h index 455afcc91..27bb83deb 100644 --- a/trunk/paradiseo-mo/src/explorer/moFirstImprHCexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moFirstImprHCexplorer.h @@ -74,19 +74,19 @@ public: /** * initParam: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) {}; /** * updateParam: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) {}; /** * terminate: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -121,7 +121,7 @@ public: /** * continue if a move is accepted * @param _solution the solution - * @return true if an ameliorated neighbor was be found + * @return true if an ameliorated neighbor was found */ virtual bool isContinue(EOT & _solution) { return isAccept ; @@ -139,7 +139,7 @@ public: }; /** - * accept test if an ameliorated neighbor was be found + * accept test if an ameliorated neighbor was found * @param _solution the solution * @return true if the best neighbor ameliorate the fitness */ diff --git a/trunk/paradiseo-mo/src/explorer/moILSexplorer.h b/trunk/paradiseo-mo/src/explorer/moILSexplorer.h index 3a787656d..ed95f4520 100644 --- a/trunk/paradiseo-mo/src/explorer/moILSexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moILSexplorer.h @@ -141,7 +141,7 @@ public: }; /** - * accept test if an ameliorated neighbor was be found + * accept test if an ameliorated neighbor was found * @param _solution the solution * @return true if acceptance criteria is verified */ @@ -150,7 +150,7 @@ public: }; /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/explorer/moMetropolisHastingExplorer.h b/trunk/paradiseo-mo/src/explorer/moMetropolisHastingExplorer.h index 328bc1a01..49bb78fdd 100644 --- a/trunk/paradiseo-mo/src/explorer/moMetropolisHastingExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moMetropolisHastingExplorer.h @@ -45,7 +45,7 @@ #include /** - * Explorer for the Metropolis-Hasting Sampling + * Explorer for the Metropolis-Hasting Sampling. * Only the symetric case is considered when Q(x,y) = Q(y,x) * Fitness must be > 0 */ @@ -84,7 +84,7 @@ public: /** * initialization of the number of step to be done - * @param _solution the solution (unused here) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) { step = 0; @@ -93,7 +93,7 @@ public: /** * increase the number of step - * @param _solution the solution (unused here) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { step++; @@ -101,7 +101,7 @@ public: /** * terminate: NOTHING TO DO - * @param _solution the solution (unused here) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -145,7 +145,7 @@ public: }; /** - * accept test if an ameliorated neighbor was be found + * accept test if an ameliorated neighbor was found * @param _solution the solution * @return true if the best neighbor ameliorate the fitness */ diff --git a/trunk/paradiseo-mo/src/explorer/moNeighborhoodExplorer.h b/trunk/paradiseo-mo/src/explorer/moNeighborhoodExplorer.h index 6500db50f..369cd5cdd 100644 --- a/trunk/paradiseo-mo/src/explorer/moNeighborhoodExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moNeighborhoodExplorer.h @@ -40,7 +40,6 @@ #include #include -//#include #include #include @@ -102,9 +101,8 @@ public: */ virtual void terminate(EOT& _solution) = 0 ; - /** - * Getter for variable "isMoved" + * Getter of "isMoved" * @return true if move is applied */ bool moveApplied() { @@ -112,7 +110,7 @@ public: } /** - * Setter for variable "isMoved" + * Setter of "isMoved" * @param _isMoved */ void moveApplied(bool _isMoved) { diff --git a/trunk/paradiseo-mo/src/explorer/moNeutralHCexplorer.h b/trunk/paradiseo-mo/src/explorer/moNeutralHCexplorer.h index 3f2020e28..40443de40 100644 --- a/trunk/paradiseo-mo/src/explorer/moNeutralHCexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moNeutralHCexplorer.h @@ -101,7 +101,7 @@ public: }; /** - * continue if there is a neighbor and it is remainds some steps to do + * continue if there is a neighbor and it is remains some steps to do * @param _solution the solution * @return true there is some steps to do */ diff --git a/trunk/paradiseo-mo/src/explorer/moRandomBestHCexplorer.h b/trunk/paradiseo-mo/src/explorer/moRandomBestHCexplorer.h index d6ef191ec..bad6769a8 100644 --- a/trunk/paradiseo-mo/src/explorer/moRandomBestHCexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moRandomBestHCexplorer.h @@ -83,7 +83,7 @@ public: /** * empty the vector of best solutions - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) { // delete all the best solutions @@ -92,7 +92,7 @@ public: /** * empty the vector of best solutions - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { // delete all the best solutions @@ -101,7 +101,7 @@ public: /** * terminate: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -170,7 +170,7 @@ public: }; /** - * accept test if an amelirated neighbor was be found + * accept test if an amelirated neighbor was found * @param _solution the solution * @return true if the best neighbor ameliorate the fitness */ diff --git a/trunk/paradiseo-mo/src/explorer/moRandomNeutralWalkExplorer.h b/trunk/paradiseo-mo/src/explorer/moRandomNeutralWalkExplorer.h index f92940621..c139744c8 100644 --- a/trunk/paradiseo-mo/src/explorer/moRandomNeutralWalkExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moRandomNeutralWalkExplorer.h @@ -85,7 +85,7 @@ public: /** * initialization of the number of step to be done - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) { step = 0; @@ -94,7 +94,7 @@ public: /** * increase the number of step - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { step++; @@ -102,7 +102,7 @@ public: /** * terminate: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -134,7 +134,7 @@ public: }; /** - * continue if there is a neighbor and it is remainds some steps to do + * continue if there is a neighbor and it is remains some steps to do * @param _solution the solution * @return true there is some steps to do */ diff --git a/trunk/paradiseo-mo/src/explorer/moRandomSearchExplorer.h b/trunk/paradiseo-mo/src/explorer/moRandomSearchExplorer.h index 06276b658..1a5832e14 100644 --- a/trunk/paradiseo-mo/src/explorer/moRandomSearchExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moRandomSearchExplorer.h @@ -72,7 +72,7 @@ public: /** * initialization of the number of step to be done - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) { step = 0; @@ -80,7 +80,7 @@ public: /** * increase the number of step - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { step++; @@ -88,7 +88,7 @@ public: /** * terminate: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -106,7 +106,7 @@ public: }; /** - * continue if it is remainds some steps to do + * continue if it is remains some steps to do * @param _solution the solution * @return true there is some steps to do */ diff --git a/trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h b/trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h index 4c74fa25a..331601094 100644 --- a/trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h @@ -41,7 +41,7 @@ #include /** - * Explorer for a random walk explorer + * Explorer for a random walk */ template< class Neighbor > class moRandomWalkExplorer : public moNeighborhoodExplorer @@ -78,7 +78,7 @@ public: /** * initialization of the number of step to be done - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void initParam(EOT & _solution) { step = 0; @@ -87,7 +87,7 @@ public: /** * increase the number of step - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { step++; @@ -95,7 +95,7 @@ public: /** * terminate: NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; @@ -123,7 +123,7 @@ public: }; /** - * continue if there is a neighbor and it is remainds some steps to do + * continue if there is a neighbor and it is remains some steps to do * @param _solution the solution * @return true there is some steps to do */ diff --git a/trunk/paradiseo-mo/src/explorer/moSAexplorer.h b/trunk/paradiseo-mo/src/explorer/moSAexplorer.h index 56ca6834f..4b897f95f 100644 --- a/trunk/paradiseo-mo/src/explorer/moSAexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moSAexplorer.h @@ -92,7 +92,7 @@ public: /** * decrease the temperature if necessary - * @param _solution the solution (unused here) + * @param _solution unused solution */ virtual void updateParam(EOT & _solution) { coolingSchedule.update(temperature); @@ -100,13 +100,13 @@ public: /** * terminate: NOTHING TO DO - * @param _solution the solution (unused here) + * @param _solution unused solution */ virtual void terminate(EOT & _solution) {}; /** * Explore one random solution in the neighborhood - * @param _solution + * @param _solution the solution */ virtual void operator()(EOT & _solution) { //Test if _solution has a Neighbor @@ -133,7 +133,7 @@ public: }; /** - * move the solution on the accepted solution + * move the solution to the accepted solution * @param _solution the solution to move */ virtual void move(EOT & _solution) { diff --git a/trunk/paradiseo-mo/src/explorer/moSimpleHCexplorer.h b/trunk/paradiseo-mo/src/explorer/moSimpleHCexplorer.h index c85c4afec..80cab3412 100644 --- a/trunk/paradiseo-mo/src/explorer/moSimpleHCexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moSimpleHCexplorer.h @@ -76,26 +76,27 @@ public: /** * initParam: NOTHING TO DO + * @param _solution unused solution */ - virtual void initParam(EOT & solution) {}; + virtual void initParam(EOT & _solution) {}; /** * updateParam: NOTHING TO DO + * @param _solution unused solution */ - virtual void updateParam(EOT & solution) {}; + virtual void updateParam(EOT & _solution) {}; /** * terminate: NOTHING TO DO + * @param _solution unused solution */ - virtual void terminate(EOT & solution) {}; + virtual void terminate(EOT & _solution) {}; /** * Explore the neighborhood of a solution - * @param _solution + * @param _solution the current solution */ virtual void operator()(EOT & _solution) { - - //est qu'on peut initializer //Test if _solution has a Neighbor if (neighborhood.hasNeighbor(_solution)) { //init the first neighbor @@ -159,7 +160,7 @@ public: }; /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/explorer/moTSexplorer.h b/trunk/paradiseo-mo/src/explorer/moTSexplorer.h index be7965ee2..9c6615d7e 100644 --- a/trunk/paradiseo-mo/src/explorer/moTSexplorer.h +++ b/trunk/paradiseo-mo/src/explorer/moTSexplorer.h @@ -214,7 +214,7 @@ public: /** - * accept test if an ameliorated neighbor was be found + * accept test if an ameliorated neighbor was found * @param _solution the solution * @return true if the best neighbor ameliorate the fitness */ diff --git a/trunk/paradiseo-mo/src/memory/moCountMoveMemory.h b/trunk/paradiseo-mo/src/memory/moCountMoveMemory.h index cfca0eee8..22cbba5fd 100644 --- a/trunk/paradiseo-mo/src/memory/moCountMoveMemory.h +++ b/trunk/paradiseo-mo/src/memory/moCountMoveMemory.h @@ -33,7 +33,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr #include /** - * Count the number of move, noMove and the number of successive stagnation since the last Move + * Count the number of move, no move and the successive stagnation since the last Move */ template< class Neighbor > class moCountMoveMemory : virtual public moMemory { @@ -52,7 +52,7 @@ public: } /** - * @param _sol a solution (unused) + * @param _sol unused solution * @param _neighbor unused neighbor */ void add(EOT & _sol, Neighbor & _neighbor) { diff --git a/trunk/paradiseo-mo/src/memory/moMemory.h b/trunk/paradiseo-mo/src/memory/moMemory.h index a76351328..c45f583af 100644 --- a/trunk/paradiseo-mo/src/memory/moMemory.h +++ b/trunk/paradiseo-mo/src/memory/moMemory.h @@ -17,7 +17,7 @@ public: virtual void init(EOT & _sol) = 0; /** - * Add data in the memory + * Add data to the memory * @param _sol the current solution * @param _neighbor the current neighbor */ diff --git a/trunk/paradiseo-mo/src/memory/moMonOpDiversification.h b/trunk/paradiseo-mo/src/memory/moMonOpDiversification.h index 317dbd5e8..46fa8547b 100644 --- a/trunk/paradiseo-mo/src/memory/moMonOpDiversification.h +++ b/trunk/paradiseo-mo/src/memory/moMonOpDiversification.h @@ -46,7 +46,7 @@ public: typedef typename Neighbor::EOT EOT; /** - * Default Constructor + * Constructor * @param _monOp an eoMonOp (diversification operator) * @param _fullEval a full evaluation function */ diff --git a/trunk/paradiseo-mo/src/memory/moNeighborVectorTabuList.h b/trunk/paradiseo-mo/src/memory/moNeighborVectorTabuList.h index 3d0bfbf7c..75efade02 100644 --- a/trunk/paradiseo-mo/src/memory/moNeighborVectorTabuList.h +++ b/trunk/paradiseo-mo/src/memory/moNeighborVectorTabuList.h @@ -64,7 +64,7 @@ public: /** * add a new neighbor in the tabuList - * @param _sol the current solution (unused) + * @param _sol unused solution * @param _neighbor the current neighbor */ virtual void add(EOT & _sol, Neighbor & _neighbor) { @@ -84,8 +84,8 @@ public: /** * update the tabulist - * @param _sol the current solution (unused) - * @param _neighbor the current neighbor (unused) + * @param _sol unused solution + * @param _neighbor unused neighbor */ virtual void update(EOT & _sol, Neighbor & _neighbor) { if (howlong > 0) @@ -96,7 +96,7 @@ public: /** * check if the move is tabu - * @param _sol the current solution (unused) + * @param _sol unused solution * @param _neighbor the current neighbor * @return true if tabuList contains _sol */ diff --git a/trunk/paradiseo-mo/src/memory/moSolVectorTabuList.h b/trunk/paradiseo-mo/src/memory/moSolVectorTabuList.h index e6b034f82..ba72ccc43 100644 --- a/trunk/paradiseo-mo/src/memory/moSolVectorTabuList.h +++ b/trunk/paradiseo-mo/src/memory/moSolVectorTabuList.h @@ -65,7 +65,7 @@ public: /** * add a new solution in the tabuList * @param _sol the current solution - * @param _neighbor the current neighbor (unused) + * @param _neighbor unused neighbor */ virtual void add(EOT & _sol, Neighbor & _neighbor) { diff --git a/trunk/paradiseo-mo/src/neighborhood/moBackableNeighbor.h b/trunk/paradiseo-mo/src/neighborhood/moBackableNeighbor.h index 76bc5493e..4a851c451 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moBackableNeighbor.h +++ b/trunk/paradiseo-mo/src/neighborhood/moBackableNeighbor.h @@ -46,7 +46,7 @@ class moBackableNeighbor : virtual public moNeighbor public: /** - * the move back function + * the function to move back a solution * @param _solution the solution to moveBack */ virtual void moveBack(EOT & _solution)=0; diff --git a/trunk/paradiseo-mo/src/neighborhood/moDummyNeighborhood.h b/trunk/paradiseo-mo/src/neighborhood/moDummyNeighborhood.h index b06cfa17c..26c62163c 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moDummyNeighborhood.h +++ b/trunk/paradiseo-mo/src/neighborhood/moDummyNeighborhood.h @@ -43,7 +43,7 @@ public: /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution * @return always false */ virtual bool hasNeighbor(EOT & _solution) { @@ -52,21 +52,21 @@ public: /** * NOTHING TO DO - * @param _solution a solution (unused) - * @param _current a neighbor (unused) + * @param _solution unused solution + * @param _current unused neighbor */ virtual void init(EOT & _solution, Neighbor & _current) {} /** * NOTHING TO DO - * @param _solution a solution (unused) - * @param _current a neighbor (unused) + * @param _solution unused solution + * @param _current unused neighbor */ virtual void next(EOT & _solution, Neighbor & _current) {} /** * NOTHING TO DO - * @param _solution a solution (unused) + * @param _solution unused solution * @return always false */ virtual bool cont(EOT & _solution) { diff --git a/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h b/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h index cf444dadc..eabcf0de0 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h +++ b/trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h @@ -71,7 +71,7 @@ public: } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/neighborhood/moNeighbor.h b/trunk/paradiseo-mo/src/neighborhood/moNeighbor.h index 7f6accd03..9d69bee1e 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moNeighbor.h +++ b/trunk/paradiseo-mo/src/neighborhood/moNeighbor.h @@ -79,7 +79,7 @@ public: virtual void move(EOT & _solution) = 0 ; /** - * Get the fitness of the neighbor + * Get the fitness * @return fitness of the neighbor */ const Fitness fitness() const { @@ -104,6 +104,7 @@ public: } /** + * Test equality between two neighbors * @param _neighbor a neighbor * @return if _neighbor and this one are equals */ @@ -112,7 +113,7 @@ public: } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/neighborhood/moNeighborhood.h b/trunk/paradiseo-mo/src/neighborhood/moNeighborhood.h index ea0c6afcb..60d11c1f2 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moNeighborhood.h +++ b/trunk/paradiseo-mo/src/neighborhood/moNeighborhood.h @@ -55,7 +55,7 @@ public: moNeighborhood() {} /** - * @return if the neighborhood is random (default false) + * @return true if the neighborhood is random (default false) */ virtual bool isRandom() { return false; @@ -64,7 +64,7 @@ public: /** * Test if a solution has (again) a Neighbor * @param _solution the related solution - * @return if _solution has a Neighbor + * @return true if _solution has a Neighbor */ virtual bool hasNeighbor(EOT & _solution) = 0 ; @@ -85,12 +85,12 @@ public: /** * Test if there is again a neighbor * @param _solution the solution to explore - * @return if there is again a neighbor not explored + * @return true if there is again a neighbor not explored */ virtual bool cont(EOT & _solution) = 0 ; /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/neighborhood/moOrderNeighborhood.h b/trunk/paradiseo-mo/src/neighborhood/moOrderNeighborhood.h index b7535051a..9be4f8ec8 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moOrderNeighborhood.h +++ b/trunk/paradiseo-mo/src/neighborhood/moOrderNeighborhood.h @@ -38,7 +38,7 @@ #include /** - * A Ordered Neighborhood + * An ordered Neighborhood */ template< class Neighbor > class moOrderNeighborhood : public moIndexNeighborhood @@ -59,7 +59,7 @@ public: moOrderNeighborhood(unsigned int _neighborhoodSize): moIndexNeighborhood(_neighborhoodSize), currentIndex(0) {} /** - * Test if it exist a neighbor + * Test if a neighbor exists * @param _solution the solution to explore * @return true if the neighborhood was not empty */ @@ -107,7 +107,7 @@ public: } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/neighborhood/moRndWithReplNeighborhood.h b/trunk/paradiseo-mo/src/neighborhood/moRndWithReplNeighborhood.h index b99824658..16e9b0211 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moRndWithReplNeighborhood.h +++ b/trunk/paradiseo-mo/src/neighborhood/moRndWithReplNeighborhood.h @@ -97,7 +97,7 @@ public: } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/neighborhood/moRndWithoutReplNeighborhood.h b/trunk/paradiseo-mo/src/neighborhood/moRndWithoutReplNeighborhood.h index a80f0542c..8c66ee3f9 100644 --- a/trunk/paradiseo-mo/src/neighborhood/moRndWithoutReplNeighborhood.h +++ b/trunk/paradiseo-mo/src/neighborhood/moRndWithoutReplNeighborhood.h @@ -123,7 +123,7 @@ public: } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/perturb/moLocalSearchInit.h b/trunk/paradiseo-mo/src/perturb/moLocalSearchInit.h index 615b47e4a..d91c5c719 100644 --- a/trunk/paradiseo-mo/src/perturb/moLocalSearchInit.h +++ b/trunk/paradiseo-mo/src/perturb/moLocalSearchInit.h @@ -42,7 +42,7 @@ public: typedef typename Neighbor::EOT EOT; /** - * Default Constructor + * Constructor * @param _init initialization of the solution before the local search * @param _ls the local search to apply to the solution */ diff --git a/trunk/paradiseo-mo/src/perturb/moMonOpPerturb.h b/trunk/paradiseo-mo/src/perturb/moMonOpPerturb.h index bce407d71..5a2a7e8e4 100644 --- a/trunk/paradiseo-mo/src/perturb/moMonOpPerturb.h +++ b/trunk/paradiseo-mo/src/perturb/moMonOpPerturb.h @@ -45,7 +45,7 @@ public: typedef typename Neighbor::EOT EOT; /** - * Default Constructor + * Constructor * @param _monOp an eoMonOp (pertubation operator) * @param _fullEval a full evaluation function */ diff --git a/trunk/paradiseo-mo/src/perturb/moNeighborhoodPerturb.h b/trunk/paradiseo-mo/src/perturb/moNeighborhoodPerturb.h index 334b60994..676f5a828 100644 --- a/trunk/paradiseo-mo/src/perturb/moNeighborhoodPerturb.h +++ b/trunk/paradiseo-mo/src/perturb/moNeighborhoodPerturb.h @@ -45,7 +45,7 @@ public: typedef moNeighborhood OtherNH; /** - * Default Constructor + * Constructor * @param _otherNeighborhood a neighborhood * @param _eval an Evaluation Function */ diff --git a/trunk/paradiseo-mo/src/perturb/moRestartPerturb.h b/trunk/paradiseo-mo/src/perturb/moRestartPerturb.h index d2705b31d..c1b4b78ba 100644 --- a/trunk/paradiseo-mo/src/perturb/moRestartPerturb.h +++ b/trunk/paradiseo-mo/src/perturb/moRestartPerturb.h @@ -46,7 +46,7 @@ public: typedef typename Neighbor::EOT EOT; /** - * Default Constructor + * Constructor * @param _initializer an initializer of solution * @param _fullEval a full evaluation function * @param _threshold maximum number of iteration with no improvement diff --git a/trunk/paradiseo-mo/src/perturb/moSolInit.h b/trunk/paradiseo-mo/src/perturb/moSolInit.h index abfc693f9..8707d47fa 100644 --- a/trunk/paradiseo-mo/src/perturb/moSolInit.h +++ b/trunk/paradiseo-mo/src/perturb/moSolInit.h @@ -40,13 +40,13 @@ class moSolInit : public eoInit { public: /** - * Default Constructor - * @param _extSol external solution of the intiialization + * Constructor + * @param _extSol external solution of the initialization */ moSolInit(EOT & _extSol) : extSol(_extSol) {} /** - * Initialization on the externatl solution + * Initialization on the external solution * @param _solution to initialize */ void operator()(EOT& _solution) { diff --git a/trunk/paradiseo-mo/src/problems/bitString/moBitNeighbor.h b/trunk/paradiseo-mo/src/problems/bitString/moBitNeighbor.h index 778da36d3..d942eb937 100644 --- a/trunk/paradiseo-mo/src/problems/bitString/moBitNeighbor.h +++ b/trunk/paradiseo-mo/src/problems/bitString/moBitNeighbor.h @@ -68,7 +68,7 @@ public: } /** - * Return the class id. + * return the class name * @return the class name as a std::string */ virtual std::string className() const { @@ -76,7 +76,7 @@ public: } /** - * Read object.\ \ + * Read object.\ * Calls base class, just in case that one had something to do. * The read and print methods should be compatible and have the same format. * In principle, format is "plain": they just print a number @@ -92,7 +92,7 @@ public: } else { Fitness repFit ; - _is.seekg(pos); // rewind + _is.seekg(pos); _is >> repFit; _is >> key; fitness(repFit); diff --git a/trunk/paradiseo-mo/src/problems/eval/moMaxSATincrEval.h b/trunk/paradiseo-mo/src/problems/eval/moMaxSATincrEval.h index b5595c4c1..36f341508 100644 --- a/trunk/paradiseo-mo/src/problems/eval/moMaxSATincrEval.h +++ b/trunk/paradiseo-mo/src/problems/eval/moMaxSATincrEval.h @@ -49,7 +49,7 @@ public : variables = _fulleval.variables; } - /* + /** * incremental evaluation of the neighbor for the max SAT problem * @param _solution the solution (of type bit string) to move * @param _neighbor the neighbor (of type moBitNeigbor) to consider diff --git a/trunk/paradiseo-mo/src/problems/eval/moRoyalRoadIncrEval.h b/trunk/paradiseo-mo/src/problems/eval/moRoyalRoadIncrEval.h index 9a3432b09..e600b5bfd 100644 --- a/trunk/paradiseo-mo/src/problems/eval/moRoyalRoadIncrEval.h +++ b/trunk/paradiseo-mo/src/problems/eval/moRoyalRoadIncrEval.h @@ -43,12 +43,12 @@ public: typedef typename Neighbor::EOT EOT; /** - * Default constructor + * Constructor * @param _rr full evaluation of the Royal Road (to have the same block size) */ moRoyalRoadIncrEval(RoyalRoadEval & _rr) : k(_rr.blockSize()) {} - /* + /** * incremental evaluation of the neighbor for the Royal Road problem * @param _solution the solution to move (bit string) * @param _neighbor the neighbor to consider (of type moBitNeigbor) diff --git a/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighbor.h b/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighbor.h index 2846b6f26..810356fe2 100644 --- a/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighbor.h +++ b/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighbor.h @@ -55,7 +55,7 @@ public: /** * apply the swap to restore the solution (use by moFullEvalByModif) - * @param _solution the solution to move + * @param _solution the solution to move back */ virtual void moveBack(EOT& _solution) { unsigned int tmp; diff --git a/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighborhood.h b/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighborhood.h index 5b573954a..7666c67c9 100644 --- a/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighborhood.h +++ b/trunk/paradiseo-mo/src/problems/permutation/moSwapNeighborhood.h @@ -43,7 +43,7 @@ public: typedef moSwapNeighbor Neighbor; /** - * @return if there are available Neighbor + * @return true if there is at least an available neighbor */ virtual bool hasNeighbor(EOT& _solution) { return (_solution.size() > 1); @@ -79,14 +79,14 @@ public: /** * Test if there is again a neighbor * @param _solution the solution to explore - * @return if there is again a neighbor not explored + * @return true if there is again a neighbor not explored */ virtual bool cont(EOT& _solution) { return !((indices.first == (size-2)) && (indices.second == (size-1))); } /** - * Return the class id. + * Return the class Name * @return the class name as a std::string */ virtual std::string className() const { diff --git a/trunk/paradiseo-mo/src/sampling/moAutocorrelationSampling.h b/trunk/paradiseo-mo/src/sampling/moAutocorrelationSampling.h index ab2b4315f..3dbeaf954 100644 --- a/trunk/paradiseo-mo/src/sampling/moAutocorrelationSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moAutocorrelationSampling.h @@ -58,7 +58,7 @@ public: using moSampling::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(_init, * new moRandomWalk(_neighborhood, _fullEval, _eval, _nbStep), fitnessStat) {} /** - * default destructor + * Destructor */ ~moAutocorrelationSampling() { // delete the pointer on the local search which has been constructed in the constructor diff --git a/trunk/paradiseo-mo/src/sampling/moDensityOfStatesSampling.h b/trunk/paradiseo-mo/src/sampling/moDensityOfStatesSampling.h index ec13fd8b9..571f546de 100644 --- a/trunk/paradiseo-mo/src/sampling/moDensityOfStatesSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moDensityOfStatesSampling.h @@ -56,7 +56,7 @@ public: using moSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moFDCsampling.h b/trunk/paradiseo-mo/src/sampling/moFDCsampling.h index 899c184b2..22a224759 100644 --- a/trunk/paradiseo-mo/src/sampling/moFDCsampling.h +++ b/trunk/paradiseo-mo/src/sampling/moFDCsampling.h @@ -60,7 +60,7 @@ public: using moSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moFitnessCloudSampling.h b/trunk/paradiseo-mo/src/sampling/moFitnessCloudSampling.h index 4e5051acf..15817555a 100644 --- a/trunk/paradiseo-mo/src/sampling/moFitnessCloudSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moFitnessCloudSampling.h @@ -60,7 +60,7 @@ public: using moSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moHillClimberSampling.h b/trunk/paradiseo-mo/src/sampling/moHillClimberSampling.h index 2aa229345..6c2db82c3 100644 --- a/trunk/paradiseo-mo/src/sampling/moHillClimberSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moHillClimberSampling.h @@ -63,7 +63,7 @@ public: using moSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moMHBestFitnessCloudSampling.h b/trunk/paradiseo-mo/src/sampling/moMHBestFitnessCloudSampling.h index 7a1d07e8f..d68044498 100644 --- a/trunk/paradiseo-mo/src/sampling/moMHBestFitnessCloudSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moMHBestFitnessCloudSampling.h @@ -68,7 +68,7 @@ public: using moFitnessCloudSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moMHRndFitnessCloudSampling.h b/trunk/paradiseo-mo/src/sampling/moMHRndFitnessCloudSampling.h index 5e9efc10f..f72d6ff42 100644 --- a/trunk/paradiseo-mo/src/sampling/moMHRndFitnessCloudSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moMHRndFitnessCloudSampling.h @@ -68,7 +68,7 @@ public: using moFitnessCloudSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moNeutralDegreeSampling.h b/trunk/paradiseo-mo/src/sampling/moNeutralDegreeSampling.h index 8ff55419c..bc7386ba2 100644 --- a/trunk/paradiseo-mo/src/sampling/moNeutralDegreeSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moNeutralDegreeSampling.h @@ -61,7 +61,7 @@ public: using moSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moNeutralWalkSampling.h b/trunk/paradiseo-mo/src/sampling/moNeutralWalkSampling.h index 5ffdf647b..258792fe0 100644 --- a/trunk/paradiseo-mo/src/sampling/moNeutralWalkSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moNeutralWalkSampling.h @@ -81,12 +81,12 @@ public: using moSampling::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, diff --git a/trunk/paradiseo-mo/src/sampling/moRndBestFitnessCloudSampling.h b/trunk/paradiseo-mo/src/sampling/moRndBestFitnessCloudSampling.h index d2adcfec3..12826c512 100644 --- a/trunk/paradiseo-mo/src/sampling/moRndBestFitnessCloudSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moRndBestFitnessCloudSampling.h @@ -66,7 +66,7 @@ public: using moFitnessCloudSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moRndRndFitnessCloudSampling.h b/trunk/paradiseo-mo/src/sampling/moRndRndFitnessCloudSampling.h index 47a28eb99..ab778d69d 100644 --- a/trunk/paradiseo-mo/src/sampling/moRndRndFitnessCloudSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moRndRndFitnessCloudSampling.h @@ -66,7 +66,7 @@ public: using moFitnessCloudSampling::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 diff --git a/trunk/paradiseo-mo/src/sampling/moSampling.h b/trunk/paradiseo-mo/src/sampling/moSampling.h index 84a8a1cb2..06e9b5936 100644 --- a/trunk/paradiseo-mo/src/sampling/moSampling.h +++ b/trunk/paradiseo-mo/src/sampling/moSampling.h @@ -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 & 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 & getSolutions(unsigned int _numStat) { @@ -202,7 +201,6 @@ protected: moContinuator * continuator; moCheckpoint * checkpoint; - // std::vector*> statVec; std::vector< moVectorMonitor *> monitorVec; }; diff --git a/trunk/paradiseo-mo/src/sampling/moStatistics.h b/trunk/paradiseo-mo/src/sampling/moStatistics.h index 7dd5731ea..43ec8932f 100644 --- a/trunk/paradiseo-mo/src/sampling/moStatistics.h +++ b/trunk/paradiseo-mo/src/sampling/moStatistics.h @@ -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;