Update documentation.
authorRafał Długołęcki <rafal@dlugolecki.net.pl>
Mon, 6 Apr 2015 14:59:48 +0000 (16:59 +0200)
committerRafał Długołęcki <rafal@dlugolecki.net.pl>
Mon, 6 Apr 2015 14:59:48 +0000 (16:59 +0200)
src/selection/linearRankSelection.h

index f16d0964966c6fe884076b9263d5a59bf946e589..8bbd3cea323013f721ded44fed6e0bec4c5ef7c5 100644 (file)
@@ -29,7 +29,12 @@ namespace genetic {
              */
             typedef typename GeneticFitness::ValueType FitnessValueType;
         protected:
+            /**
+             * Type representing mapped Chromosome by its Rank value
+             */
             typedef typename std::multimap<FitnessValueType, _Chromosome> ChromosomeMap;
+
+            /** Iterator for ChromosomeMap */
             typedef typename ChromosomeMap::iterator ChromosomeMapIterator;
 
             /**
@@ -66,7 +71,7 @@ namespace genetic {
             }
 
             /**
-             * Selection calculations should be done here.
+             * Invokes Selection calculations of the Linear Rank Selection
              *
              * @return new Generation of Chromosome's that passed the Selection
              */