Remove unnecessary comments.
[genetic.git] / src / selection / linearRankSelection.h
1 #ifndef __SELECTION_LINEAR_RANK_H
2 #define __SELECTION_LINEAR_RANK_H
3
4 #include <map>
5
6 #include "chromosome.h"
7 #include "generation.h"
8 #include "fitness/fitness.h"
9 #include "selection/selection.h"
10
11 using namespace std;
12
13 namespace genetic {
14 //     namespace selection {
15         /**
16          * Linear Rank Selection class.
17          * Based on the 
18          */
19         template < typename _Chromosome >
20         class LinearRankSelection : public Selection<_Chromosome> {
21         public:
22             /**
23              * Type representing Fitness function
24              */
25             typedef Fitness<_Chromosome> GeneticFitness;
26
27             /**
28              * Value type returned by the Fitness function
29              */
30             typedef typename GeneticFitness::ValueType FitnessValueType;
31         protected:
32             typedef typename std::multimap<FitnessValueType, _Chromosome> ChromosomeMap;
33             typedef typename ChromosomeMap::iterator ChromosomeMapIterator;
34
35             /**
36              * Calculates Ranks for the Chromosomes
37              *
38              * @return multimap containing ranked Chromosomes, where key is the
39              *      rank value.
40              */
41             ChromosomeMap rankChromosomes() {
42                 const unsigned int generationSize = this->generation.size();
43                 FitnessValueType fitness = 0;
44
45                 ChromosomeMap generationFitness;
46
47                 for (unsigned int i = 0; i < generationSize; i++) {
48                     fitness = this->checkChromosomeFitness(this->generation[i]);
49                     generationFitness.insert(std::make_pair(fitness, this->generation[i]));
50                 }
51
52                 // multimap is automatically sorted by key, so we don't need to
53                 // sort it again
54
55                 // p(i) = (rank(i) / N*(N-1)), where rankedGeneration[i] = p(i)
56                 ChromosomeMap rankedGeneration;
57
58                 unsigned int rank = generationSize;
59                 double denominator = generationSize * (generationSize - 1);
60
61                 for (ChromosomeMapIterator it = generationFitness.begin(); it != generationFitness.end(); it++) {
62                     rankedGeneration.insert(std::make_pair(rank--/denominator, it->second));
63                 }
64
65                 return rankedGeneration;
66             }
67
68             /**
69              * Selection calculations should be done here.
70              *
71              * @return new Generation of Chromosome's that passed the Selection
72              */
73             virtual Generation<_Chromosome> do_draw() {
74                 ChromosomeMap probabilities = rankChromosomes();
75
76                 unsigned int size = probabilities.size();
77                 unsigned int denominator = size * (size - 1);
78
79                 std::vector<_Chromosome> selected;
80
81                 /** Random value used to draw chromosome */
82                 FitnessValueType random = 0;
83
84                 while (size > 0) {
85                     bool found = false;
86                     random = (rand() % size) / (double)denominator;
87
88                     for (ChromosomeMapIterator it = probabilities.begin(); it != probabilities.end(); it++) {
89                         if (random < it->first) {
90                             found = true;
91                             selected.push_back(it->second);
92                             break;
93                         }
94                         // When NaN occur, just get first Chromosome
95                         else if (it->first != it->first) {
96                             selected.push_back(probabilities.begin()->second);
97                             found = true;
98                             break;
99                         }
100                     }
101
102                     if (found) {
103                         size--;
104                     }
105                 }
106
107                 return Generation<_Chromosome>(selected);
108             }
109         public:
110             LinearRankSelection(Generation<_Chromosome> _generation, GeneticFitness& _fitness) :
111                 Selection<_Chromosome>(_generation, _fitness) {
112             }
113         };
114 //     }
115 }
116
117 #endif /* __SELECTION_LINEAR_RANK_H */