spliner 1.0.0

data/.travis.yml

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

data/README.markdown

@@ -0,0 +1,61 @@
+Spliner
+=======
+
+Spliner is a Ruby library to perform cubic spline interpolation
+based on provided key points (X1, Y1), (X2, Y2), ... , (Xn,Yn)
+
+Installation
+------------
+
+Spliner requires Ruby 1.9 or later. Install with rubygems:
+
+  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})
+
+  # 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] }
+
+Spliner is based on the interpolation described on this page
+http://en.wikipedia.org/wiki/Spline_interpolation
+ 
+
+Contributing to Spliner
+--------------------------
+
+Feel free to fork the project on GitHub and send fork requests. Please 
+try to have each feature separated in commits.
+
+
+
+License
+-------
+
+    (The MIT License)
+
+    Copyright (C) 2012 Tallak Tveide
+
+    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 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/Rakefile

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

data/lib/spliner.rb

@@ -0,0 +1,99 @@
+#
+# Spliner::Spliner
+#
+require 'matrix'
+
+module Spliner
+  VERSION = '1.0.0'
+
+  # Spliner::Spliner provides cubic spline interpolation based on provided 
+  # key points on a X-Y curve.
+  #
+  # == Example
+  # 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})
+  # # 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] }
+  #
+  # http://en.wikipedia.org/wiki/Spline_interpolation
+  #
+  class Spliner
+    # 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)
+
+      @points = key_points
+      @x = @points.keys
+      @y = @points.values
+
+      check_points_increasing
+      raise 'Interpolation needs at least two points' unless @points.size >= 2
+
+      @x_pairs = @points.keys.each_cons(2).map {|pair| pair.first..pair.last }
+
+      inv_diff = @x.each_cons(2).map {|x1, x2| 1 / (x2 - x1) }
+      a_diag = 2.0 * Matrix::diagonal(*vector_helper(inv_diff))
+      a_non_diag = Matrix::build(@points.size) do |row, col|
+        if row == col+ 1
+          inv_diff[col]
+        elsif col == row + 1
+          inv_diff[row]
+        else
+          0.0
+        end
+      end
+
+      a = a_diag + a_non_diag
+
+      tmp = @points.each_cons(2).map do |p1, p2|
+        x1, y1 = p1
+        x2, y2 = p2
+        3.0 * (y2 - y1) / (x2 - x1) ** 2.0
+      end
+      b = vector_helper(tmp)
+
+      @k = a.inv * b
+    end
+
+    # returns an interpolated value
+    def get(x)
+      i = @x_pairs.find_index {|pair| pair.member? x }
+      if i
+        dx = @x[i + 1] - @x[i]
+        dy = @y[i + 1] - @y[i]
+        t = (x - @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)
+      else
+        nil
+      end
+    end
+
+    alias :'[]' :get 
+
+
+    # for a vector [a, b, c] returns [a, a + b, b + c, c]
+    # :nodoc:
+    def vector_helper(a)
+      Vector[*([0.0] + a)] + Vector[*(a + [0.0])]
+    end
+    private :vector_helper
+
+
+
+    # :nodoc:
+    def check_points_increasing
+      @x.each_cons(2) do |x1, x2|
+        raise 'Points must form a series of x and y values where x is increasing' unless x2 > x1
+      end
+    end
+    private :check_points_increasing
+
+  end
+end

data/spec/spliner_spec.rb

@@ -0,0 +1,45 @@
+require 'spliner'
+
+describe Spliner::Spliner do
+  DATASET = {0.0 => 0.0, 1.0 => 1.0, 2.0 => 0.5}
+
+  it 'should not accept x values that are not increasing' do
+    expect(lambda { Spliner::Spliner.new({0 => 0, 0 => 10})}).to raise_exception
+  end
+
+  it 'should not accept less than two values' do 
+    expect(lambda { Spliner::Spliner.new({0 => 0})}).to raise_exception
+  end
+
+  it 'should return the data points themselves' do
+    s = Spliner::Spliner.new DATASET
+    DATASET.each do |k,v|
+      expect(s.get(k)).to be_within(0.00001).of(v)
+    end
+  end
+
+  it 'should return nil outside the data area' do
+    s = Spliner::Spliner.new DATASET
+    expect(s.get(-1.0)).to be_nil
+    expect(s.get(3.0)).to be_nil
+  end
+
+  it 'should generate a smooth curve (predefined points)' do
+    s = Spliner::Spliner.new DATASET
+    expect(s.get(0.4)).to be_within(0.0001).of(0.5260)
+    expect(s.get(0.8)).to be_within(0.0001).of(0.9080)
+    expect(s.get(1.2)).to be_within(0.0001).of(1.0080)
+    expect(s.get(1.6)).to be_within(0.0001).of(0.8260)
+  end
+
+  it 'should perform linear interpolation in the case of two data points' do
+    s = Spliner::Spliner.new({0 => 0, 10.0 => 100.0})
+    expect(s.get(3.0)).to be_within(0.0001).of(30.0)
+  end
+
+  it 'supports the [] operator (indexing like)' do
+    s = Spliner::Spliner.new DATASET
+    expect(s[-1]).to be_nil
+    expect(s[0]).to be_within(0.0001).of(0.0)
+  end
+end

data/spliner.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "spliner"
+
+Gem::Specification.new do |s|
+  s.name = "spliner"
+  s.version = Spliner::VERSION
+  s.authors = ["Tallak Tveide"]
+  s.email = ["tallak@tveide.net"]
+  s.homepage = "http://www.github.com/tallakt/spliner"
+  s.summary = %q{Cubic spline interpolation library}
+  s.description = %q{Simple library to perform cubic spline interpolation based on key X,Y values}
+  s.required_ruby_version = '>= 1.9.1'
+
+  s.rubyforge_project = "spliner"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # s.add_runtime_dependency "clamp", '~> 0.3'
+  s.add_development_dependency "rspec", '~> 2.11'
+  s.add_development_dependency "rake", '~> 0.9'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: spliner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tallak Tveide
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- README.markdown
+- Rakefile
+- lib/spliner.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
+  none: false
+  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: []
+rubyforge_project: spliner
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cubic spline interpolation library
+test_files: []