Add moRandomWalk.h, update lesson 6 sampling.cpp

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

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

@@ -0,0 +1,86 @@
+/*
+<moRandomWalk.h>
+Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2010
+
+Sebastien Verel, Arnaud Liefooghe, Jeremie Humeau
+
+This software is governed by the CeCILL license under French law and
+abiding by the rules of distribution of free software.  You can  ue,
+modify and/ or redistribute the software under the terms of the CeCILL
+license as circulated by CEA, CNRS and INRIA at the following URL
+"http://www.cecill.info".
+
+In this respect, the user's attention is drawn to the risks associated
+with loading,  using,  modifying and/or developing or reproducing the
+software by the user in light of its specific status of free software,
+that may mean  that it is complicated to manipulate,  and  that  also
+therefore means  that it is reserved for developers  and  experienced
+professionals having in-depth computer knowledge. Users are therefore
+encouraged to load and test the software's suitability as regards their
+requirements in conditions enabling the security of their systems and/or
+data to be ensured and,  more generally, to use and operate it in the
+same conditions as regards security.
+The fact that you are presently reading this means that you have had
+knowledge of the CeCILL license and that you accept its terms.
+
+ParadisEO WebSite : http://paradiseo.gforge.inria.fr
+Contact: paradiseo-help@lists.gforge.inria.fr
+*/
+
+#ifndef _moRandomWalk_h
+#define _moRandomWalk_h
+
+#include <algo/moLocalSearch.h>
+#include <explorer/moRandomWalkExplorer.h>
+#include <continuator/moTrueContinuator.h>
+#include <eval/moEval.h>
+#include <eoEvalFunc.h>
+
+/********************************************************
+ * Random Walk:
+ * Random walk local search
+ * 
+ * At each iteration,
+ *   one random neighbor is selected and replace the current solution
+ *   the algorithm stops when the number of steps is reached
+ ********************************************************/
+template<class Neighbor>
+class moRandomWalk: public moLocalSearch<Neighbor>
+{
+public:
+  typedef typename Neighbor::EOT EOT;
+  typedef moNeighborhood<Neighbor> Neighborhood ;
+
+  /**
+   * Simple constructor for a random walk
+   * @param _neighborhood the neighborhood
+   * @param _fullEval the full evaluation function
+   * @param _eval neighbor's evaluation function
+   * @param _nbStepMax number of step of the walk
+   */
+  moRandomWalk(Neighborhood& _neighborhood, eoEvalFunc<EOT>& _fullEval, moEval<Neighbor>& _eval, unsigned _nbStepMax):
+    moLocalSearch<Neighbor>(explorer, trueCont, _fullEval),
+    explorer(_neighborhood, _eval, _nbStepMax)
+  {}
+  
+  /**
+   * Simple constructor for a random walk
+   * @param _neighborhood the neighborhood
+   * @param _fullEval the full evaluation function
+   * @param _eval neighbor's evaluation function
+   * @param _nbStepMax number of step of the walk
+   * @param _cont an external continuator
+   */
+  moRandomWalk(Neighborhood& _neighborhood, eoEvalFunc<EOT>& _fullEval, moEval<Neighbor>& _eval, unsigned _nbStepMax, moContinuator<Neighbor>& _cont):
+    moLocalSearch<Neighbor>(explorer, _cont, _fullEval),
+    explorer(_neighborhood, _eval, _nbStepMax)
+  {}
+  
+private:
+  // always true continuator
+  moTrueContinuator<Neighbor> trueCont;
+  // the explorer of the random walk
+  moRandomWalkExplorer<Neighbor> explorer;
+};
+
+#endif

trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h

@@ -98,6 +98,7 @@ public:
 
     /**
      * Explore the neighborhood with only one random solution
+     * we supposed that the first neighbor is uniformly selected in the neighborhood
      * @param _solution
      */
     virtual void operator()(EOT & _solution) {

trunk/paradiseo-mo/src/mo.h

@@ -41,6 +41,7 @@
 #include <algo/moFirstImprHC.h>
 #include <algo/moRandomBestHC.h>
 #include <algo/moNeutralHC.h>
+#include <algo/moRandomWalk.h>
 #include <algo/moTS.h>
 
 #include <comparator/moComparator.h>

trunk/paradiseo-mo/src/sampling/moSampling.h

@@ -93,6 +93,7 @@ public:
 
   /**
    * To sample the search and get the statistics
+   * the statistics are stored in the moVectorMonitor vector
    */
   void operator()(void) {
     // clear all statisic vectors
@@ -111,14 +112,16 @@ public:
     // compute the sampling
     localSearch(solution);
 
-    // set to initial continuator
+    // set back to initial continuator
     localSearch.setContinuator(*continuator);
   }
 
   /**
    * to export the vector of values into one file
+   * @param _filename file name 
+   * @param _delim delimiter between statistics
    */
-  void exportFile(std::string _filename, std::string _delim = " ") {
+  void fileExport(std::string _filename, std::string _delim = " ") {
     // create file
     ofstream os(_filename.c_str()); 
 
@@ -145,6 +148,15 @@ public:
     
   }
 
+  /**
+   * to get one vector of values
+   * @param _numStat number of stattistics to get (in order of creation)
+   * @return the vector of value (all values are converted in double)
+   */
+  const std::vector<double> & getVector(unsigned int _numStat) {
+    return monitorVec[_numStat]->getVector();
+  }
+
   /**
    * @return name of the class
    */