interpolate 0.2.2 → 0.2.3

data/History.txt

@@ -1,3 +1,7 @@
+== 0.2.3 (2009.10.27)
+
+* Support for passing a block to new Interpolation objects
+
 == 0.2.2 (2008.2.4)
 
 * Single source file has been split into Class files

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Adam Collins [adam.w.collins@gmail.com]
+Copyright (c) 2008-2009 Adam Collins [adam.w.collins@gmail.com]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -8,7 +8,7 @@ examples/colors.rb
 examples/nested.rb
 examples/zones.rb
 lib/interpolate.rb
-lib/interpolate/interpolation.rb
-lib/interpolate/ruby_array.rb
-lib/interpolate/ruby_numeric.rb
+lib/interpolate/add/array.rb
+lib/interpolate/add/core.rb
+lib/interpolate/add/numeric.rb
 test/test_all.rb

data/README.txt

@@ -53,21 +53,13 @@ of a set falls into:
 == Non-Numeric Gradients
 
 For non-Numeric gradient value objects, you'll need to implement +interpolate+
-for the class in question.  Here's an example using an RGB color gradient with
-the help of the 'color' gem:
+for the class in question or provide a block to the new Interpolation object.
+Here's an example using an RGB color gradient with the help of the 'color' gem:
 
   require 'rubygems'
   require 'interpolate'
   require 'color'
 
-  # we need to implement +interpolate+ for Color::RGB
-  # in order for Interpolation to work
-  class Color::RGB
-    def interpolate(other, balance)
-      mix_with(other, balance * 100.0)
-    end
-  end
-
   # a nice weathermap-style color gradient
   points = {
     0 => Color::RGB::White,
@@ -80,7 +72,9 @@ the help of the 'color' gem:
     7 => Color::RGB::DarkGray
   }
 
-  gradient = Interpolation.new(points)
+  gradient = Interpolation.new(points) do |left, right, balance|
+    left.mix_with(right, balance * 100.0)
+  end
 
   # what are the colors of the gradient from 0 to 7
   # in increments of 0.2?
@@ -90,6 +84,7 @@ the help of the 'color' gem:
   end
 
 
+
 == Array-based Interpolations
 
 Aside from single value gradient points, you can interpolate over uniformly sized
@@ -164,7 +159,7 @@ Here's an example of a set of 2D points being morphed:
 
 (The MIT License)
 
-Copyright (c) 2008 Adam Collins [adam.w.collins@gmail.com]
+Copyright (c) 2008-2009 Adam Collins [adam.w.collins@gmail.com]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/examples/arrays.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require 'interpolate'
 require 'pp'
 
-
 # a non-linear set of multi-dimensional points;
 # perhaps the location of some actor in relation to time
 time_frames = {

data/examples/colors.rb

@@ -2,15 +2,6 @@ require 'rubygems'
 require 'interpolate'
 require 'color'
 
-
-# we need to implement :interpolate for Color::RGB
-# in order for Interpolation to work
-class Color::RGB
-  def interpolate(other, balance)
-    mix_with(other, balance * 100.0)
-  end
-end
-
 # a nice weathermap-style color gradient
 points = {
   0 => Color::RGB::White,
@@ -23,8 +14,12 @@ points = {
   7 => Color::RGB::DarkGray
 }
 
-
-gradient = Interpolation.new(points)
+# Color objects can't interpolate themselves right out of the box,
+# so rather than monkey patch the :interpolate method, you can pass
+# a block with the instantiation of a new Interpolation object
+gradient = Interpolation.new(points) do |left, right, balance|
+  left.mix_with(right, balance * 100.0)
+end
 
 # what are the colors of the gradient from 0 to 7
 # in increments of 0.2?

data/lib/interpolate.rb

@@ -1,3 +1,3 @@
-require 'interpolate/interpolation'
-require 'interpolate/ruby_array'
-require 'interpolate/ruby_numeric'
+require 'interpolate/add/core'
+require 'interpolate/add/array'
+require 'interpolate/add/numeric'

data/lib/interpolate/{interpolation.rb → add/core.rb}

@@ -2,18 +2,15 @@
 # linear motion between points (or arrays of points), multi-channel color
 # gradients, piecewise functions, or even just placing values within intervals.
 #
-# The only requirement is that each interpolation point value must be able to
-# figure out how to interpolate itself to its neighbor value(s). Numeric
-# objects and uniformly sized arrays are automatically endowed with this
-# ability by this gem, but other classes will require an implementation
-# of +interpolate+. See the example color.rb in the examples directory for
-# a brief demonstration using Color objects provided by the 'color' gem.
-#
 # Interpolation objects are constructed with a Hash object, wherein each key
-# is a real number value and each value is can respond to +interpolate+ and
+# is a real number value and each value can respond to +interpolate+ to
 # determine the resulting value based on its neighbor value and the balance
 # ratio between the two points.
 #
+# For objects which can't respond to +interpolate+ (or to override the default
+# behaviour), a block can be passed to +new+ which will be called whenever two
+# values need to be interpolated.
+#
 # At or below the lower bounds of the interpolation, the result will be equal to
 # the value of the lower bounds interpolation point.  At or above the upper
 # bounds of the graient, the result will be equal to the value of the upper
@@ -31,18 +28,26 @@
 #
 
 class Interpolation
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 
   # creates an Interpolation object with Hash object that specifies
   # each point location (Numeric) and value (up to you)
-  def initialize(points = {})
+  # 
+  # the optional+block+ can be used to interpolate objects that can't
+  # respond to +interpolate+ on their own
+  #
+  # +block+ will receive the following arguments: "left" (lower) side
+  # value, "right" (higher) side value, and the balance ratio from 0.0
+  # to 1.0
+  def initialize(points = {}, &block)
     @points = {}
+    @block = block
     merge!(points)
   end
 
   # creates an Interpolation object from the receiver object,
   # merged with the interpolated points you specify
-  def merge(points = {}) 
+  def merge(points = {})
     Interpolation.new(points.merge(@points))
   end
 
@@ -52,7 +57,7 @@ class Interpolation
     normalize_data
   end
 
-  # returns the interpolated value of the receiver object at the point specified 
+  # returns the interpolated value of the receiver object at the point specified
   def at(point)
     # deal with the two out-of-bounds cases first
     if (point <= @min_point)
@@ -87,8 +92,13 @@ class Interpolation
         return left_value if (balance == 0.0)
         return right_value if (balance == 1.0)
 
+        # given block should be called
+        return @block.call(left_value, right_value, balance) if @block
+
         # otherwise, we need to interpolate
-        return left_value.interpolate(right_value, balance)
+        return left_value.interpolate(right_value, balance) if left_value.respond_to?(:interpolate)
+
+        raise ArgumentError, "no block given and interpolation point doesn't respond to :interpolate"
       end
     end
 
@@ -106,9 +116,6 @@ class Interpolation
     # make sure that all values respond_to? :interpolate
     @data.each do |point|
       value = point.last
-      unless value.respond_to?(:interpolate)
-        raise ArgumentError, "found an interpolation point that doesn't respond to :interpolate"
-      end
     end
   end
 

data/test/test_all.rb

@@ -9,7 +9,7 @@ class InterpolationTest < Test::Unit::TestCase
   DELTA = 1e-7
 
   def setup
-    decimal_points = {
+    @decimal_points = {
       0 => 0,
       1 => 0.1,
       2 => 0.2,
@@ -23,29 +23,28 @@ class InterpolationTest < Test::Unit::TestCase
       10 => 1
     }.freeze
 
-    array_points = {
+    @array_points = {
       100 => [1,   10,  100],
       200 => [5,   50,  500],
       500 => [10, 100, 1000]
     }.freeze
 
-    @dec_gradient = Interpolation.new(decimal_points).freeze
-    @array_gradient = Interpolation.new(array_points).freeze
+    @dec_gradient = Interpolation.new(@decimal_points).freeze
+    @array_gradient = Interpolation.new(@array_points).freeze
   end
 
-
-  def test_bad_points
+  def test_bad_point
     bad_points = {
       0 => 4.2,
       1 => "hello", # not allowed by default
       2 => 3.4,
       3 => 4.8
     }
+    gradient = Interpolation.new(bad_points)
 
     assert_raise ArgumentError do
-      gradient = Interpolation.new(bad_points)
+      gradient.at(1.5)
     end
-
   end
 
   def test_lower_bounds
@@ -133,7 +132,31 @@ class InterpolationTest < Test::Unit::TestCase
     assert_equal(@array_gradient.at(200), [5, 50, 500])
     assert_equal(@array_gradient.at(350), [7.5, 75, 750])
   end
-  
+
+  def test_given_block_left
+    gradient = Interpolation.new(@decimal_points) {|l, r, bal| l}
+    assert_in_delta(gradient.at(1.5), 0.1, DELTA)
+    assert_in_delta(gradient.at(2.5), 0.2, DELTA)
+    assert_in_delta(gradient.at(3.5), 0.3, DELTA)
+  end
+
+  def test_given_block_right
+    gradient = Interpolation.new(@decimal_points) {|l, r, bal| r}
+    assert_in_delta(gradient.at(1.5), 0.2, DELTA)
+    assert_in_delta(gradient.at(2.5), 0.3, DELTA)
+    assert_in_delta(gradient.at(3.5), 0.4, DELTA)
+  end
+
+  def test_given_block_mean_squared
+    # squared balance, not linear
+    gradient = Interpolation.new(@decimal_points) do |l, r, bal|
+      l + ((r - l).to_f * bal * bal)
+    end
+    assert_in_delta(gradient.at(1.5),  0.12500, DELTA)
+    assert_in_delta(gradient.at(2.75), 0.25625, DELTA)
+    assert_in_delta(gradient.at(3.99), 0.39801, DELTA)
+  end
+
   def test_frozen_points
     a = @array_gradient.at(200)
     assert_nothing_raised RuntimeError do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: interpolate
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Adam Collins
@@ -30,19 +30,26 @@ cert_chain:
   xJc09X9KG2jBdxa4tp+uy7KZ
   -----END CERTIFICATE-----
 
-date: 2008-02-05 00:00:00 -08:00
+date: 2009-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.0
+        version: 2.3.3
     version: 
-description: Description  Library for generic Interpolation objects. Useful for such things as generating linear motion between points (or arrays of points), multi-channel color gradients, piecewise functions, or even just placing values within intervals.
+description: |
+  Description
+  
+  Library for generic Interpolation objects. Useful for such things as generating
+  linear motion between points (or arrays of points), multi-channel color
+  gradients, piecewise functions, or even just placing values within intervals.
+
 email: adam.w.collins@gmail.com
 executables: []
 
@@ -64,12 +71,14 @@ files:
 - examples/nested.rb
 - examples/zones.rb
 - lib/interpolate.rb
-- lib/interpolate/interpolation.rb
-- lib/interpolate/ruby_array.rb
-- lib/interpolate/ruby_numeric.rb
+- lib/interpolate/add/array.rb
+- lib/interpolate/add/core.rb
+- lib/interpolate/add/numeric.rb
 - test/test_all.rb
 has_rdoc: true
 homepage: http://interpolate.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -91,9 +100,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: interpolate
-rubygems_version: 1.0.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Description  Library for generic Interpolation objects. Useful for such things as generating linear motion between points (or arrays of points), multi-channel color gradients, piecewise functions, or even just placing values within intervals.
 test_files: 
 - test/test_all.rb