genetic_algorithms 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: "bundle exec rspec spec"

data/README.md

@@ -0,0 +1,41 @@
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/execdd17/genetic_algorithms) [![Travis](https://secure.travis-ci.org/execdd17/genetic_algorithms.png)](http://travis-ci.org)
+
+## Description
+
+This project contains my work in progress on Genetic Algorithms. The basic premise involves creating an initial random population of chromosomes and evolving them until they reach some ideal state.
+
+A chromosome is a solution to a problem, and represented as a bit string. It is intentionally general in order to lend itself to multiple domains. The only thing linking it to a particular problem set is the fitness function. A fitness function evaluates a chromosome, that is, the effectiveness of a proposed solution.
+
+## Usage
+
+In the GeneticAlgorithms module, the Engine class encapsulates the entire evolution process. You can quickly use it with default values like this:
+
+```ruby
+GeneticAlgorithms::Engine.new.start "AllOffSample"
+```
+And you'll see something like:
+
+```ruby
+{"1000000000"=>9}
+```
+
+This is a Hash containing the best chromosome found, and its score based on the fitness function. The argument to the start method is the name of a fitness function module. I have included a few with this project as a basic reference for creating your own. Here is an example fitness function where the best solution is where all bits are off:
+
+```ruby
+lambda do |chromosome|
+  chromosome.each_char.inject(0) do |accum, char|
+    accum += 1 if char == Chromosome::OFF
+    accum
+  end
+end
+```
+
+The engine has three optional parameters that can be utilized during construction. The population size, chromosome length, and number of generations to evolve (in that order). You'll notice that modifying these values can have a tremendous effect on the algorithm itself, and that is one of the interesting characteristics of genetic algorithms. In the future I will be opening up more parameters as well; currently many of them are tightly coupled to their respective classes.
+
+## Logging
+
+The RouletteWheel, Population, and Chromosome classes have independent loggers. Currently, they are all showing debug level and above messages, and can be changed in lib/genetic_algorithms.rb. The output of the log is written in the root directory titled 'results.log'. It will display things like which chromosomes were chosen to mate, what happened in crossover and mutation, the highest score in a given population, etc. I plan to make the loggers more easily configurable in future releases.
+
+## Feedback
+
+If you have a questions, comments, or feature requests, please feel free to contact me.

data/lib/genetic_algorithms/version.rb

@@ -1,3 +1,3 @@
 module GeneticAlgorithms
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genetic_algorithms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -67,9 +67,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - genetic_algorithms.gemspec
 - lib/genetic_algorithms.rb
 - lib/genetic_algorithms/chromosome.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/execdd17/genetic_algorithms]
-
-== Description
-
-This project contains my work in progress on Genetic Algorithms. The basic premise involves creating an initial random population of chromosomes and evolving them until they reach some ideal state.
-
-== Usage
-
-A chromosome is a solution to a problem, and represented as a bit string. It is intentionally general in order to lend itself to multiple domains. The only thing linking it to a particular problem set is the fitness function. A fitness function evaluates a chromosome, that is, the effectiveness of a proposed solution.
-
-In my GeneticAlgorithms project, I use the engine to encapsulate the entire evolution process. You can quickly use it with default values like this:
-
-<tt>GeneticAlgorithms::Engine.new.start "AllOffSample"</tt>
-
-The argument to the start method is a fitness function. I have included a few with this project as a basic guide for creating your own.
-
-The engine has three optional parameters that can be utilized during construction. The population size, chromosome length, and number of generations to evolve (in that order). You'll notice that modifying these values can have a tremendous effect on the algorithm itself, and that is one of the interesting characteristics of genetic algorithms. In the future I will be opening up more parameters as well; currently many of them are tightly coupled to their respective classes.