gemetics 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0533b871cdce9b34b0498968c49c632cfd8dfd
-  data.tar.gz: 1741baf1f07902310855bf0751e27127afc143a0
+  metadata.gz: 2ddeeb3132c636e9788f6ec9c1e4a8fd7cf7e584
+  data.tar.gz: 6136a2cb2d02172058db28b24fbc4e7858b94b56
 SHA512:
-  metadata.gz: 2595caadc1a4595d5a8236c0f695f183975d6a8a665627bdab4dda1e9d6db8c9b6f5489ed7d857b4a756991aa7b913467949ff71816ab70f81f295ccba5688b6
-  data.tar.gz: dae4e162910456dce31d552af1ae05df3b454a391a5c37719f9b29a38cea48afd4ab8f829096a0ec381e12f914d0e286ab308d92b150bbb336bdd6d6e7808a95
+  metadata.gz: 39a8fe2e1265bb761643846387c11150e63a8b30566671062db7b87ffee9330c9ef3231601d81b861451aeee33b89dc52ff2e23824b9ffc1634330aeed653635
+  data.tar.gz: 76dea21c731cdb8f7249db6e601ec2feadf9189d733f3380ae81e034d13418715086474ca09e0e51ba03200f10902a8f7d733f4bbcad19e706a6be11b0dee152

data/lib/gemetics.rb

@@ -1,27 +1,33 @@
+require_relative 'genetic_object'
+
 def default_GA_options()
   return {
-	 greaterBetter: true,
-	 totalPopReplace: true,
-	 genMax: 1000,
-	 selectionStyle: 'tournament',
-	 mutation_percent: 0.05,
-	 debug: false,
+	greaterBetter: true,
+	totalPopReplace: true,
+	genMax: 1000,
+	selectionStyle: 'tournament',
+	mutationPercent: 0.05,
+	elitism: 0,
+	debug: false,
   }
 end
 
-def runAlgorithm(initialPopulation, eval, threshold, options)
+def runGeneticAlgorithm(initialPopulation, eval, threshold, options)
   # make sure options is assigned
 	if(options == nil)
 		options = default_GA_options
 	end
+	validOptions(options,population.size()) # Raises error if options are not correct
 	currentGen = 0
 	bestCanidate = initialPopulation[0]
 	population = initialPopulation
-	while(!exceedThreshold(options[:greaterBetter], bestCanidate.fitness, threshold) && currentGen < options[:genMax]) do
-    if(options[:debug])
-      puts bestCanidate.inspect
-      puts currentGen
-    end
+	while(continue?(bestCanidate.fitness, threshold, currentGen, options)) do
+	    if(options[:debug])
+	    	puts 'Best Canidate Soultion:'
+	      puts bestCanidate.inspect
+        puts 'Current Generation:'
+	      puts currentGen
+	    end
 		# evaluate the population
 		population = eval.call(population)
 		if(options[:greaterBetter])
@@ -37,9 +43,16 @@ def runAlgorithm(initialPopulation, eval, threshold, options)
 			mates = selection(sortedPopulation.clone(), options[:selectionStyle])
 
 			# mate and replace
-			reaplaced = []
+			results = mateOrgs(mates[0], mates[1])
+			replaced = []
+      if(options[:elitism] > 0)
+        population = sortedPopulation
+        for i in 0...options[:elitism]
+          replaced.append(0)
+        end
+      end
 			for i in 0...results.size()
-				results[i].mutate() if Random.new.rand() < options[:mutation_percent]
+				results[i].mutate() if Random.new.rand() < options[:mutationPercent]
 				temp = Random.new.rand(population.size())
 				while(!replaced.includes?(temp)) do
 					temp = Random.new.rand(population.size())
@@ -52,42 +65,63 @@ def runAlgorithm(initialPopulation, eval, threshold, options)
 			needed = population.size()
 			have = 0
 			newPopulation = Array.new(population.size(), GeneticObject.new)
+      if(option[:elitism] > 0)
+        if(options[:greaterBetter])
+          sortedPopulation = population.sort{ |x , y| y.fitness <=> x.fitness }
+        else
+          sortedPopulation = population.sort{ |x , y| x.fitness <=> y.fitness }
+        end
+        for i in 0...options[:elitism]
+          newPopulation[i] = sortedPopulation[i]
+        end
+      end
 			while have < needed do
 				mates = selection(sortedPopulation.clone(), options[:selectionStyle])
 
 				# mate and put them into new pop
-				results = mates[0].mate(mates[1])
+				results = mateOrgs(mates[0], mates[1])
 				for i in 0...results.size()
-					results[i].mutate() if Random.new.rand() < options[:mutation_percent]
+					results[i].mutate() if Random.new.rand() < options[:mutationPercent]
 					newPopulation[have+i] = result[i] if (have+i) < needed
 				end
 				have += results.size()
 			end
 			population = newPopulation
 		end
+    # Increment generations
     currentGen += 1
 	end
 	return bestCanidate
 end
 
-def exceedThreshold(greaterBetter, val, threshold)
-  if(val == nil)
-    return false
-  end
+# Internal Logic
+
+def continue?(highestFitness, threshold, currentGen, options)
+	return false if exceedsThreshold?(options[:greaterBetter], highestFitness, threshold)
+	return false if currentGen > options[:maxGen]
+	return true
+end
+
+def exceedsThreshold?(greaterBetter, val, threshold)
+	if(val == nil)
+	return false
+	end
 	if(greaterBetter)
 		return val>=threshold
 	else
 		return val<=threshold
 	end
+	return false
 end
 
 def selection(population, type)
 	# select mates
 	if(type == 'tournament')
 		return tournamentSelection(population)
-	else
+	elsif(type == 'best')
 		return bestSelection(population)
 	end
+	raise 'Problem with selection type'
 end
 
 def tournamentSelection(population)
@@ -99,17 +133,39 @@ def bestSelection(population)
 	return population[0..1]
 end
 
-class GeneticObject
-	attr_accessor :fitness
+def mateOrgs(one, two)
+	return one.mate(two)
+end
 
-	def initialize()
-	end
+# Validation
 
-	def mutate()
-		raise 'Method Not Implemented'
-	end
+def validOptions(options, populationSize)
+	raise 'Required Option Missing' if !hasRequiredOptions(options)
+	raise 'Options Not Within Limits' if !withinLimits(options, populationSize)
+	return true
+end
 
-	def mate(other)
-		raise 'Meothd Not Implemented'
-	end
+def hasRequiredOptions(options)
+	return false if !options.has_key?(:greaterBetter)
+	return false if !options.has_key?(:totalPopReplace)
+	return false if !options.has_key?(:genMax)
+	return false if !options.has_key?(:mutation_percent)
+	return false if !options.has_key?(:debug)
+  return false if !options.has_key?(:elitism)
+	return true
+end
+
+def withinLimits(options, populationSize)
+	possibleGreaterBetter = [true, false]
+	possibleTotalPopReplace = [true, false]
+	possibleDebug = [true, false]
+	possibleSelectionStyle = ['tournament', 'best']
+	return false if !(possibleGreaterBetter.include?(options[:greaterBetter]))
+	return false if !(possibleTotalPopReplace.include?(options[:totalPopReplace]))
+	return false if !(options[:genMax]>0)
+	return false if !(possibleSelectionStyle.include?(options[:selectionStyle]))
+	return false if !(options[:mutationPercent]>0.0)
+	return false if !(possibleDebug.include?(options[:debug]))
+  return false if !(options[:elitism]>=0 && options[:elitism]<populationSize)
+	return true
 end

data/lib/genetic_object.rb

@@ -0,0 +1,14 @@
+class GeneticObject
+	attr_accessor :fitness
+
+	def initialize()
+	end
+
+	def mutate()
+		raise 'Method Not Implemented'
+	end
+
+	def mate(other)
+		raise 'Method Not Implemented'
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemetics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Huelsman
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gemetics.rb
+- lib/genetic_object.rb
 homepage: https://github.com/xLeachimx/Gemetics
 licenses:
 - MIT