rical 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1ce7f2b2a92c5a7b58a2328a98fcabfdc447efa
+  data.tar.gz: a26b4642e560f673200ed22f2e5d20de2dceb517
+SHA512:
+  metadata.gz: 4957d9249119585429d3c9ea2e331a73613898d50b2691c2d7dcb7b47ed55863526c8b295424296ccc5c901dbeb06d5d612fb956968239df7276b2a7016affec
+  data.tar.gz: 10a861d8159996d6dd080f69d549c03a8ed42bc2e8206fa511986c64df9fd24a3d34cf347b6042c32e52fe7b854a134989321e82931d55a188b5e6dceb0380e2

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.swo
+*~

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Luis Bacelar
+
+MIT License
+
+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,97 @@
+# **RICAL**
+### **R**oot and **I**nverse **CAL**culator
+
+Using Newton-Raphson or Secant methods, and within an arbitrary error:
+
+* Computes the values of a root of an arbitrary function _f(x)_
+* Computes the value of inverse function _f<sup>-1</sup>(y) = x_ at point _y_
+
+The Newton-Raphson requires:
+
+* one "close enough" estimate - _x<sub>0</sub>_ - of the root or inverse value
+* the derivative function _f'(x)_
+
+The Secant method requires:
+
+* two "close enough" estimates - _x<sub>0</sub>_, _x<sub>1</sub>_ - of the root or inverse value
+
+If the estimates are not "close enough" (and what that means depends on _f(x)_), the methods may not converge to a solution.
+This may also happen for a "low" number of iterations and/or a "low" error limit.
+When no convergence is possible on the set conditions, a **`NoConvergenceError`** is raised.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rical'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rical
+
+
+## Usage examples
+
+1. Set function(s) as lambdas
+
+```ruby
+fx  = -> (x) { x**2 - 1 }
+dfx = -> (x) { 2*x }
+```
+
+or set function(s) as Proc
+
+```ruby
+fx = Proc.new do |x|
+  x**2 - 1
+end
+```
+
+or set function(s) as existing method(s)
+
+```ruby
+def f(x)
+  x**2 - 1
+end
+
+fx = method(:f)
+```
+
+2. Call `root_for` of `inverse_for` passing function(s) and estimate(s):
+
+**Newton-Raphson's Method**
+
+```ruby
+Rical.root_for f: fx, df: dfx, x0: 1.0, method: :newtonr_raphson    # :newton_raphson aliased to :n, :newton
+Rical.inverse_for f: fx, df: dfx, x0: 1.0, y: 2.0, method: :newton
+```
+
+**Secant's Method**
+
+```ruby
+Rical.root_for f: fx, x0: 0.0, x1: 1.0, method: :secant              # :secant aliased to :sec, :s
+Rical.inverse_for f: fx, x0: 0.0, x1: 1.0, y: 2.0, method: :secant
+```
+
+3. Change number of iterations - _num_ - or maximum allowable error - _err_ - if needed:
+
+```ruby
+Rical.root_for f: fx, ......, num: 1e3, err: 1e-12      # defaults num: 100, err: 1e-6
+Rical.inverse_for f: fx, ......, num: 1e3, err: 1e-12   # defaults num: 100, err: 1e-6
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rical/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/rical.rb

@@ -0,0 +1,49 @@
+require 'rical/version'
+require 'rical/errors'
+
+module Rical
+  extend self
+
+  def root_for f:, df: nil, x0: 0.0, x1: 1.0, method:, num: 100, err: 1e-6
+    raise ArgumentError, 'f must respond_to call'    unless f.respond_to? :call
+
+    case method
+    when :n, :newton, :newton_raphson
+      raise ArgumentError, 'df is required'          unless df
+      raise ArgumentError, 'df must respond_to call' unless df.respond_to? :call
+      newton_raphson_root_for f, df, Float(x0), num, err
+    when :s, :sec, :secant
+      secant_root_for f, Float(x0), Float(x1), num, err
+    else
+      raise ArgumentError, 'unexpected method (allowed :newton, :secant)'
+    end
+  end
+
+  def inverse_for f:, y: 0.0, **args
+    f_1= -> (x) { f.call(x) - Float(y) }
+    root_for f: f_1, **args
+  end
+  alias_method :inv_for, :inverse_for
+
+private
+  def newton_raphson_root_for f, df, x, n, err
+    n.times do
+      dfx = df.call x
+      dfx = [1e-3, err * 1e3].max if dfx == 0.0
+      x = x - ( f.call(x) / dfx )
+      return x if f.call(x).abs < err
+    end
+    raise NoConvergenceError
+  end
+
+  def secant_root_for f, x0, x1, n, err
+    n.times do
+      delta = f.call(x1) - f.call(x0)
+      delta = [1e-3, err * 1e3].max if delta == 0.0
+      x = x1 - (f.call(x1) * (x1 - x0)) / delta
+      return x if f.call(x).abs < err
+      x0, x1 = x1, x
+    end
+    raise NoConvergenceError
+  end
+end

data/lib/rical/errors.rb

@@ -0,0 +1,4 @@
+module Rical
+  class NoConvergenceError < StandardError
+  end
+end

data/lib/rical/version.rb

@@ -0,0 +1,3 @@
+module Rical
+  VERSION = '1.0.0'
+end

data/rical.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rical/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rical'
+  spec.version       = Rical::VERSION
+  spec.authors       = ['Luis Bacelar']
+  spec.email         = ['lmbacelar@gmail.com']
+  spec.summary       = %q{Computes roots and x value for given y for arbitrary math f(x)=y}
+  spec.description   = <<-DESCRIPTION
+Computes approximation within a given error_limit to the values of a root of an arbitrary function f(x) or to the value of inverse function g(y) = x.
+Uses Newton-Raphson or Secant methods.
+Requires one (Newton-Raphson) or two (Secant) estimates of the target value.
+Raises NoConvergenceError when it does not converge within the set error_limit, on set number of iterations.
+DESCRIPTION
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/spec/rical_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Rical do
+  f  = -> (x) { x**2 - 2 }
+  df = -> (x) { 2*x }
+
+  context 'Newton-Raphson method' do
+    context 'root computation' do
+      it 'yields +√2 for f(x) = x²-2' do
+        expect(Rical.root_for f: f, df: df, x0: 10, method: :newton).to be_within(1e-6).of(2**0.5)
+      end
+
+      it 'yields -√2 for f(x) = x²-2' do
+        expect(Rical.root_for f: f, df: df, x0: -10, method: :newton).to be_within(1e-6).of(-2**0.5)
+      end
+
+      it 'rescues when df(x0) = 0' do
+        expect(Rical.root_for f: f, df: df, x0: 0.0, method: :newton).to be_within(1e-6).of(2**0.5)
+      end
+    end
+
+    context 'inverse computation' do
+      it 'yields +2.0 for y=2, f(x)=y=x²-2' do
+        expect(Rical.inverse_for f: f, df: df, y: 2, x0: 0, method: :newton).to be_within(1e-6).of(2.0)
+      end
+    end
+
+  end
+
+  context 'Secant method' do
+    context 'root computation' do
+      it 'yields +√2 for f(x) = x²-2' do
+        expect(Rical.root_for f: f, x0: 10, x1: 9, method: :secant).to be_within(1e-6).of(2**0.5)
+      end
+
+      it 'yields -√2 for f(x) = x²-2' do
+        expect(Rical.root_for f: f, x0: -10, x1: -9, method: :secant).to be_within(1e-6).of(-2**0.5)
+      end
+
+      it 'rescues when f(x1) - f(x0) = 0' do
+        # converges but to either one of the roots
+        expect(Rical.root_for(f: f, x0: 9, x1: -9, method: :secant).abs).to be_within(1e-6).of(2**0.5)
+      end
+    end
+
+    context 'inverse computation' do
+      it 'yields +2.0 for y=2, f(x)=y=x²-2' do
+        expect(Rical.inverse_for f: f, y: 2, x0: 0, x1: 1, method: :secant).to be_within(1e-6).of(2.0)
+      end
+    end
+  end
+
+  context 'error handling' do
+    it 'raises ArgumentError when f is not callable' do
+      expect{ Rical.root_for f: :dummy, df: df, method: :newton  }.to raise_error ArgumentError
+      expect{ Rical.root_for f: :dummy, x0: 0, x1: 1, method: :secant }.to raise_error ArgumentError
+    end
+
+    it 'raises ArgumentError when no df given and method is Newton-Raphson' do
+      expect{ Rical.root_for f: f, method: :newton    }.to raise_error ArgumentError
+      expect{ Rical.inverse_for f: f, method: :newton }.to raise_error ArgumentError
+    end
+
+    it 'raises ArgumentError when df is not callable and method is Newton-Raphson' do
+      expect{ Rical.root_for f: f, df: :dummy, method: :newton }.to raise_error ArgumentError
+    end
+
+    it 'raises NoConvergenceError when Newton-Raphson does not converge' do
+      expect{ Rical.root_for f: f, df: df, x0: 1e32, method: :newton, num: 10 
+      }.to raise_error Rical::NoConvergenceError
+    end
+
+    it 'raises NoConvergenceError when Secant does not converge' do
+      expect{ Rical.root_for f: f, x0: 1e32, x1: 1.1e32, method: :secant, num: 10 
+      }.to raise_error Rical::NoConvergenceError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rical'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rical
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Luis Bacelar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Computes approximation within a given error_limit to the values of a root of an arbitrary function f(x) or to the value of inverse function g(y) = x.
+  Uses Newton-Raphson or Secant methods.
+  Requires one (Newton-Raphson) or two (Secant) estimates of the target value.
+  Raises NoConvergenceError when it does not converge within the set error_limit, on set number of iterations.
+email:
+- lmbacelar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rical.rb
+- lib/rical/errors.rb
+- lib/rical/version.rb
+- rical.gemspec
+- spec/rical_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Computes roots and x value for given y for arbitrary math f(x)=y
+test_files:
+- spec/rical_spec.rb
+- spec/spec_helper.rb