jinni 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e590fb000051d9d6745d00096924d0194c9927a5
-  data.tar.gz: c3768d8b17c550e001e2998e069f4c0417c895bf
+  metadata.gz: ee683454b13cb220e37262246b93ab743e790172
+  data.tar.gz: f387a3ff296f2ccb871c0b20da61fda5b2792055
 SHA512:
-  metadata.gz: 4c1301f91f504bc9bf00de0e15d3fe6b6be9a2247c827411998c2d9d0f51d8b3d9126714225130efb21e1b8e82003af50f85f2190e71ce2c677c924120fe3513
-  data.tar.gz: 983d1196cad96ba6f0df36cbccbade483cf1b9dd62cc7b82816fd1ec0176f1a0df4b64df22afdb3776816b1e2bd475a08241cfc5d2ba3904db62051e99149d32
+  metadata.gz: cc062f3fae19de17af17a78882fcf1c41d5d11f77ceadffb414f8cee299ae3524732dbc4bde8805b7a8f20549dd24f8d8c58e95dd0b158c5c618dab222f3191c
+  data.tar.gz: 86b8614b1b9a6cdde555b647a7ad34a11a806cc541ccc2922a301e1b3ba8726d3200e5bbb8329e1c8494ee47a25ab03ca2819285e226696be9ee1511960fcfd3

data/README.md

@@ -1,6 +1,6 @@
-# Jinni [![Gem](https://img.shields.io/gem/v/jinni.svg?style=plastic)]()
+# Jinni [![Gem](https://img.shields.io/gem/v/jinni.svg?style=plastic)](https://rubygems.org/gems/jinni)
 
-unconventional genetics, aggressively metaprogrammed
+unconventional genetics, aggressively metaprogrammed. Pronounced like `genie`.
 
 ## Installation
 
@@ -17,9 +17,9 @@ Or install it yourself as:
     $ gem install jinni
 
 
-## Usage
+## Quick-Start
 
-### Start with some objects
+### Make a class
 
     class Fish < Jinni::Creature
         # attr_genetic name, min, max
@@ -29,29 +29,83 @@ Or install it yourself as:
 
         # must return a fixnum
         def fitness
-            @pointiness + ( @speed_in_knots / @mass_in_kilos )
+             @pointiness + (@speed_in_knots / @mass_in_kilos )
         end
     end
 
-    fishes = []
+### Have an offspring
+
+    bill = Fish.random_new
+    ted = Fish.random_new
+
+    child = bill << ted
+
+### Put some creatures in a genepool
+
+    fishes = Genepool.new
     10.times { fishes.push(Fish.random_new) } # `random_new` respects min and max
 
-### Have an offspring
+### have some more offspring
 
     bill = fishes[0]
     ted = fishes[1]
 
     child = bill << ted
 
-### ~~Start a whole new generation~~ lol not yet
-
-this here doesn't work:
+### Start a whole new generation
 
-    generation = Jinni.generate_from fishes
+    generation = fishes.generate(10)
     fishes << generation
 
 ### todo: something mutations something, also make it faster
 
+## API
+
+### creatures : instance
+
+Jinni adds the following public instance methods to your creatures:
+
+#### fitness()
+you should override this function with something sensible for your class. It returns `0.0` by default, but any float will do.
+#### genes()
+genes is a getter method that returns the genetic attributes available to your instance.
+#### mutate(rate = 0.01)
+mutate returns a slightly mutated object. Each bit in the original dna has a `rate` chance of flipping.
+#### <<(object) / cross(object)
+<< is the basic method used to cross two objects. It splits the dna strands of the input objects into random chunks, and then they randomly swap.
+#### to_binary()
+to_binary returns the binary dna strand that represents the object.
+
+### creatures : class
+
+Jinni adds the following public class methods to your creature class:
+
+#### attr_genetic(:name, min, max)
+use this method in your class to declare your genetic attributes.
+#### random_new()
+random_new initializes an object with attributes randomly assigned from within your declared range.
+#### new_from_binary()
+use this method to initialize an object from an arbitrary binary string.
+
+### numeric
+
+Jinni also monkeypatches the following methods into Numeric:
+
+#### to_binary()
+utility method to convert a numeric into a binary string.
+#### bits()
+utility method to return the number of bits that the binary representation of the number requires
+
+### genepool
+
+Jinni creates a class, Genepool which inherits from Array. Genepool has the following instance methods:
+
+#### generate(n, mutationRate = 0.01, quality = :fitness)
+use this method to create a new generation of `n` creatures based on a genepool. it uses weighted roulette wheel selection to simulate the effects of genetic fitness, then crosses the selected objects together.
+#### roulette(n, quality = :fitness)
+this utility method uses weighted roulette wheel selection to choose `n` objects from your gene pool influenced by fitness. It does not cross them.
+#### average(quality = :fitness)
+this method returns the mean of one quality through a collection of objects. It's very useful for watching your generations increase in fitness.
 
 ## Contributing
 

data/lib/jinni/creature.rb

@@ -14,6 +14,12 @@ module Jinni
       @@genes
     end
 
+    def mutate(rate = 0.01)
+      binary = self.to_binary
+      newBinary = binary.chars.map { |bit| bit == "0" ? "1" : "0" if rand < rate }
+      return self.class.new_from_binary newBinary
+    end
+
     # this is Where It Happens
     # usage:
     # child = bill << ted
@@ -49,7 +55,6 @@ module Jinni
 
     # generic initialize from hash, called by the others
     def initialize(hash)
-      puts hash
       hash.each_pair do |gene, value|
         instance_variable_set( "@#{gene}", value )
       end
@@ -76,12 +81,12 @@ module Jinni
       start = 0
       @@genes.each_pair do |gene, range|
         binary_chunk = binary[start..(start = start + range.bits - 1)]
+        break if binary_chunk.class != String
         offset = binary_chunk.to_i(2)
         value = self.class.send("#{gene}_min") + offset
         start += 1
         params[gene] = value
       end
-      puts params
       params
     end
 

data/lib/jinni/eigenclass.rb

@@ -26,7 +26,7 @@ module Jinni
 
       # use like attr_accessor
       def attr_genetic( gene, min, max )
-        range = max - min
+        range = max - min + 1
 
         @@genes[gene] = range
 

data/lib/jinni/genepool.rb

@@ -0,0 +1,45 @@
+class Genepool < Array
+  def roulette(n, quality = :fitness)
+    scratch = self.clone
+
+    probabilities = scratch.map { |creature| creature.send(quality) }
+    selected = []
+
+    n.times do
+      r, inc = rand * probabilities.max, 0 # pick a random number and select the  individual
+                       # corresponding to that roulette-wheel area
+      scratch.each_index do |i|
+        if r < (inc += probabilities[i])
+          selected << scratch[i]
+          # make selection not pick sample twice
+          # scratch.delete_at i
+          # probabilities.delete_at i
+          break
+        end
+      end
+    end
+    return selected
+  end
+
+  def generate(n, mutationRate = 0.01, quality = :fitness)
+    scratch = self.clone
+
+    pool = scratch.roulette(n * 2, quality)
+
+    generation = Genepool.new
+
+    pool.each_slice(2) do |pair|
+      child = pair[0] << pair[1]
+      # child = child.mutate if mutationRate > 0
+      generation << child
+    end
+
+    return generation
+  end
+
+  def average(quality = :fitness)
+    self.map {|f| f.send(quality)}.inject{ |sum, n| sum + n }.to_f / self.length
+  end
+end
+
+

data/lib/jinni/numeric.rb

@@ -1,4 +1,3 @@
-
 class Numeric
   def to_binary
     to_s(2)

data/lib/jinni/version.rb

@@ -1,3 +1,3 @@
 module Jinni
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/jinni.rb

@@ -1,26 +1,30 @@
 require 'pry'
 
-require 'jinni/version'
-require 'jinni/creature'
-require 'jinni/eigenclass'
-require 'jinni/numeric'
-
-
-
-
+require_relative 'jinni/version'
+require_relative 'jinni/creature'
+require_relative 'jinni/eigenclass'
+require_relative 'jinni/numeric'
+require_relative 'jinni/genepool'
 
 class Fish < Jinni::Creature
-  attr_genetic :hunger, -10, 10
-  attr_genetic :speed, 1, 100
-  attr_genetic :size, 90, 100
-  attr_genetic :pointiness, 50, 100
-
-  set_schema
+  # attr_genetic name, min, max
+  attr_genetic :pointiness, 0, 2
+  attr_genetic :mass_in_kilos, 10, 100
+  attr_genetic :speed_in_knots, 8, 12
+
+  # must return a fixnum
+  def fitness
+     @pointiness.to_f * (@speed_in_knots.to_f / @mass_in_kilos.to_f )
+  end
 end
 
-bill = Fish.random_new()
-ted = Fish.random_new()
+fishes = Genepool.new
+100.times { fishes << Fish.random_new } # `random_new` respects min and max
 
-child = bill.cross(ted)
+newGen = fishes.generate(1000)
 
 binding.pry
+
+puts 'end'
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jinni
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Monks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,7 @@ files:
 - lib/jinni.rb
 - lib/jinni/creature.rb
 - lib/jinni/eigenclass.rb
+- lib/jinni/genepool.rb
 - lib/jinni/numeric.rb
 - lib/jinni/version.rb
 homepage: http://github.com/amonks/jinni