root_solver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 227787f9dc1cff91f3f087ecc9796f2f67bc830e
+  data.tar.gz: 8035c9da849472d0c254c43227f3b3463b8f2c75
+SHA512:
+  metadata.gz: 70379f6266ee4851b5d7d772802c04a71ffec46612be048d1ef2720e95ae89ddd4719471d78aefcad6d805c0e873a5db995866fb28a3dc8e6352e768326437e3
+  data.tar.gz: ab199994448de0733f164a000fba9fde331a9693d002d16a876f5585f5ec36b6a98bd6e332cd9c29fba103bac5a35ec314c925f2bf5fdd6c3ef806dcdf4d794f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sw?

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# RootSolver
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/root_solver`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'root_solver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install root_solver
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/root_solver.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "root_solver"
+
+# 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

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/lib/root_solver.rb

@@ -0,0 +1,105 @@
+require "root_solver/version"
+
+module RootSolver
+  class Newton
+    def initialize(f, x0 = 0, tol = 0.01, n = 10, eps = 0.001)
+      @f   = f
+      @x0  = x0
+      @tol = tol
+      @n   = n
+      @eps = eps
+    end
+
+    def solve(f = @f, x0 = @x0, tol = @tol, n = @n, eps = @eps)
+      y0 = f.call(x0)
+      y_prime = (f.call(x0 + eps) - y0) / eps
+
+      raise NonconvergenceError.new if y_prime.abs < tol
+
+      x = x0 - y0 / y_prime
+      y = f.call(x)
+      if y.abs < tol #successfully found root
+        x
+      elsif n <= 0 #solver not within threshold after n iterations.
+        x
+      else
+        solve(f, x, tol, n - 1, eps)
+      end
+    end
+
+  end
+
+  class Bisection
+    def initialize(f, low, high, tol = 0.01, n = 10)
+      @f    = f
+      @tol  = tol
+      @n    = n
+      @high = high
+      @low  = low
+    end
+
+    def solve(f = @f, low = @low, high = @high, tol = @tol, n = @n)
+      x = (high + low) / 2
+      y = f.call(x)
+
+      if y.abs < tol #successfully found root
+        x
+      elsif n <= 0 #break out of solver after so many iterations
+        x
+      elsif x_converge?(low, high, tol) && !crossing?(f, low, high)
+        raise NoRootError.new
+      else #narrow window of searching by half
+        if y > 0
+          high = x
+        else
+          low = x
+        end
+        solve(f, low, high, tol, n - 1)
+      end
+    end
+
+    private
+
+    #root is between the high and low
+    def crossing?(f, low, high)
+      f.call(low) * f.call(high)  <= 0
+    end
+
+    #high and low are approximately equivalent
+    def x_converge?(low, high, tol)
+      high - low < tol
+    end
+
+  end
+
+  class BisectionNewton
+    def initialize(f, low, high, tol = 0.1, n = 5)
+      @f    = f
+      @tol  = tol
+      @n    = n
+      @high = high
+      @low  = low
+    end
+
+    def solve
+      x1 = RootSolver::Bisection.new(@f, @low, @high, @tol, @n).solve
+      RootSolver::Newton.new(@f, x1, @tol).solve
+    end
+  end
+
+  class Error < RuntimeError
+  end
+
+  class NoRootError < Error
+    def initialize(msg = "Root not found.")
+      super
+    end
+  end
+
+  class NonconvergenceError < Error
+    def initialize(msg = "Solver not converging.")
+      super
+    end
+  end
+
+end

data/lib/root_solver/version.rb

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

data/root_solver.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'root_solver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "root_solver"
+  spec.version       = RootSolver::VERSION
+  spec.authors       = ["Lindsay Hannon"]
+  spec.email         = ["lindsay@teamairship.com"]
+
+  spec.summary       = %q{ A root-solver that uses bisection then newton's method to approximate a function's root }
+  spec.description   = %q{ Newton's method works best when you have a reasonable first guess, while bisection is a
+                           better choice when your first guess may be far away (or near a zero slope). }
+  spec.homepage      = "https://github.com/teamairship/root_solver"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: root_solver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lindsay Hannon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: " Newton's method works best when you have a reasonable first guess,
+  while bisection is a\n                           better choice when your first guess
+  may be far away (or near a zero slope). "
+email:
+- lindsay@teamairship.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/root_solver.rb
+- lib/root_solver/version.rb
+- root_solver.gemspec
+homepage: https://github.com/teamairship/root_solver
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: A root-solver that uses bisection then newton's method to approximate a function's
+  root
+test_files: []