goalseek 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 747c7855df771b99e8a14ae0d7dda32bda5216c4
+  data.tar.gz: 64351ed03ddb34be21d332a3eeaef5f60505e51c
+SHA512:
+  metadata.gz: 3a6def3a9b3e69033c550fbbe666de917335c53eab464ed94a0fea65b634cf8af2bb6be4de47294e76da6e2dfd8e4703dd2d95aadb29c671aee383858820e200
+  data.tar.gz: eca9ff2df3c75ce9b552cd9a0e71e5133ef45fc50d46b94654e5350fed2787a10dab7990f3acc452d3763ea2eb3796f1e62d2f08aa07eda8b676157f37f8a729

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in goalseek.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pascal Ehlert
+
+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.

data/README.md

@@ -0,0 +1,47 @@
+# GoalSeek
+
+This gem implements a method similar to Microsoft Excel's GoalSeek macro. According to Microsoft,
+GoalSeek uses a simple linear search:
+> The Goal Seek command uses a simple linear search beginning with guesses on the positive or negative side of the
+> value in the source cell (By Changing Cell). Excel uses the initial guesses and recalculates the formula.
+> Whichever guess brings the formula result closer to the targeted result (To Value) is the direction (positive or
+> negative) in which Goal Seek heads. If neither direction appears to approach the target value, Goal Seek makes
+> additional guesses that are further away from the source cell. After the direction is determined, Goal Seek uses
+> an iterative process in which the source cell is incremented or decremented at varying rates until the target value
+> is reached.
+
+Source: https://support.microsoft.com/en-us/help/100782/xl-method-used-by-goal-seek-to-find-a-solution
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'goalseek'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goalseek
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pehlert/goalseek.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "goalseek"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/goalseek.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "goalseek/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "goalseek"
+  spec.version       = GoalSeek::VERSION
+  spec.authors       = ["Pascal Ehlert"]
+  spec.email         = ["pascal@threerabbits.io"]
+
+  spec.summary       = %q{Ruby implementation of Microsoft Excel's GoalSeek macro.}
+  spec.description   = %q{Ruby implementation of Microsoft Excel's GoalSeek macro.
+                          Uses a simple linear bisection method.}
+  spec.homepage      = "https://github.com/pehlert/goalseek"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/goalseek.rb

@@ -0,0 +1,88 @@
+require 'goalseek/version'
+
+module GoalSeek
+  class InvalidBoundError < Exception
+  end
+
+  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/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: goalseek
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pascal Ehlert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Ruby implementation of Microsoft Excel's GoalSeek macro.
+                            Uses a simple linear bisection method.
+email:
+- pascal@threerabbits.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- goalseek.gemspec
+- lib/goalseek.rb
+- lib/goalseek/version.rb
+homepage: https://github.com/pehlert/goalseek
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of Microsoft Excel's GoalSeek macro.
+test_files: []