goalseek 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 747c7855df771b99e8a14ae0d7dda32bda5216c4
-  data.tar.gz: 64351ed03ddb34be21d332a3eeaef5f60505e51c
+  metadata.gz: ef1c7fc4ff85d9cb3a5033fa6f9b18c856f60bd5
+  data.tar.gz: f7e85129e6e10ddc37b0e67c56dec035503922e1
 SHA512:
-  metadata.gz: 3a6def3a9b3e69033c550fbbe666de917335c53eab464ed94a0fea65b634cf8af2bb6be4de47294e76da6e2dfd8e4703dd2d95aadb29c671aee383858820e200
-  data.tar.gz: eca9ff2df3c75ce9b552cd9a0e71e5133ef45fc50d46b94654e5350fed2787a10dab7990f3acc452d3763ea2eb3796f1e62d2f08aa07eda8b676157f37f8a729
+  metadata.gz: 68a6ac63ae127ec11ac432ef84f4ee67cf5d99b45c48c70c28effc703d4fdd49f2cfbffe9931201f8fa7e6f5bd44d9d407d9a8cbae5535a985b22b09f5f7dabe
+  data.tar.gz: db959a50069beae15e00a9c8cd633b630894f136e9fd8f8ffaad25ad2f5b6e29209fc7c94c55f29a4b69a503638b7c9fa2819ddc6e79856e11df53fe2696c00b

data/README.md

@@ -30,7 +30,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This is a simple example of a linear search on a qubic function.
+
+Bounds are automatically determined if they are within -10^10 to 10^10. Iterations are limited to 1000 by default.
+
+```ruby
+begin
+    goalseeker = GoalSeek::LinearSearch.new(Proc.new() { |x| x ** 3 });
+    result = goalseeker.seek(27) # returns 3.0
+rescue GoalSeek::InvalidBoundError
+    puts "Function does not cross target value within interval (-10^10, 10^10)"
+rescue GoalSeek::InvalidFunctionError
+    puts "Provided block is not callable" 
+end
+```
+
+For more examples, please have a look at the specs.
 
 ## Development
 

data/lib/goalseek.rb

@@ -1,4 +1,5 @@
 require 'goalseek/version'
+require 'goalseek/linear_search'
 
 module GoalSeek
   class InvalidBoundError < Exception
@@ -6,83 +7,4 @@ module GoalSeek
 
   class InvalidFunctionError < Exception
   end
-
-  class GoalSeek
-
-    # block is an f(x) function
-    def initialize(f)
-      @f = f
-    end
-
-    def seek(goal, options = {})
-      @goal = goal.to_f
-
-      options = {
-        tolerance: 0,
-        max_iterations: 1000
-      }.merge(options)
-
-      min_max = get_min_max(options[:lower_bound], options[:upper_bound])
-      lower, upper = min_max[0], min_max[1]
-
-      iterate(lower, upper, options[:tolerance], options[:max_iterations])
-    end
-
-    def iterate(lower, upper, tolerance, max_iterations, iterations = 1)
-      new_bound = (lower + upper) / 2
-
-      begin
-        new_value = @f.call(new_bound)
-      rescue NoMethodError
-        raise InvalidFunctionError
-      end
-
-      if iterations == max_iterations || new_value === @goal
-        return new_bound
-      elsif new_value < @goal
-        return iterate(new_bound, upper, tolerance, max_iterations, iterations + 1)
-      elsif new_value > @goal
-        return iterate(lower, new_bound, tolerance, max_iterations, iterations + 1)
-      end
-    end
-
-    def get_min_max(a, b)
-      x = nil, y = nil
-
-      # Use given bounds if present
-      if a && b
-        x = a.to_f
-        y = b.to_f
-
-        if check_bounds(x, y)
-          [x, y]
-        elsif check_bounds(y, x)
-          [y, x]
-        else
-          raise InvalidBoundError
-        end
-      end
-
-      # Try exponential bound expansion from 0 to 10^10
-      (0..10).each do |i|
-        if check_bounds(0.0, 10.0 ** i)
-          return [0.0, 10.0 ** i]
-        end
-      end
-
-      # Try exponential bound expansion from -x to x
-      (0..10).each do |i|
-        if check_bounds(-10.0 ** i, 10.0 ** i)
-          return [-10.0 ** i, 10.0 ** i]
-        end
-      end
-
-      # Fall back to raising if no working bound could be found
-      raise InvalidBoundError
-    end
-
-    def check_bounds(x, y)
-      (@f.call(x) < @goal) && (@f.call(y) > @goal) || (@f.call(y) < @goal) && (@f.call(x) > @goal)
-    end
-  end
 end

data/lib/goalseek/linear_search.rb

@@ -0,0 +1,77 @@
+module GoalSeek
+  class LinearSearch
+    # block is an f(x) function
+    def initialize(f)
+      @f = f
+    end
+
+    def seek(goal, options = {})
+      @goal = goal.to_f
+
+      options = {
+          tolerance: 0,
+          max_iterations: 1000
+      }.merge(options)
+
+      min_max = get_min_max(options[:lower_bound], options[:upper_bound])
+      lower, upper = min_max[0], min_max[1]
+
+      iterate(lower, upper, options[:tolerance], options[:max_iterations])
+    end
+
+    def iterate(lower, upper, tolerance, max_iterations, iterations = 1)
+      new_bound = (lower + upper) / 2
+
+      begin
+        new_value = @f.call(new_bound)
+      rescue NoMethodError
+        raise InvalidFunctionError
+      end
+
+      if iterations == max_iterations || new_value === @goal
+        return new_bound
+      elsif new_value < @goal
+        return iterate(new_bound, upper, tolerance, max_iterations, iterations + 1)
+      elsif new_value > @goal
+        return iterate(lower, new_bound, tolerance, max_iterations, iterations + 1)
+      end
+    end
+
+    def get_min_max(a, b)
+      # Use given bounds if present
+      if a && b
+        x = a.to_f
+        y = b.to_f
+
+        if check_bounds(x, y)
+          [x, y]
+        elsif check_bounds(y, x)
+          [y, x]
+        else
+          raise InvalidBoundError
+        end
+      end
+
+      # Try exponential bound expansion from 0 to 10^10
+      (0..10).each do |i|
+        if check_bounds(0.0, 10.0 ** i)
+          return [0.0, 10.0 ** i]
+        end
+      end
+
+      # Try exponential bound expansion from -x to x
+      (0..10).each do |i|
+        if check_bounds(-10.0 ** i, 10.0 ** i)
+          return [-10.0 ** i, 10.0 ** i]
+        end
+      end
+
+      # Fall back to raising if no working bound could be found
+      raise InvalidBoundError
+    end
+
+    def check_bounds(x, y)
+      (@f.call(x) < @goal) && (@f.call(y) > @goal) || (@f.call(y) < @goal) && (@f.call(x) > @goal)
+    end
+  end
+end

data/lib/goalseek/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goalseek
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pascal Ehlert
@@ -72,6 +72,7 @@ files:
 - bin/setup
 - goalseek.gemspec
 - lib/goalseek.rb
+- lib/goalseek/linear_search.rb
 - lib/goalseek/version.rb
 homepage: https://github.com/pehlert/goalseek
 licenses: