genetic_algorithms 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3cdba165112209c915a3bf890c3eeff94b662d3
-  data.tar.gz: a69f8d541663a499fae44fd2deaace58787e54c6
+  metadata.gz: 60f0050bbf3c28bd27cef5ac06a2c0eb98483b1b
+  data.tar.gz: ab85e8c0d5f9067b8c4f16e5e51a7c85981a27fb
 SHA512:
-  metadata.gz: 71cfe4594501f7aa3f50aed4a197822ced2ff29b600a69ce3867c9bc88977718e000d73ad14bc0b86d263d01a6def4f270714bafa2516349682965217bfa646d
-  data.tar.gz: 20eebd164d5a001ab26ec8767b974f1cfc06d496ecbaaacb77b78dd2301eb2f06a6316f1cf9e4fafecc944ad70a6de6463526dc496e2d9c1a4a3272be5ac5eb0
+  metadata.gz: 963b2e939d68c5f04492cc386e7eddb89d5de6b70316a4f115ee9a265dfbd05ef9f83789bd596df9e593849bbf891bd819b8da1836ca46c582b2f43424ea8208
+  data.tar.gz: 60ca4238fbbe2c9b139faeda9f20a259fa7386fedf062a35bff2f2d0ed416ca5cf63162bae3715b5681f48ec2b7a9a4d53682272507f179a1c665d6f85783975

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    genetic_algorithms (0.0.4)
-      logging
+    genetic_algorithms (0.0.5)
+      logging (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -33,5 +33,5 @@ PLATFORMS
 
 DEPENDENCIES
   genetic_algorithms!
-  rspec
-  simplecov
+  rspec (~> 2.14)
+  simplecov (~> 0.8)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2014 Alexander Vanadio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -83,7 +83,12 @@ end
 require 'genetic_algorithms'
 include GeneticAlgorithms
 
-Engine.new(10,4).start(Knapsack::BEST_SCORE) do |chromosome|
+Engine.configure do |config|
+    config.population_size = 10
+    config.chromosome_length = 4
+end
+
+Engine.new.start(Knapsack::BEST_SCORE) do |chromosome|
   score = Knapsack.new(chromosome).utilization
 
   if score > Knapsack::BEST_SCORE

data/lib/genetic_algorithms/engine.rb

@@ -1,19 +1,28 @@
 module GeneticAlgorithms
-  class Engine 
-    
-    def initialize(population_size=10, chromosome_length=10, num_generations=5)
-      @population_size    = population_size 
-      @chromosome_length  = chromosome_length
-      @num_generations    = num_generations
-
-      @chromosomes = Population.random_chromosomes @population_size, @chromosome_length
-      @population  = Population.new @chromosomes
+  class Engine
+
+    class << self
+      attr_accessor :population_size, :chromosome_length, :num_generations
+    end
+
+    def self.configure(&block)
+      block.call(self) if block_given?
+
+      Engine.population_size    = 10  unless Engine.population_size
+      Engine.chromosome_length  = 10  unless Engine.chromosome_length
+      Engine.num_generations    = 5   unless Engine.num_generations
+    end
+
+    def initialize
+      Engine.configure
+      chromosomes = Population.random_chromosomes Engine.population_size, Engine.chromosome_length
+      @population = Population.new chromosomes
     end 
 
     def start(best_possible_score, &fitness_function)
       highest_score, best_gen = 0, nil
       
-      (0...@num_generations).inject(@population) do |newest_population, i|
+      (0...Engine.num_generations).inject(@population) do |newest_population, i|
         next_gen = newest_population.evolve(&fitness_function)
 
         if newest_population.highest_score > highest_score

data/lib/genetic_algorithms/version.rb

@@ -1,3 +1,3 @@
 module GeneticAlgorithms
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/engine_spec.rb

@@ -2,20 +2,50 @@ require 'spec_helper'
 include GeneticAlgorithms
 
 describe Engine do
-  
-  # TODO: DRY out this code
-  describe "#start" do
-    context "AllOffSample fitness function" do
 
-      subject do 
-        Engine.new(10,10,10).start(10) do |chromosome|
-          chromosome.each_char.inject(0) do |accum, char|         
-            accum += 1 if char == Chromosome::OFF                 
-            accum                                                 
-          end
+  BEST_SCORE = 10
+
+  describe '.configure' do
+    context 'when invoked to override default values' do
+      before(:all) do
+        Engine.configure do |config|
+          config.population_size    = 23
+          config.chromosome_length  = 15
+          config.num_generations    = 7
         end
-      end                                                     
+      end
+
+      it 'sets the population size from a config block' do
+        Engine.population_size.should be 23
+      end
+
+      it 'sets the chromosome length from a config block' do
+        Engine.chromosome_length.should be 15
+      end
+
+      it 'sets the num generations from a config block' do
+        Engine.num_generations.should be 7
+      end
+    end
+
+    context 'when invoked to set defaults for you' do
+      it 'it gives you a non-nil population size' do
+        Engine.population_size.should_not be nil
+      end
+
+      it 'it gives you a non-nil chromosome length' do
+        Engine.chromosome_length.should_not be nil
+      end
+
+      it 'it gives you a non-nil num generations' do
+        Engine.num_generations.should_not be nil
+      end
+    end
+  end
+
+  describe "#start" do
 
+    shared_examples "a fitness function" do
       it "returns a hash" do
         subject.is_a?(Hash).should == true
       end
@@ -29,29 +59,32 @@ describe Engine do
       end
     end
 
+    context "AllOffSample fitness function" do
+      subject do
+        Engine.new.start(BEST_SCORE) do |chromosome|
+          chromosome.each_char.inject(0) do |accum, char|         
+            accum += 1 if char == Chromosome::OFF                 
+            accum                                                 
+          end
+        end
+      end
+
+      it_should_behave_like "a fitness function"
+    end
+
     context "AlternatingOnOffSample fitness function" do
 
       subject do 
-        Engine.new(10,10,10).start(10) do |chromosome|
+        Engine.new.start(BEST_SCORE) do |chromosome|
           (0...chromosome.length).inject(0) do |accum, index|                      
             accum += 1 if index % 2 == 0 and chromosome[index] == Chromosome::ON   
             accum += 1 if index % 2 == 1 and chromosome[index] == Chromosome::OFF  
             accum                                                                  
           end                                                                      
         end
-      end                                                     
-
-      it "returns a hash" do
-        subject.is_a?(Hash).should == true
       end
 
-      it "returns the best solution as a Chromosome" do
-        subject.keys.first.is_a?(Chromosome).should == true
-      end
-
-      it "returns the best score as a Fixnum" do
-        subject.values.first.is_a?(Fixnum).should == true
-      end
+      it_should_behave_like "a fitness function"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genetic_algorithms
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alexander Vanadio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -64,6 +64,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - genetic_algorithms.gemspec
 - lib/genetic_algorithms.rb