From 57881e56c4a940aefc8872bdc25eb9d67a39838c Mon Sep 17 00:00:00 2001
From: evomarc <evomarc>
Date: Sat, 28 Aug 2004 16:26:03 +0000
Subject: [PATCH] CLeaned up the comments in files related to Sharing (added
 t-eoSharing in test)

---
 eo/src/eoSharing.h       | 26 +++++++-------------------
 eo/src/eoSharingSelect.h | 10 ++++++----
 2 files changed, 13 insertions(+), 23 deletions(-)

diff --git a/eo/src/eoSharing.h b/eo/src/eoSharing.h
index 7f177aee..771e2be9 100644
--- a/eo/src/eoSharing.h
+++ b/eo/src/eoSharing.h
@@ -24,7 +24,7 @@
 //-----------------------------------------------------------------------------
 
 #ifndef eoSharing_h
-#define eoPerf2Worth_h
+#define eoSharing_h
 
 #include <eoPerf2Worth.h>
 #include <utils/eoDistance.h>
@@ -33,8 +33,7 @@
  *  Goldberg and Richardson's basic sharing
 */
 
-// First a helper class
-  // helper class to  hold distances
+/** A helper class for Sharing - to  hold distances */
   class dMatrix : public std::vector<double>
   {
   public:
@@ -71,7 +70,11 @@
   };
 
 
-// template <class EOT, class Dist = eoQuadDistance<EOT> >
+/** Sharing is a perf2worth class that implements 
+ *  Goldberg and Richardson's basic sharing
+ *  see eoSharingSelect for how to use it
+ * and test/t-eoSharing.cpp for a sample use of both
+*/
 template <class EOT>
 class eoSharing : public eoPerf2Worth<EOT>
 {
@@ -107,28 +110,13 @@ class eoSharing : public eoPerf2Worth<EOT>
 	    }
 	}
 
-//       cout << "Matrice des similarités\n";
-//       for (i=0; i<pSize; i++)
-// 	{
-// 	  for (j=0; j<pSize; j++)
-// 	    {
-// 	      cout << distMatrix(i,j) << " ";
-// 	    }
-// 	  cout << "\n";
-// 	}
-//       cout << endl;
-
-//      cout << "Les similarités cumulées\n";
-      // compute the cumulated similarities
       for (i=0; i<pSize; i++)
 	{
 	  double sum=0.0;
 	  for (j=0; j<pSize; j++)
 	    sum += distMatrix(i,j);
 	  sim[i] = sum;
-//	  cout << sim[i] << " ";
 	}
-//      cout << endl;
 
       // now set the worthes values
       for (i = 0; i < _pop.size(); ++i)
diff --git a/eo/src/eoSharingSelect.h b/eo/src/eoSharingSelect.h
index 7daf9fd1..40825c97 100644
--- a/eo/src/eoSharingSelect.h
+++ b/eo/src/eoSharingSelect.h
@@ -31,10 +31,12 @@
 #include <eoSelectFromWorth.h>
 #include <eoSharing.h>
 
-/** eoRankingSelect: select an individual by roulette wheel on its rank
- *  is an eoRouletteWorthSelect, i.e. a selector using a std::vector of worthes
- *  rather than the raw fitness (see eoSelectFromWorth.h)
- *  uses an internal eoRanking object which is an eoPerf2Worth<EOT, double>
+/** eoSharingSelect: select an individual by roulette wheel 
+ * on its SHARED fitness. It is an eoRouletteWorthSelect, 
+ * i.e. a selector using a std::vector of worthes
+ * rather than the raw fitness (see eoSelectFromWorth.h)
+ * It uses an internal eoSharing object which is 
+ * an eoPerf2Worth<EOT, double>
 */
 
 template <class EOT>