spliner 1.0.2 → 1.0.3

data/.travis.yml

@@ -2,3 +2,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - jruby
+  - rbx-19mode
+  - ruby-head
+
+

data/README.markdown

@@ -22,23 +22,27 @@ Quick Start
     require 'spliner'
 
     # Initialize a spline interpolation with x range 0.0..2.0
-    my_spline = Spliner::Spliner.new({0.0 => 0.0, 1.0 => 1.0, 2.0 => 0.5})
+    my_spline = Spliner::Spliner.new [0.0, 1.0, 2.0], [0.0, 1.0, 2.0]
 
-    # Perform interpolation on 31 values ranging from 0..2.0
-    x_values = (0..30).map {|x| x / 30.0 * 2.0 }
-    y_values = x_values.map {|x| my_spline[x] }
+    # Interpolate for a single value
+    y1 = my_spline[0.5]
 
+    # Perform interpolation on 11 values ranging from 0..2.0
+    y_values = my_spline[(0.0..2.0).step(0.1)]
+
+    # You may prefer to use the shortcut class method
+    y2 = Spliner::Spliner[[0.0, 1.0, 2.0], [0.0, 1.0, 0.5], 0.5]
 
     # perform extrapolation outside key points using linear Y = aX + b
-    ex_spline = Spliner::Spliner.new({0.0 => 0.0, 1.0 => 1.0, 2.0 => 0.5}, :extrapolate => '10%')
+    ex_spline = Spliner::Spliner.new [0.0, 1.0, 2.0], [0.0, 1.0, 2.0], :extrapolate => '10%'
     xx = ex_spline[2.1] # returns 0.4124999999999999
 
     # perform extrapolation outside key points using linear Y = aX + b
-    ex_spline = Spliner::Spliner.new({0.0 => 0.0, 1.0 => 1.0, 2.0 => 0.5}, :extrapolate => '10%', :emethod => :hold)
+    ex_spline = Spliner::Spliner.new [0.0, 1.0, 2.0], [0.0, 1.0, 2.0], :extrapolate => '10%', :emethod => :hold)
     xx = ex_spline[2.1] # returns 0.5
 
-    # Alternative intialization using X and Y arrays
-    ar_spline = Spliner::Spliner.new [1.0, 2.0, 3.0], [0.0, 3.0, 1.0]
+    # Alternative intialization using Hash
+    ar_spline = Spliner::Spliner.new({1.0 => 0.0, 2.0 => 3.0, 3.0 => 1.0})
 
     # When duplicate X values are encountered, two or more discontinuous curves are used
     two_spline = Spliner::Spliner.new [1.0, 2.0, 2.0, 3.0], [0.0, 3.0, 0.0, 1.0]

data/lib/spliner.rb

@@ -1,5 +1,5 @@
 require 'spliner/spliner'
 
 module Spliner
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/spliner/spliner.rb

@@ -8,11 +8,19 @@ module Spliner
   # == Example
   #
   #    require 'spliner'
+  #    
   #    # Initialize a spline interpolation with x range 0.0..2.0
   #    my_spline = Spliner::Spliner.new [0.0, 1.0, 2.0], [0.0, 1.0, 0.5]
-  #    # Perform interpolation on 31 values ranging from 0..2.0
-  #    x_values = (0..30).map {|x| x / 30.0 * 2.0 }
-  #    y_values = x_values.map {|x| my_spline[x] }
+  #    
+  #    # Interpolate for a single value
+  #    y1 = my_spline[0.5]
+  #    
+  #    # Perform interpolation on 11 values ranging from 0..2.0
+  #    y_values = my_spline[(0.0..2.0).step(0.1)]
+  #
+  #    # You may prefer to use the shortcut class method
+  #    y2 = Spliner::Spliner[[0.0, 1.0, 2.0], [0.0, 1.0, 0.5], 0.5]
+  #
   #
   # Algorithm based on http://en.wikipedia.org/wiki/Spline_interpolation
   #
@@ -80,6 +88,37 @@ module Spliner
       @extrapolation_method = options[:emethod] || :linear
     end
 
+    # shortcut method to instanciate a Spliner::Spliner object and
+    # return a series of interpolated values. Options are like 
+    # Spliner::Spliner#initialize
+    #
+    # @overload interpolate(points, x, options)
+    #   @param points [Hash{Float => Float}] keys are X values in increasing order, values Y
+    #   @param x [Float,Vector,Enumerable(Float)] X value(s) to interpolate on
+    #   @param options [Hash]
+    #
+    # @overload interpolate(key_x, key_y, x, options)
+    #   @param key_x [Array(Float),Vector] the X values of the key points
+    #   @param_key_y [Array(Float),Vector] the Y values of the key points
+    #   @param x [Float,Vector,Enumerable(Float)] X value(s) to interpolate on
+    #   @param options [Hash]
+    #
+    def self.interpolate(*args)
+      if (args.first.class == Hash)
+        key_points, x, options = args
+        s = Spliner.new key_points, (options || {})
+        s[x]
+      else
+        key_x, key_y, x, options = args
+        s = Spliner.new key_x, key_y, (options || {})
+        s[x]
+      end
+    end
+
+    class << self
+      alias :'[]' :interpolate
+    end
+
     # returns the ranges at each slice between duplicate X values
     def split_at_duplicates(x)
       # find all indices with duplicate x values
@@ -89,15 +128,48 @@ module Spliner
     private :split_at_duplicates
 
 
-    # returns an interpolated value
-    def get(v)
-      i = @sections.find_index {|section| section.range.member? v }
-      if i
-        @sections[i].get v
-      elsif range.member? v
-        extrapolate(v)
+    # returns the interpolated Y value(s) at the specified X
+    #
+    # @param x [Float,Vector,Enumerable(Float)] x
+    #
+    # == Example
+    #
+    #    my_spline = Spliner::Spliner.new [0.0, 1.0, 2.0], [0.0, 1.0, 0.5]
+    #    # get one value
+    #    y1 = my_spline.get 0.5
+    #    # get many values
+    #    y2 = my_spline.get [0.5, 1.5, 2.5]
+    #    y3 = my_spline.get 0.5, 1.5, 2.5
+    #    # get a range of values
+    #    y4 = my_spline.get 1..3
+    #    # generate an enumeration of x values
+    #    y5 = my_spline.get (1.5..2.5).step(0.5)
+    #
+    def get(*x)
+      xx = if x.size == 1
+             x.first
+           else
+             x
+           end
+
+      get_func = lambda do |v|
+        i = @sections.find_index {|section| section.range.member? v }
+        if i
+          @sections[i].get v
+        elsif range.member? v
+          extrapolate(v)
+        else
+          nil
+        end
+      end
+
+      case xx
+      when Vector
+         xx.collect {|x| get_func.call(x) }
+      when Enumerable
+        xx.map {|x| get_func.call(x) }
       else
-        nil
+        get_func.call(xx)
       end
     end
 

data/spec/spliner_spec.rb

@@ -2,6 +2,8 @@ require 'spliner'
 
 describe Spliner::Spliner do
   DATASET = {0.0 => 0.0, 1.0 => 1.0, 2.0 => 0.5}
+  DATASET_X = [0.0, 1.0, 2.0]
+  DATASET_Y = [0.0, 1.0, 0.5]
   KEYS_0_100 = {0.0 => 0.0, 100.0 => 100.0}
 
 
@@ -109,4 +111,23 @@ describe Spliner::Spliner do
     expect(s[3.5]).to be_within(0.0001).of(2.0)
     expect(s[5.0]).to be_nil
   end
+
+  it 'should accept an array or vector as index' do
+    s = Spliner::Spliner.new DATASET
+    expect(s[*DATASET.keys]).to eq(DATASET.values)
+    expect(s[DATASET.keys]).to eq(DATASET.values)
+    expect(s[Vector[*DATASET.keys]]).to eq(Vector[*DATASET.values])
+  end
+
+  it 'should accept an range/enumerator as index' do
+    s = Spliner::Spliner.new DATASET
+    expect(s[0..2]).to eq(DATASET.values)
+    expect(s[(0.0..2.0).step(1.0)]).to eq(DATASET.values)
+  end
+
+  it 'supports the class shortcut method' do
+    expect(Spliner::Spliner[DATASET_X, DATASET_Y, 0..2]).to eq(DATASET.values)
+    expect(Spliner::Spliner::interpolate(DATASET, 0..2, :extrapolate => '5%')).to eq(DATASET.values)
+  end
+
 end

metadata

@@ -1,89 +1,85 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: spliner
-version: !ruby/object:Gem::Version
-  version: 1.0.2
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 1.0.3
 platform: ruby
-authors:
-- Tallak Tveide
+authors: 
+  - Tallak Tveide
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: Simple library to perform cubic spline interpolation based on key X,Y
-  values
-email:
-- tallak@tveide.net
+
+date: 2012-08-24 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "2.11"
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "0.9"
+    type: :development
+    version_requirements: *id002
+description: Simple library to perform cubic spline interpolation based on key X,Y values
+email: 
+  - tallak@tveide.net
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- .gitignore
-- .travis.yml
-- Gemfile
-- README.markdown
-- Rakefile
-- lib/spliner.rb
-- lib/spliner/spliner.rb
-- lib/spliner/spliner_section.rb
-- spec/spliner_spec.rb
-- spliner.gemspec
+
+files: 
+  - .gitignore
+  - .travis.yml
+  - Gemfile
+  - README.markdown
+  - Rakefile
+  - lib/spliner.rb
+  - lib/spliner/spliner.rb
+  - lib/spliner/spliner_section.rb
+  - spec/spliner_spec.rb
+  - spliner.gemspec
 homepage: http://www.github.com/tallakt/spliner
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: 1.9.1
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
+
 rubyforge_project: spliner
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Cubic spline interpolation library
 test_files: []
-has_rdoc: 
+