metaheuristic_algorithms 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0f703767effd3bf49ad6f0fdb937e81f4cca0b
-  data.tar.gz: 2b006e39389d9ab0cf870de9178150f956bd948e
+  metadata.gz: bc5353994d45d2635304aa9b75be715238dc7b81
+  data.tar.gz: 5e560ac1a8f7d7b7df2f2204fec271b9abd6020d
 SHA512:
-  metadata.gz: 3128ccca278336b88d59a1dff1e91f6e087b038693ffc8a7da83a24c64e5afe42aa5a98a809586ccdb0460a35ddebea172254df017757eb7756cbf0ee6dda579
-  data.tar.gz: 3cc1be0fa3cb7093f7615fc4abfd0b182c0f906f9979d4025bf1370fbf9b290d70973fc6d13d70e1be4505d671782e2526e583d95dba5d8db488e20718727afe
+  metadata.gz: 546683c005f556c3e094c54dba1a5f647715f66e7a09216490caf3d216b59409d623831f2339b482fd6132042b03812d4f6159f017ad51ba1c8618fa37d1f03a
+  data.tar.gz: 8f4f50276ea362c49369025a6e68c0cd0f2259d2d50360d34f25e7a0b33ea5a6f7a30ab0ba8f2bcba04cecaabc00cd817ba02f7dab11f8ca847fa12490171f1e

data/README.md

@@ -20,7 +20,62 @@ Or install it yourself as:
 
 ## Usage
 
-See examples in RSpec codes under spec directory. 
+Step 1. Create a Function Wrapper for your objective function by extending MetaheuristicAlgorithms::FunctionWrappers::AbstractWrapper
+
+   Example: Rosenbrook's Function: f(x,y) = (1 - x)^2 + 100(y - x^2)^2
+
+```ruby
+   require 'metaheuristic_algorithms'
+
+   class RosenbrookFunctionWrapper < MetaheuristicAlgorithms::FunctionWrappers::AbstractWrapper
+
+      def maximum_decision_variable_values
+        [BigDecimal('5'), BigDecimal('5')]
+      end
+
+      def miminum_decision_variable_values
+        [BigDecimal('-5'), BigDecimal('-5')]
+      end
+
+      def objective_function_value(decision_variable_values)
+        (BigDecimal('1') - decision_variable_values[0]).power(2) + BigDecimal('100') * (decision_variable_values[1] - decision_variable_values[0].power(2)).power(2)
+      end
+
+      # For the algorithm that requires initial estimate that is depending on the particular objective function:
+      def initial_decision_variable_value_estimates
+        [BigDecimal('2'), BigDecimal('2')]
+      end
+
+    end
+```
+
+Step 2. Instantiate the created Function Wrapper and pass it as the first argument of the Algorithm instantiation. 
+        Also specify the number of variables and objective (:maximization or :minimization)
+        Then call the search method passing the algorithm specific parameters. 
+
+   Example: Harmony Search for the glocal minimum value for Rosenbrook's Function
+
+```ruby
+   require 'metaheuristic_algorithms'
+
+   rosenbrook_function_wrapper = MetaheuristicAlgorithms::FunctionWrappers::RosenbrookFunctionWrapper.new
+
+   harmony_search = MetaheuristicAlgorithms::HarmonySearch.new(rosenbrook_function_wrapper, number_of_variables: 2, objective: :minimization)
+
+   maximum_attempt = 25000
+   pitch_adjusting_range = BigDecimal('100')
+   harmony_search_size = 20
+   harmony_memory_acceping_rate = BigDecimal('0.95')
+   pitch_adjusting_rate = BigDecimal('0.7')    
+
+   result = harmony_search.search(maximum_attempt: maximum_attempt, pitch_adjusting_range: pitch_adjusting_range, 
+                                  harmony_search_size: harmony_search_size, harmony_memory_acceping_rate: harmony_memory_acceping_rate, 
+                                  pitch_adjusting_rate: pitch_adjusting_rate)
+
+   puts result[:best_decision_variable_values][0] # x value: Example: BigDecimal('1.0112')
+   puts result[:best_decision_variable_values][1] # y value: Example: BigDecimal('0.9988')
+   puts result[:best_objective_function_value]    # f(x,y) value: Example: BigDecimal('0.0563')    
+```
 
 ## Development
 

data/lib/metaheuristic_algorithms/version.rb

@@ -1,3 +1,3 @@
 module MetaheuristicAlgorithms
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metaheuristic_algorithms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tadatoshi Takahashi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-08 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: distribution