From 259ef86e96c7978e2173d9885b49b33f049c854c Mon Sep 17 00:00:00 2001
From: jhumeau <jhumeau@331e1502-861f-0410-8da2-ba01fb791d7f>
Date: Thu, 20 May 2010 08:04:41 +0000
Subject: [PATCH] Doc of DMLS updated

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1818 331e1502-861f-0410-8da2-ba01fb791d7f
---
 trunk/paradiseo-moeo/src/algo/moeoPLS1.h            |  2 ++
 trunk/paradiseo-moeo/src/algo/moeoPLS2.h            |  5 ++---
 .../moeoFirstImprovingNeighborhoodExplorer.h        | 13 +++++++++----
 .../moeoNoDesimprovingNeighborhoodExplorer.h        |  3 ++-
 .../explorer/moeoSimpleSubNeighborhoodExplorer.h    | 11 +++++++----
 5 files changed, 22 insertions(+), 12 deletions(-)

diff --git a/trunk/paradiseo-moeo/src/algo/moeoPLS1.h b/trunk/paradiseo-moeo/src/algo/moeoPLS1.h
index b11c920a2..98ae98a49 100644
--- a/trunk/paradiseo-moeo/src/algo/moeoPLS1.h
+++ b/trunk/paradiseo-moeo/src/algo/moeoPLS1.h
@@ -64,6 +64,8 @@ public:
 	 * @param _continuator a stop creterion
 	 * @param _eval a evaluation function
 	 * @param _archive a archive to store no-dominated individuals
+	 * @param _neighborhood a neighborhood
+	 * @param _incrEval neighbor evaluation function
 	 */
     moeoPLS1(
     		eoContinue < MOEOT > & _continuator,
diff --git a/trunk/paradiseo-moeo/src/algo/moeoPLS2.h b/trunk/paradiseo-moeo/src/algo/moeoPLS2.h
index dc6dc5a96..84a50c1c4 100644
--- a/trunk/paradiseo-moeo/src/algo/moeoPLS2.h
+++ b/trunk/paradiseo-moeo/src/algo/moeoPLS2.h
@@ -73,9 +73,8 @@ public:
 	 * @param _continuator a stop creterion
 	 * @param _eval a evaluation function
 	 * @param _archive a archive to store no-dominated individuals
-	 * @param _moveInit the move initializer
-	 * @param _nextMove allow to do or not a move
-	 * @param _incrEval a (generally) efficient evaluation fonction
+	 * @param _neighborhood a neighborhood
+	 * @param _incrEval neighbor evaluation function
 	 */
     moeoPLS2(
             eoContinue < MOEOT > & _continuator,
diff --git a/trunk/paradiseo-moeo/src/explorer/moeoFirstImprovingNeighborhoodExplorer.h b/trunk/paradiseo-moeo/src/explorer/moeoFirstImprovingNeighborhoodExplorer.h
index 14d69fba6..a3a8f4f91 100644
--- a/trunk/paradiseo-moeo/src/explorer/moeoFirstImprovingNeighborhoodExplorer.h
+++ b/trunk/paradiseo-moeo/src/explorer/moeoFirstImprovingNeighborhoodExplorer.h
@@ -42,7 +42,8 @@
 #include <explorer/moeoSubNeighborhoodExplorer.h>
 
 /**
- * Explorer which explore a part of the neighborhood
+ * Explorer which explore the neighborhood until a improving neighbor is found.
+ * No dominating neighbor are keeped.
  */
 template < class Neighbor >
 class moeoFirstImprovingNeighborhoodExplorer : public moeoSubNeighborhoodExplorer < Neighbor >
@@ -59,9 +60,8 @@ public:
 
 	/**
 	 * Ctor
-	 * @param _moveInit the move initializer
-	 * @param _nextMove allow to do or not a move
-	 * @param _incrEval a (generally) efficient evaluation fonction
+	 * @param _neighborhood a neighborhood
+	 * @param _eval neighbor evaluation funtion
 	 */
     moeoFirstImprovingNeighborhoodExplorer(
 			moNeighborhood<Neighbor>& _neighborhood,
@@ -94,6 +94,11 @@ private:
 		}
 	}
 
+	/**
+	 * subfunction of explore
+	 * @param _src the individual to explore
+	 * @param _dest contains new generated individuals
+	 */
 	void cycle(MOEOT & _src, eoPop < MOEOT > & _dest){
 		eval(_src, neighbor);
 		if(!comparator(neighbor.fitness(), _src.objectiveVector())){
diff --git a/trunk/paradiseo-moeo/src/explorer/moeoNoDesimprovingNeighborhoodExplorer.h b/trunk/paradiseo-moeo/src/explorer/moeoNoDesimprovingNeighborhoodExplorer.h
index 0cad28004..09674e697 100644
--- a/trunk/paradiseo-moeo/src/explorer/moeoNoDesimprovingNeighborhoodExplorer.h
+++ b/trunk/paradiseo-moeo/src/explorer/moeoNoDesimprovingNeighborhoodExplorer.h
@@ -42,7 +42,7 @@
 #include <explorer/moeoSubNeighborhoodExplorer.h>
 
 /**
- * Explorer which explore a part of the neighborhood
+ * Explorer which explore the neighborhood until a no desimproving neighbor is found.
  */
 template < class Neighbor >
 class moeoNoDesimprovingNeighborhoodExplorer : public moeoSubNeighborhoodExplorer < Neighbor >
@@ -60,6 +60,7 @@ public:
 	/**
 	 * Ctor
 	 * @param _neighborhood a neighborhood
+	 * @param _eval a neighbor evaluation function
 	 */
     moeoNoDesimprovingNeighborhoodExplorer(
     		moNeighborhood<Neighbor>& _neighborhood,
diff --git a/trunk/paradiseo-moeo/src/explorer/moeoSimpleSubNeighborhoodExplorer.h b/trunk/paradiseo-moeo/src/explorer/moeoSimpleSubNeighborhoodExplorer.h
index 54f0ba80d..f9141301b 100644
--- a/trunk/paradiseo-moeo/src/explorer/moeoSimpleSubNeighborhoodExplorer.h
+++ b/trunk/paradiseo-moeo/src/explorer/moeoSimpleSubNeighborhoodExplorer.h
@@ -60,10 +60,8 @@ public:
 
 	/**
 	 * Ctor
-	 * @param _moveInit the move initializer
-	 * @param _nextMove allow to do or not a move
-	 * @param _incrEval a (generally) efficient evaluation fonction
-	 * @param _number the number of neighbor to explore
+	 * @param _neighborhood a neighborhood
+	 * @param _eval an neighbor evaluation function
 	 */
     moeoSimpleSubNeighborhoodExplorer(
 			moNeighborhood<Neighbor>& _neighborhood,
@@ -100,6 +98,11 @@ private:
 		}
 	}
 
+	/**
+	 * subfunction of explore
+	 * @param _src the individual to explore
+	 * @param _dest contains new generated individuals
+	 */
 	void cycle(MOEOT & _src, eoPop < MOEOT > & _dest){
 		eval(_src, neighbor);
 		//copy the solution (_src) at the end of the destination (_dest)