evosynth 0.1.0

data/lib/evosynth/core/individual.rb

@@ -0,0 +1,92 @@
+#	Copyright (c) 2009, 2010 Yves Adler <yves.adler@googlemail.com>
+#
+#	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.
+
+
+module EvoSynth
+
+	# Base class for individuals
+
+	class Individual
+		include Comparable
+
+		# Genome of the Individual, it should provide a changed attribute
+
+		attr_accessor :genome
+
+		# Returns the fitness of this individual
+
+		attr_reader :fitness
+
+		# Sets the fitness value of this individual, also sets genome.changed to true.
+
+		def fitness=(value)
+			@fitness = value
+			@genome.changed = false
+		end
+
+		# Returns true, if this individual (most of the time its genome) has changed. Otherwise it
+		# will return false.
+
+		def changed?
+			@genome.changed?
+		end
+
+		# Clones and returns a individual and its genome (deep copy).
+
+		def deep_clone
+			my_clone = self.clone
+			my_clone.genome = Marshal.load( Marshal.dump( self.genome ) )
+			my_clone
+		end
+
+		# If you compare individuals the semantic of "<=>" is the following:
+		#
+		#	a > b  -> individual a is a better solution than individual b
+		#	a < b  -> individual b is a better solution than individual a
+		#	a == b -> a and b have a equal fitness value
+
+		def <=>(another)
+			compare_fitness_values(fitness, another.fitness)
+		end
+
+		# Should be implemented by subclasses
+
+		def compare_fitness_values(one, two)
+			raise NotImplementedError, "please implement compare_fitness_values!"
+		end
+
+		# Returns wether this Individual needs to be minimized.
+
+		def minimizes?
+			compare_fitness_values(1,0) < 0
+		end
+
+		# Returns wether this Individual needs to be maximized.
+
+		def maximizes?
+			compare_fitness_values(1,0) > 0
+		end
+
+	end
+
+end

data/lib/evosynth/core/maximizing_individual.rb

@@ -0,0 +1,71 @@
+#	Copyright (c) 2009, 2010 Yves Adler <yves.adler@googlemail.com>
+#
+#	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.
+
+
+module EvoSynth
+
+	# Basic individual for maximizing problems
+
+	class MaximizingIndividual < Individual
+
+		#	:call-seq:
+		#		MaximizingIndividual.new -> MaximizingIndividual
+		#		MaximizingIndividual.new(genome) -> MaximizingIndividual (with given genome)
+		#
+		# Returns a new MaximizingIndividual. In the first form, the genome is nil. In the second it
+		# creates a MaximizingIndividual with the given genome.
+		#
+		#     EvoSynth::MaximizingIndividual.new
+		#     EvoSynth::MaximizingIndividual.new( EvoSynth::ArrayGenome.new(10) { EvoSynth.rand_bool } )
+
+		def initialize(genome = nil)
+			super()
+			@genome = genome
+			@fitness = Float::MIN
+		end
+
+		#	:call-seq:
+		#		compare_fitness_values(one, two) -> Number
+		#
+		# Compares two fitness values for maximizing problems. It uses the <=> of the given
+		# fitness values.
+
+		def compare_fitness_values(one, two)
+			one <=> two
+		end
+
+		#	:call-seq:
+		#		to_s -> string
+		#
+		# Returns description of this individual
+		#
+		#     i = EvoSynth::MaximizingIndividual.new
+		#     i.to_s                                     #=> "maximizing individual <fitness = 2.2250738585072e-308, genome = [nil]>"
+
+		def to_s
+			"maximizing individual <fitness = #{fitness}, genome = [#{genome}]>"
+		end
+
+	end
+
+end

data/lib/evosynth/core/minimizing_individual.rb

@@ -0,0 +1,71 @@
+#	Copyright (c) 2009, 2010 Yves Adler <yves.adler@googlemail.com>
+#
+#	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.
+
+
+module EvoSynth
+
+	# Basic individual for for minimizing problems
+
+	class MinimizingIndividual < Individual
+
+		#	:call-seq:
+		#		MinimizingIndividual.new -> MinimizingIndividual
+		#		MinimizingIndividual.new(genome) -> MinimizingIndividual (with given genome)
+		#
+		# Returns a new MinimizingIndividual. In the first form, the genome is nil. In the second it
+		# creates a MinimizingIndividual with the given genome.
+		#
+		#     EvoSynth::MinimizingIndividual.new
+		#     EvoSynth::MinimizingIndividual.new( EvoSynth::ArrayGenome.new(10) { EvoSynth.rand_bool } )
+
+		def initialize(genome = nil)
+			super()
+			@genome = genome
+			@fitness = Float::MAX
+		end
+
+		#	:call-seq:
+		#		compare_fitness_values(one, two) -> Number
+		#
+		# Compares two fitness values for minimizing problems. It uses the <=> of the given
+		# fitness values and inverts the result.
+
+		def compare_fitness_values(one, two)
+			-1 * (one <=> two)
+		end
+
+		#	:call-seq:
+		#		to_s -> string
+		#
+		# Returns description of this individual
+		#
+		#     i = EvoSynth::MinimizingIndividual.new
+		#     i.to_s                                     #=> "minimizing individual <fitness = 1.79769313486232e+308, genome = [nil]>"
+
+		def to_s
+			"minimizing individual <fitness = #{fitness}, genome = [#{genome}]>"
+		end
+
+	end
+
+end

data/lib/evosynth/core/population.rb

@@ -0,0 +1,120 @@
+#	Copyright (c) 2009, 2010 Yves Adler <yves.adler@googlemail.com>
+#
+#	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.
+
+
+module EvoSynth
+
+	# This class is used to create and maintain a population. In this case a population
+	# is simply a Array of individuals that keeps track of changes.
+
+	class Population <  EvoSynth::ArrayGenome
+
+		#	:call-seq:
+		#		Population.new -> Population
+		#		Population.new(size) -> Population (with given size)
+		#		Population.new(size) { block } -> Population (with given size and block to intialize each individual)
+		#
+		# Creates a population
+
+		def initialize(*args)
+			super(*args)
+			self.map! { |individual| yield } if block_given?
+		end
+
+		# Returns a clone of the population (deep_clone)
+
+		def deep_clone
+			my_clone = self.clone
+			self.each_index { |index| my_clone[index] = self[index].deep_clone }
+			my_clone
+		end
+
+		# Adds a individual to the population.
+
+		def add(individual)
+			self << individual
+		end
+
+		# Removes a give individual (first occurence) from the population.
+
+		def remove(individual)
+			# FIXME: this is a rather ugly hack
+			# -> should be replaced with a cool 1.9 function
+
+			found = nil
+			self.each_index do |index|
+				if self[index] == individual
+					found = index
+					break
+				end
+			end
+
+			self.delete_at(found) if found != nil
+		end
+
+
+		#	:call-seq:
+		#		p = Population.new
+		#		p.best					#=> Returns the best individual
+		#		p.best(3)				#=> Returns the 3 best individuals
+		#
+		# Returns the best N individuals (by comparing with <=>) of the population.
+
+		def best(count = 1)
+			self.sort! if self.changed?
+			self.changed = false
+			count == 1 ? self.last : self.last(count).reverse
+		end
+
+		#	:call-seq:
+		#		p = Population.new
+		#		p.worst					#=> Returns the worst individual
+		#		p.worst(3)				#=> Returns the 3 worst individuals
+		#
+		# Returns the worst N individuals (by comparing with <=>) of the population.
+
+		def worst(count = 1)
+			self.sort! if self.changed?
+			self.changed = false
+			count == 1 ? self.first : self.first(count).reverse
+		end
+
+		#	:call-seq:
+		#		to_s -> string
+		#
+		# Returns description of this individual
+		#
+		#		p = Population.new
+		#		p.to_s					#=> "Population <size=0>"
+
+		def to_s
+			begin
+				"Population <size=#{self.size}, best.fitness=#{best.fitness}, worst.fitness=#{worst.fitness}>"
+			rescue
+				"Population <size=#{self.size}>"
+			end
+		end
+
+	end
+
+end

data/lib/evosynth/core/profile.rb

@@ -0,0 +1,110 @@
+#	Copyright (c) 2009, 2010 Yves Adler <yves.adler@googlemail.com>
+#
+#	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.
+
+
+module EvoSynth
+
+	# This class is used to create and maintain a evolver profile. Basically a Profile can be seen
+	# as a dynamic Hash, where values can be added and removed at will.
+
+	class Profile
+
+		# Creates a new Profile using a given hash of symbols and values.
+		# 
+		# usage:
+		#
+		#    profile = EvoSynth::Profile.new(
+		#        :individual      => MaxOnes.create_individual,
+		#        :population      => EvoSynth::Population.new(POP_SIZE) { MaxOnes.create_individual },
+		#        :evaluator       => MaxOnes::MaxOnesEvaluator.new,
+		#        :mutation        => EvoSynth::Mutations::BinaryMutation.new(EvoSynth::Mutations::Functions::FLIP_BOOLEAN)
+		#    )
+
+		def initialize(*properties)
+			@properties = {}
+
+			properties.each do |property|
+				if property.is_a?(Symbol)
+					add_symbol(property, nil)
+				elsif property.is_a?(Hash)
+					add_hash(property)
+				else
+					raise ArgumentError, "argument type not supported"
+				end
+			end
+		end
+
+		# Used to dynamically add key/value pairs.
+		#
+		#    p = EvoSynth::Profile.new
+		#    p.foo                        #=> raises ArgumentError
+		#    p.foo = "bar"                #=> adds key 'foo' to p and sets its value to 'bar'
+		#    p.foo                        #=> 'bar'
+
+		def method_missing(method_name, *args)
+			if method_name[-1] == "="
+				args = args[0] if args.size == 1
+				add_symbol(method_name[0..method_name.size-2].to_sym, args)
+			else
+				raise ArgumentError.new("Profile does not contain a value for '#{method_name}'.") unless @properties.has_key?(method_name)
+				@properties[method_name]
+			end
+		end
+
+		#	:call-seq:
+		#		delete(key) -> nil or key
+		#
+		# Removes a given key from the profile. Returns the key if it was member of the profile, nil otherwise.
+		#
+		#    p = EvoSynth::Profile.new
+		#    p.foo = "bar"                    #=> adds key 'foo' to p and sets its value to 'bar'
+		#    p.delete(:foo)                   #=> 'bar'
+		#    p.foo                            #=> raises ArgumentError
+
+		def delete(key)
+			@properties.delete(key)
+		end
+
+		# Return a printable version of the profile.
+
+		def to_s
+			"evolver profile <#{@properties.to_s}>"
+		end
+
+		private
+
+		# Adds a given symbol as key to the internal Hash and sets the value to the given value.
+
+		def add_symbol(symbol, value)
+			@properties[symbol] = value
+		end
+
+		# Add a given hash to the internal hash.
+
+		def add_hash(hash)
+			hash.each_pair { |key, default_value| @properties[key] = default_value }
+		end
+
+	end
+
+end