genetic_framework 0.0.4 → 0.0.5

data/lib/genetic_framework.rb

@@ -1,13 +1,15 @@
 class Array
-    
     def random_element
         self[Random.rand(self.size)]
     end
 end
 
+#represents a pool of evolving strings towards a solution
 class GenePool
+
+    #represents a single potential solution to the problem - contains
+    #the string encoding and the fitness of that encoding.
     class Spawn
-        
         attr_reader :string, :fitness
         
         def initialize(fitness, string)
@@ -18,9 +20,20 @@ class GenePool
         def <=>(other)
             return self.fitness <=> other.fitness
         end
-        
-    end
+    end#end class Spawn
 
+    #gen_size is the number of spawn per generation, should be even
+    #encoding_map is a list of lists, where each position in the
+    #containing list is the equivalent position in the string encoding,
+    #and the list at that position contains all possible characters allowed
+    #at that position.
+    #TODO might not be wise to couple GenePool to the generation initialization.
+    #mutation_prob is the probability of mutation at each character of the encoding
+    #cull_threshold, if provided, is the minimum fitness score allowed to reproduce.
+    #   will not activate until enough sufficiently fit spawn are created
+    #elite, if provided, saves that number of the highest scoring spawn and passes
+    #   them directly into the next generation. Should be even.
+    #fitness is the function that evaluates a string (in this case, I try to maximize fitness)
     def initialize(gen_size, encoding_map, mutation_prob, cull_threshold = nil, elite = 0, initial_gen = nil, &fitness)
         @gen_size = gen_size
         @encoding_map = encoding_map
@@ -31,7 +44,7 @@ class GenePool
         if !initial_gen
             @gen = initialize_gen.map {|str| Spawn.new(yield(str), str)}
         end
-    end
+    end#end initialize
     
     attr_accessor :gen_size, :cull_threshold, :mutation_prob, :elite
     attr_reader :gen, :encoding_map
@@ -46,24 +59,27 @@ class GenePool
             spawn << position.random_element
         end
         return spawn.join
-    end
+    end#end build_spawn
 
     #char_map should be an array with length identical to string encoding length
     #and each position contains a list of chars possible for that position
+    #creates and returns an initial generation of @gen_size according
+    #to @encoding_map
     def initialize_gen
         pop = []
         1.upto(@gen_size) do |spawn_num|
             pop << build_spawn
         end
         return pop
-    end
+    end#end initialize_gen
 
-
-    def random_sexual_selection
+    #finds and returns the "parent" solutions who will "mate".
+    #takes a number of parents to select
+    def random_sexual_selection(num_parents)
         selected = []
         candidates = []
         
-        #create a list of candidates who meet the requirements (all if there is no cull)
+        #create a list of candidates who meet the requirements (all if there is no cull or not enough fit spawn)
         #a candidate shows up in the list once for each fitness level. This may be memory heavy,
         #so TODO improve the selection based on fitness
         strong = @gen.select {|spawn| !@cull_threshold or spawn.fitness >= @cull_threshold}
@@ -80,11 +96,11 @@ class GenePool
         
         #select from amount candidates a generation_size number of parents. Candidates can be selected
         #more than once, and have a higher chance of being selected for a higher fitness score
-        1.upto(@gen_size) do
+        1.upto(num_parents) do
             selected << candidates.random_element
         end
         return selected
-    end
+    end#end random_sexual_selection
 
     #mates two parent strings to create two child strings
     def sexually_reproduce(parent1, parent2)
@@ -92,8 +108,11 @@ class GenePool
         child1 = parent1[0, crossover] + parent2[crossover, parent2.size]
         child2 = parent2[0, crossover] + parent1[crossover, parent2.size]
         return [child1, child2]
-    end
+    end#end sexually_reproduce
 
+    #traverses the string and with probability @mutation_prob randomly
+    #reassigns one of the characters to a different character in the
+    #map for that position
     def mutate(string)
        0.upto(string.size - 1) do |str_index|
            if Random.rand < @mutation_prob
@@ -101,35 +120,37 @@ class GenePool
            end
        end
        return string
-    end
+    end#end mutate
 
     public
     
-    #takes generation and evolves it one generation. if generation is nil, returns an initial, random generation
-    #the char_map is a list of lists - each position has a list of chars that are valid for that position.
+    #evolves the current pool one generation. if generation is nil, returns an initial, random generation
     #it tells us both how long each string is and what sort of encodings are valid for creation.
     #Resulting generation is sorted according to fitness from least to greatest.
     def evolve
         #select spawn who will breed
-        parents = random_sexual_selection
+        
         #generation size should be even... or the last parent selected will be ignored
         #breed new spawn
         new_gen = []
-        
         if @elite
             1.upto(@elite) do |offset|
-                if offset > @gen.size then break end
+                break if offset > @gen.size
                 new_gen << @gen[-offset]
             end
-        end
-        start_count = new_gen.size
-        (start_count..@gen_size - 1).step(2) do |index|
+        end#end elite selection
+        
+        parents = random_sexual_selection(@gen_size - new_gen.size)
+        
+        #fill remaining slots with bred children
+        
+        (0..parents.size - 1).step(2) do |index|
             new_gen += sexually_reproduce(parents[index].string, parents[index + 1].string).map do |child_string| 
                 s = mutate(child_string)
                 Spawn.new(@fitness.call(s), s)
             end
-        end
+        end#end create children
         
         @gen = new_gen.sort
-    end    
-end
+    end#end evolve
+end#end class GenePool

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Brian Fults
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-06 00:00:00 -05:00
+date: 2012-04-17 00:00:00 -04:00
 default_executable: 
 dependencies: []