spliner 1.0.0 → 1.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -1,4 +1,4 @@
 rvm:
-  - 1.9.1
+  - 1.9.2
   - 1.9.3
   - jruby

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+

data/README.markdown

@@ -1,27 +1,41 @@
+[![Build Status](https://secure.travis-ci.org/tallakt/spliner.png?branch=master)](http://travis-ci.org/tallakt/spliner)
+
 Spliner
 =======
 
 Spliner is a Ruby library to perform cubic spline interpolation
 based on provided key points (X1, Y1), (X2, Y2), ... , (Xn,Yn)
 
+It also supports extrapolation outside the provided range of X
+values.
+
 Installation
 ------------
 
 Spliner requires Ruby 1.9 or later. Install with rubygems:
 
-  gem install spliner
+    gem install spliner
 
 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})
+    # 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})
+
+    # 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] }
+
 
-  # 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] }
+    # 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%')
+    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)
+    xx = ex_spline[2.1] # returns 0.5
 
 Spliner is based on the interpolation described on this page
 http://en.wikipedia.org/wiki/Spline_interpolation
@@ -59,3 +73,5 @@ License
     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/lib/spliner.rb

@@ -4,7 +4,7 @@
 require 'matrix'
 
 module Spliner
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 
   # Spliner::Spliner provides cubic spline interpolation based on provided 
   # key points on a X-Y curve.
@@ -20,12 +20,27 @@ module Spliner
   # http://en.wikipedia.org/wiki/Spline_interpolation
   #
   class Spliner
+    attr_reader :range
+
     # Creates a new Spliner::Spliner object to interpolate between
     # the supplied key points. The key points are provided in a hash where
     # the key is the X value, and the value is the Y value. The X values
     # mush be increasing and not duplicate. You must provide at least 
     # two values.
-    def initialize(key_points)
+    #
+    # options may take the following keys:
+    #
+    #   :extrapolate
+    #   Specify an area outside the given X values provided that should return
+    #   a valid number. The value may be either a range (eg. -10..110) or a
+    #   percentage value written as a string (eg '10%'). Default is no
+    #   extrapolation.
+    #
+    #   :emethod
+    #   Specify a method of extrapolation, one of :linear (continue curve as 
+    #   a straigt line, default), or :hold (use Y values at the curve endpoints)
+    #
+    def initialize(key_points, options = {})
 
       @points = key_points
       @x = @points.keys
@@ -58,18 +73,38 @@ module Spliner
       b = vector_helper(tmp)
 
       @k = a.inv * b
+
+      options[:extrapolate].tap do |ex|
+        case ex
+        when /^\d+(\.\d+)?\s?%$/
+          percentage = ex[/\d+(\.\d+)?/].to_f
+          span = @x.last - @x.first
+          extra = span * percentage * 0.01
+          @range = (@x.first - extra)..(@x.last + extra)
+        when Range
+          @range = ex
+        when nil
+          @range = @x.first..@x.last
+        else
+          raise 'Unable to use extrapolation parameter'
+        end
+      end
+
+      @extrapolation_method = options[:emethod] || :linear
     end
 
     # returns an interpolated value
-    def get(x)
-      i = @x_pairs.find_index {|pair| pair.member? x }
+    def get(v)
+      i = @x_pairs.find_index {|pair| pair.member? v }
       if i
         dx = @x[i + 1] - @x[i]
         dy = @y[i + 1] - @y[i]
-        t = (x - @x[i]) / dx
+        t = (v - @x[i]) / dx
         a = @k[i] * dx - dy
         b = -(@k[i + 1] * dx - dy)
         (1 - t) * @y[i] + t * @y[i + 1] + t * (1 - t) * (a * (1 - t) + b * t)
+      elsif range.member? v
+        extrapolate(v)
       else
         nil
       end
@@ -95,5 +130,25 @@ module Spliner
     end
     private :check_points_increasing
 
+    # :nodoc:
+    def extrapolate(v)
+      case @extrapolation_method
+      when :hold
+        if v < @x.first
+          @y.first
+        else
+          @y.last
+        end
+      else
+        x, y, k = if v < @x.first
+                    [@x.first, @y.first, @k.first]
+                  else
+                    [@x.last, @y.last, @k[-1]]
+                  end
+        y + k * (v - x)
+      end
+    end
+    private :extrapolate
+
   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}
+  KEYS_0_100 = {0.0 => 0.0, 100.0 => 100.0}
+
 
   it 'should not accept x values that are not increasing' do
     expect(lambda { Spliner::Spliner.new({0 => 0, 0 => 10})}).to raise_exception
@@ -42,4 +44,31 @@ describe Spliner::Spliner do
     expect(s[-1]).to be_nil
     expect(s[0]).to be_within(0.0001).of(0.0)
   end
+
+  it 'performs :linear extrapolation outside the data range when such is given' do
+    s = Spliner::Spliner.new KEYS_0_100, :extrapolate => -200..200
+    expect(s.get -110).not_to be_nil
+    expect(s.get -150).to be_within(0.0001).of(-150)
+    expect(s.get 150).to be_within(0.0001).of(150)
+  end
+
+  it 'performs :hold extrapolation' do
+    s = Spliner::Spliner.new KEYS_0_100, :extrapolate => -200..200, :emethod => :hold
+    expect(s.get -150).to be_within(0.0001).of(0)
+    expect(s.get 150).to be_within(0.0001).of(100)
+  end
+
+  it 'supports data ranges given as a string like "10%"' do
+    s1 = Spliner::Spliner.new KEYS_0_100, :extrapolate => '10%'
+    expect(s1.range.first).to be_within(0.0001).of(-10.0)
+    expect(s1.range.last).to be_within(0.0001).of(110.0)
+
+    s2 = Spliner::Spliner.new KEYS_0_100, :extrapolate => '10.0%'
+    expect(s2.range.first).to be_within(0.0001).of(-10.0)
+    expect(s2.range.last).to be_within(0.0001).of(110.0)
+
+    s3 = Spliner::Spliner.new KEYS_0_100, :extrapolate => '10 %'
+    expect(s3.range.first).to be_within(0.0001).of(-10.0)
+    expect(s3.range.last).to be_within(0.0001).of(110.0)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spliner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -51,7 +51,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .travis.yml
+- Gemfile
 - README.markdown
 - Rakefile
 - lib/spliner.rb