update de la lesson 1 de tout

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

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

@@ -2,7 +2,7 @@
   <moRandomBestHCExplorer.h>
   Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2010
 
-  Sébastien Verel, Arnaud Liefooghe, Jérémie Humeau
+  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  use,
@@ -43,7 +43,8 @@
 #include <utils/eoRNG.h>
 
 /**
- * Explorer for a simple neutral Hill-climbing
+ * Explorer for Hill-Climbing 
+ * which choose randomly one of the best solution in the neighborhood at each iteration
  */
 template< class Neighbor >
 class moRandomBestHCExplorer : public moNeighborhoodExplorer<Neighbor>

trunk/paradiseo-mo/src/mo.h

@@ -38,6 +38,8 @@
 #include <algo/moLocalSearch.h>
 #include <algo/moSA.h>
 #include <algo/moSimpleHC.h>
+#include <algo/moFirstImprHC.h>
+#include <algo/moRandomBestHC.h>
 
 #include <comparator/moComparator.h>
 #include <comparator/moNeighborComparator.h>

trunk/paradiseo-mo/tutorial/Lesson1/CMakeLists.txt

@@ -5,11 +5,11 @@ INCLUDE_DIRECTORIES(${EO_SRC_DIR}/src
 LINK_DIRECTORIES(${EO_BIN_DIR}/lib)	
 
 ADD_EXECUTABLE(lesson1_simpleHC lesson1_simpleHC.cpp) 
-ADD_EXECUTABLE(lesson1_firstImpr lesson1_firstImpr.cpp) 
+ADD_EXECUTABLE(lesson1_firstImprHC lesson1_firstImprHC.cpp) 
 ADD_EXECUTABLE(lesson1_randomBestHC lesson1_randomBestHC.cpp) 
 ADD_EXECUTABLE(lesson1_HCneutral lesson1_HCneutral.cpp) 
 
 TARGET_LINK_LIBRARIES(lesson1_simpleHC eoutils ga eo) 
-TARGET_LINK_LIBRARIES(lesson1_firstImpr eoutils ga eo) 
+TARGET_LINK_LIBRARIES(lesson1_firstImprHC eoutils ga eo) 
 TARGET_LINK_LIBRARIES(lesson1_randomBestHC eoutils ga eo) 
 TARGET_LINK_LIBRARIES(lesson1_HCneutral eoutils ga eo) 

trunk/paradiseo-mo/tutorial/Lesson1/lesson1_firstImprHC.cpp

@@ -0,0 +1,196 @@
+//-----------------------------------------------------------------------------
+/** lesson1_firstImprHC.cpp
+ *
+ * SV - 27/04/10 - version 1
+ *
+ */
+//-----------------------------------------------------------------------------
+
+// standard includes
+#define HAVE_SSTREAM
+
+#include <stdexcept>  // runtime_error 
+#include <iostream>   // cout
+#include <sstream>    // ostrstream, istrstream
+#include <fstream>
+#include <string.h>
+
+// the general include for eo
+#include <eo>
+
+// declaration of the namespace
+using namespace std;
+
+//-----------------------------------------------------------------------------
+// representation of solutions, and neighbors
+#include <ga/eoBit.h>                         // bit string : see also EO tutorial lesson 1: FirstBitGA.cpp
+#include <problems/bitString/moBitNeighbor.h> // neighbor of bit string
+
+//-----------------------------------------------------------------------------
+// fitness function, and evaluation of neighbors
+#include <problems/eval/oneMaxFullEval.h>
+#include <problems/eval/moOneMaxIncrEval.h>
+#include <eval/moFullEvalByModif.h>
+
+//-----------------------------------------------------------------------------
+// neighborhood description
+#include <neighborhood/moRndWithoutReplNeighborhood.h> // visit all neighbors in random order without repeating any neighbor
+
+//-----------------------------------------------------------------------------
+// the first improvement Hill-Climbing local search
+#include <algo/moFirstImprHC.h>
+
+// Declaration of types
+//-----------------------------------------------------------------------------
+// Indi is the typedef of the solution type like in paradisEO-eo
+typedef eoBit<unsigned int> Indi;                      // bit string with unsigned fitness type
+// Neighbor is the typedef of the neighbor type,
+// Neighbor = How to compute the neighbor from the solution + information on it (i.e. fitness)  
+// all classes from paradisEO-mo use this template type
+typedef moBitNeighbor<unsigned int> Neighbor ;         // bit string neighbor with unsigned fitness type
+
+
+// Main function
+//-----------------------------------------------------------------------------
+void main_function(int argc, char **argv)
+{
+  /* =========================================================
+   *
+   * Parameters from parser
+   *
+   * ========================================================= */
+  // more information on the input parameters: see EO tutorial lesson 3
+  // but don't care at first it just read the parameters of the bit string size and the random seed.
+
+  // First define a parser from the command-line arguments
+  eoParser parser(argc, argv);
+
+  // For each parameter, define Parameter, read it through the parser,
+  // and assign the value to the variable
+
+  // random seed parameter
+  eoValueParam<uint32_t> seedParam(time(0), "seed", "Random number seed", 'S');
+  parser.processParam( seedParam );
+  unsigned seed = seedParam.value();
+
+  // length of the bit string
+  eoValueParam<unsigned int> vecSizeParam(20, "vecSize", "Genotype size", 'V');
+  parser.processParam( vecSizeParam, "Representation" );
+  unsigned vecSize = vecSizeParam.value();
+
+  // the name of the "status" file where all actual parameter values will be saved
+  string str_status = parser.ProgramName() + ".status"; // default value
+  eoValueParam<string> statusParam(str_status.c_str(), "status", "Status file");
+  parser.processParam( statusParam, "Persistence" );
+
+  // do the following AFTER ALL PARAMETERS HAVE BEEN PROCESSED
+  // i.e. in case you need parameters somewhere else, postpone these
+  if (parser.userNeedsHelp()) {
+    parser.printHelp(cout);
+    exit(1);
+  }
+  if (statusParam.value() != "") {
+    ofstream os(statusParam.value().c_str());
+    os << parser;// and you can use that file as parameter file
+  }
+
+  /* =========================================================
+   *
+   * Random seed
+   *
+   * ========================================================= */
+
+  // reproducible random seed: if you don't change SEED above,
+  // you'll aways get the same result, NOT a random run
+  // more information: see EO tutorial lesson 1 (FirstBitGA.cpp)
+  rng.reseed(seed);
+
+  /* =========================================================
+   *
+   * Initialization of the solution
+   *
+   * ========================================================= */
+
+  // a Indi random initializer: each bit is random
+  // more information: see EO tutorial lesson 1 (FirstBitGA.cpp)
+  eoUniformGenerator<bool> uGen;
+  eoInitFixedLength<Indi> random(vecSize, uGen);
+
+  /* =========================================================
+   *
+   * Eval fitness function (full evaluation)
+   *
+   * ========================================================= */
+
+  // the fitness function is just the number of 1 in the bit string
+  oneMaxFullEval<Indi> fullEval;
+
+  /* =========================================================
+   *
+   * evaluation of a neighbor solution
+   *
+   * ========================================================= */
+
+  // Use it if there is no incremental evaluation: a neighbor is evaluated by the full evaluation of a solution
+  // moFullEvalByModif<Neighbor> neighborEval(fullEval);
+
+  // Incremental evaluation of the neighbor: fitness is modified by +/- 1
+  moOneMaxIncrEval<Neighbor> neighborEval;
+
+  /* =========================================================
+   *
+   * the neighborhood of a solution
+   *
+   * ========================================================= */
+
+  // Exploration of the neighborhood in random order of the neigbor's index:
+  // each neighbor is visited only once
+  moRndWithoutReplNeighborhood<Neighbor> neighborhood(vecSize);
+
+  /* =========================================================
+   *
+   * the local search algorithm
+   *
+   * ========================================================= */
+
+  moFirstImprHC<Neighbor> hc(neighborhood, fullEval, neighborEval);
+
+  /* =========================================================
+   *
+   * executes the local search from a random solution
+   *
+   * ========================================================= */
+
+  // The current solution
+  Indi solution;
+
+  // Apply random initialization
+  random(solution);
+
+  // Evaluation of the initial solution:
+  // can be evaluated here, or else it will be done at the beginning of the local search
+  fullEval(solution);
+
+  // Output: the intial solution 
+  std::cout << "initial: " << solution << std::endl ;
+
+  // Apply the local search on the solution !
+  hc(solution);
+
+  // Output: the final solution 
+  std::cout << "final:   " << solution << std::endl ;
+
+}
+
+// A main that catches the exceptions
+
+int main(int argc, char **argv)
+{
+  try {
+    main_function(argc, argv);
+  }
+  catch (exception& e) {
+    cout << "Exception: " << e.what() << '\n';
+  }
+  return 1;
+}

trunk/paradiseo-mo/tutorial/Lesson1/lesson1_randomBestHC.cpp

@@ -1,7 +1,7 @@
 //-----------------------------------------------------------------------------
-/** testRandomBestHC.cpp
+/** first_randomBestHC.cpp
  *
- * SV - 24/01/10
+ * SV - 27/04/10 - version 1
  *
  */
 //-----------------------------------------------------------------------------
@@ -11,175 +11,174 @@
 
 #include <stdexcept>  // runtime_error 
 #include <iostream>   // cout
-#include <sstream>  // ostrstream, istrstream
+#include <sstream>    // ostrstream, istrstream
 #include <fstream>
 #include <string.h>
 
 // the general include for eo
 #include <eo>
-#include <ga.h>
 
+// declaration of the namespace
 using namespace std;
 
 //-----------------------------------------------------------------------------
-// fitness function
+// representation of solutions, and neighbors
-#include <problems/eval/oneMaxFullEval.h>
+#include <ga/eoBit.h>                         // bit string : see also EO tutorial lesson 1: FirstBitGA.cpp
-#include <problems/bitString/moBitNeighbor.h>
+#include <problems/bitString/moBitNeighbor.h> // neighbor of bit string
-#include <eoInt.h>
-#include <neighborhood/moOrderNeighborhood.h>
 
-#include <eval/moFullEvalByModif.h>
-#include <eval/moFullEvalByCopy.h>
-#include <comparator/moNeighborComparator.h>
-#include <comparator/moSolNeighborComparator.h>
-#include <continuator/moTrueContinuator.h>
-#include <algo/moLocalSearch.h>
-#include <explorer/moRandomBestHCExplorer.h>
-
-// REPRESENTATION
 //-----------------------------------------------------------------------------
-typedef eoBit<unsigned> Indi;
+// fitness function, and evaluation of neighbors
-typedef moBitNeighbor<unsigned int> Neighbor ; // incremental evaluation
+#include <problems/eval/oneMaxFullEval.h>
-typedef moOrderNeighborhood<Neighbor> Neighborhood ;
+#include <problems/eval/moOneMaxIncrEval.h>
+#include <eval/moFullEvalByModif.h>
 
+//-----------------------------------------------------------------------------
+// neighborhood description
+#include <neighborhood/moOrderNeighborhood.h> // visit all neighbors in increasing order of bit index
+
+//-----------------------------------------------------------------------------
+// the Hill-Climbing local search which randomly one of the best solution
+#include <algo/moRandomBestHC.h>
+
+// Declaration of types
+//-----------------------------------------------------------------------------
+// Indi is the typedef of the solution type like in paradisEO-eo
+typedef eoBit<unsigned int> Indi;                      // bit string with unsigned fitness type
+// Neighbor is the typedef of the neighbor type,
+// Neighbor = How to compute the neighbor from the solution + information on it (i.e. fitness)  
+// all classes from paradisEO-mo use this template type
+typedef moBitNeighbor<unsigned int> Neighbor ;         // bit string neighbor with unsigned fitness type
+
+
+// Main function
+//-----------------------------------------------------------------------------
 void main_function(int argc, char **argv)
 {
-    /* =========================================================
+  /* =========================================================
-    *
+   *
-    * Parameters
+   * Parameters from parser
-    *
+   *
-    * ========================================================= */
+   * ========================================================= */
+  // more information on the input parameters: see EO tutorial lesson 3
+  // but don't care at first it just read the parameters of the bit string size and the random seed.
 
-    // First define a parser from the command-line arguments
+  // First define a parser from the command-line arguments
-    eoParser parser(argc, argv);
+  eoParser parser(argc, argv);
 
-    // For each parameter, define Parameter, read it through the parser,
+  // For each parameter, define Parameter, read it through the parser,
-    // and assign the value to the variable
+  // and assign the value to the variable
 
-    eoValueParam<uint32_t> seedParam(time(0), "seed", "Random number seed", 'S');
+  // random seed parameter
-    parser.processParam( seedParam );
+  eoValueParam<uint32_t> seedParam(time(0), "seed", "Random number seed", 'S');
-    unsigned seed = seedParam.value();
+  parser.processParam( seedParam );
+  unsigned seed = seedParam.value();
 
-    // description of genotype
+  // length of the bit string
-    eoValueParam<unsigned int> vecSizeParam(8, "vecSize", "Genotype size", 'V');
+  eoValueParam<unsigned int> vecSizeParam(20, "vecSize", "Genotype size", 'V');
-    parser.processParam( vecSizeParam, "Representation" );
+  parser.processParam( vecSizeParam, "Representation" );
-    unsigned vecSize = vecSizeParam.value();
+  unsigned vecSize = vecSizeParam.value();
 
-    // the name of the "status" file where all actual parameter values will be saved
+  // the name of the "status" file where all actual parameter values will be saved
-    string str_status = parser.ProgramName() + ".status"; // default value
+  string str_status = parser.ProgramName() + ".status"; // default value
-    eoValueParam<string> statusParam(str_status.c_str(), "status", "Status file");
+  eoValueParam<string> statusParam(str_status.c_str(), "status", "Status file");
-    parser.processParam( statusParam, "Persistence" );
+  parser.processParam( statusParam, "Persistence" );
 
-    // do the following AFTER ALL PARAMETERS HAVE BEEN PROCESSED
+  // do the following AFTER ALL PARAMETERS HAVE BEEN PROCESSED
-    // i.e. in case you need parameters somewhere else, postpone these
+  // i.e. in case you need parameters somewhere else, postpone these
-    if (parser.userNeedsHelp()) {
+  if (parser.userNeedsHelp()) {
-        parser.printHelp(cout);
+    parser.printHelp(cout);
-        exit(1);
+    exit(1);
-    }
+  }
-    if (statusParam.value() != "") {
+  if (statusParam.value() != "") {
-        ofstream os(statusParam.value().c_str());
+    ofstream os(statusParam.value().c_str());
-        os << parser;// and you can use that file as parameter file
+    os << parser;// and you can use that file as parameter file
-    }
+  }
 
-    /* =========================================================
+  /* =========================================================
-     *
+   *
-     * Random seed
+   * Random seed
-     *
+   *
-     * ========================================================= */
+   * ========================================================= */
 
-    //reproducible random seed: if you don't change SEED above,
+  // reproducible random seed: if you don't change SEED above,
-    // you'll aways get the same result, NOT a random run
+  // you'll aways get the same result, NOT a random run
-    rng.reseed(seed);
+  // more information: see EO tutorial lesson 1 (FirstBitGA.cpp)
+  rng.reseed(seed);
 
+  /* =========================================================
+   *
+   * Initialization of the solution
+   *
+   * ========================================================= */
 
-    /* =========================================================
+  // a Indi random initializer: each bit is random
-     *
+  // more information: see EO tutorial lesson 1 (FirstBitGA.cpp)
-     * Eval fitness function
+  eoUniformGenerator<bool> uGen;
-     *
+  eoInitFixedLength<Indi> random(vecSize, uGen);
-     * ========================================================= */
 
-    oneMaxFullEval<Indi> eval;
+  /* =========================================================
+   *
+   * Eval fitness function (full evaluation)
+   *
+   * ========================================================= */
 
+  // the fitness function is just the number of 1 in the bit string
+  oneMaxFullEval<Indi> fullEval;
 
-    /* =========================================================
+  /* =========================================================
-     *
+   *
-     * Initilisation of the solution
+   * evaluation of a neighbor solution
-     *
+   *
-     * ========================================================= */
+   * ========================================================= */
 
-    // a Indi random initializer
+  // Use it if there is no incremental evaluation: a neighbor is evaluated by the full evaluation of a solution
-    eoUniformGenerator<bool> uGen;
+  // moFullEvalByModif<Neighbor> neighborEval(fullEval);
-    eoInitFixedLength<Indi> random(vecSize, uGen);
 
+  // Incremental evaluation of the neighbor: fitness is modified by +/- 1
+  moOneMaxIncrEval<Neighbor> neighborEval;
 
-    /* =========================================================
+  /* =========================================================
-     *
+   *
-     * evaluation of a neighbor solution
+   * the neighborhood of a solution
-     *
+   *
-     * ========================================================= */
+   * ========================================================= */
 
-    moFullEvalByModif<Neighbor> fulleval(eval);
+  // Exploration of the neighborhood in increasing order of the neigbor's index:
+  // bit-flip from bit 0 to bit (vecSize - 1)
+  moOrderNeighborhood<Neighbor> neighborhood(vecSize);
 
-    //An eval by copy can be used instead of the eval by modif
+  /* =========================================================
-    //moFullEvalByCopy<Neighbor> fulleval(eval);
+   *
+   * the local search algorithm
+   *
+   * ========================================================= */
 
+  moRandomBestHC<Neighbor> hc(neighborhood, fullEval, neighborEval);
 
-    /* =========================================================
+  /* =========================================================
-     *
+   *
-     * Comparator of neighbors
+   * executes the local search from a random solution
-     *
+   *
-     * ========================================================= */
+   * ========================================================= */
 
-    moNeighborComparator<Neighbor> comparator;
+  // The current solution
-    moSolNeighborComparator<Neighbor> solComparator;
+  Indi solution;
 
+  // Apply random initialization
+  random(solution);
 
-    /* =========================================================
+  // Evaluation of the initial solution:
-     *
+  // can be evaluated here, or else it will be done at the beginning of the local search
-     * the neighborhood of a solution
+  fullEval(solution);
-     *
-     * ========================================================= */
 
-    Neighborhood neighborhood(vecSize);
+  // Output: the intial solution 
+  std::cout << "initial: " << solution << std::endl ;
 
+  // Apply the local search on the solution !
+  hc(solution);
 
-    /* =========================================================
+  // Output: the final solution 
-     *
+  std::cout << "final:   " << solution << std::endl ;
-     * a neighborhood explorer solution
-     *
-     * ========================================================= */
-
-    moRandomBestHCExplorer<Neighbor> explorer(neighborhood, fulleval, comparator, solComparator);
-
-
-    /* =========================================================
-     *
-     * the local search algorithm
-     *
-     * ========================================================= */
-
-    moTrueContinuator<Neighbor> continuator;//always continue
-
-    moLocalSearch<Neighbor> localSearch(explorer, continuator, eval);
-
-    /* =========================================================
-     *
-     * execute the local search from random sollution
-     *
-     * ========================================================= */
-
-    Indi solution;
-
-    random(solution);
-
-    //Can be eval here, else it will be done at the beginning of the localSearch
-    //eval(solution);
-
-    std::cout << "initial: " << solution << std::endl ;
-
-    localSearch(solution);
-
-    std::cout << "final:   " << solution << std::endl ;
 
 }
 
@@ -187,11 +186,11 @@ void main_function(int argc, char **argv)
 
 int main(int argc, char **argv)
 {
-    try {
+  try {
-        main_function(argc, argv);
+    main_function(argc, argv);
-    }
+  }
-    catch (exception& e) {
+  catch (exception& e) {
-        cout << "Exception: " << e.what() << '\n';
+    cout << "Exception: " << e.what() << '\n';
-    }
+  }
-    return 1;
+  return 1;
 }

trunk/paradiseo-mo/tutorial/Lesson1/lesson1_simpleHC.cpp

@@ -11,13 +11,12 @@
 
 #include <stdexcept>  // runtime_error 
 #include <iostream>   // cout
-#include <sstream>  // ostrstream, istrstream
+#include <sstream>    // ostrstream, istrstream
 #include <fstream>
 #include <string.h>
 
 // the general include for eo
 #include <eo>
-#include <ga.h>
 
 // declaration of the namespace
 using namespace std;
@@ -47,7 +46,7 @@ using namespace std;
 typedef eoBit<unsigned int> Indi;                      // bit string with unsigned fitness type
 // Neighbor is the typedef of the neighbor type,
 // Neighbor = How to compute the neighbor from the solution + information on it (i.e. fitness)  
-// all classes from paradisEO-mo use this template
+// all classes from paradisEO-mo use this template type
 typedef moBitNeighbor<unsigned int> Neighbor ;         // bit string neighbor with unsigned fitness type
 
 
@@ -75,7 +74,7 @@ void main_function(int argc, char **argv)
   unsigned seed = seedParam.value();
 
   // length of the bit string
-  eoValueParam<unsigned int> vecSizeParam(8, "vecSize", "Genotype size", 'V');
+  eoValueParam<unsigned int> vecSizeParam(20, "vecSize", "Genotype size", 'V');
   parser.processParam( vecSizeParam, "Representation" );
   unsigned vecSize = vecSizeParam.value();
 
@@ -108,7 +107,7 @@ void main_function(int argc, char **argv)
 
   /* =========================================================
    *
-   * Initilisation of the solution
+   * Initialization of the solution
    *
    * ========================================================= */
 
@@ -165,19 +164,20 @@ void main_function(int argc, char **argv)
   // The current solution
   Indi solution;
 
-  // random intiialization
+  // Apply random initialization
   random(solution);
 
-  // Can be evaluated here, else it will be done at the beginning of the localSearch
+  // Evaluation of the initial solution:
+  // can be evaluated here, or else it will be done at the beginning of the local search
   fullEval(solution);
 
-  // output: the intial solution 
+  // Output: the intial solution 
   std::cout << "initial: " << solution << std::endl ;
 
-  // apply the local search on the solution !
+  // Apply the local search on the solution !
   hc(solution);
 
-  // output: the final solution 
+  // Output: the final solution 
   std::cout << "final:   " << solution << std::endl ;
 
 }