multiarray 0.5.2 → 0.6.0

data/lib/multiarray/shortcuts.rb

@@ -0,0 +1,71 @@
+# multiarray - Lazy multi-dimensional arrays for Ruby
+# Copyright (C) 2010 Jan Wedekind
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Namespace of Hornetseye computer vision library
+module Hornetseye
+
+  module ConstructorShortcuts
+
+    def method_missing( name, *args )
+      if name.to_s =~ /^[a-z]+$/
+        target = name.to_s.upcase
+        if Hornetseye.const_defined? target
+          target = Hornetseye.const_get target
+          if target.is_a? Class and target < Element
+            new target, *args
+          else
+            super name, *args
+          end
+        else
+          super name, *args
+        end
+      else
+        super name, *args
+      end
+    end
+
+  end
+
+  Sequence.extend ConstructorShortcuts
+
+  MultiArray.extend ConstructorShortcuts
+
+  module ConversionShortcuts
+
+    def method_missing( name, *args )
+      if name.to_s =~ /^to_[a-z]+$/
+        target = name.to_s[ 3 .. -1 ].upcase
+        if Hornetseye.const_defined? target
+          target = Hornetseye.const_get target
+          if target.is_a? Class and target < Element
+            to_type target, *args
+          else
+            super target, *args
+          end
+        else
+          super name, *args
+        end
+      else
+        super name, *args
+      end
+    end
+
+  end
+
+  Node.class_eval { include ConversionShortcuts }
+
+end
+

data/lib/multiarray/store.rb

@@ -0,0 +1,72 @@
+# multiarray - Lazy multi-dimensional arrays for Ruby
+# Copyright (C) 2010 Jan Wedekind
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Hornetseye
+
+  class Store < Node
+
+    def initialize( dest, source )
+      @dest, @source = dest, source
+    end
+
+    def descriptor( hash )
+      "Store(#{@dest.descriptor( hash )},#{@source.descriptor( hash )})"
+    end
+
+    def array_type
+      @dest.array_type
+    end
+
+    def demand
+      if variables.empty?
+        if dimension > 0
+          shape.last.times do |i|
+            dest = @dest.element INT.new( i )
+            source = @source.dimension == 0 ? @source :
+                                              @source.element( INT.new( i ) )
+            Store.new( dest, source ).demand
+          end  
+        else
+          @dest.store @source.demand
+        end
+        @dest
+      else
+        super
+      end
+    end
+
+    def subst( hash )
+      self.class.new @dest.subst( hash ), @source.subst( hash )
+    end
+
+    def variables
+      @dest.variables + @source.variables
+    end
+
+    def strip
+      vars1, values1, term1 = @dest.strip
+      vars2, values2, term2 = @source.strip
+      return vars1 + vars2, values1 + values2, Store.new( term1, term2 )
+    end
+  
+    def compilable?
+      @dest.compilable? and @source.compilable?
+    end
+
+  end
+
+end
+

data/lib/multiarray/variable.rb

@@ -28,6 +28,10 @@ module Hornetseye
       @meta = meta
     end
 
+    # Display string with information about this object
+    #
+    # @return [String] String with information about this object (e.g.
+    #         'Variable(INT)').
     def inspect
       "Variable(#{@meta.inspect})"
     end
@@ -47,14 +51,27 @@ module Hornetseye
       end
     end
 
+    # Get array size for index variable
+    #
+    # @return [Node] Get the dimension of the array if this is an index variable.
     def size
       @meta.size
     end
 
+    # Set array size for index variable
+    #
+    # Set the dimension of the array assuming this is an index variable.
+    #
+    # @param [Node] value The new size.
     def size=( value )
       @meta.size = value
     end
 
+    # Get type of result of delayed operation
+    #
+    # @return [Class] Type of result.
+    #
+    # @private
     def array_type
       @meta.array_type
     end
@@ -115,6 +132,14 @@ module Hornetseye
       Lookup.new self, value, stride
     end
 
+    # Skip elements of an array
+    #
+    # @param [Variable] index Variable identifying index of array.
+    # @param [Node] start Wrapped integer with number of elements to skip.
+    #
+    # @return [Node] Return variable with offset added or +self+.
+    #
+    # @private
     def skip( index, start )
       if index == self
         self + start

data/lib/multiarray.rb

@@ -21,7 +21,13 @@ class Module
 
   unless method_defined? :alias_method_chain
 
-    # Method for creating alias chains.
+    # Method for creating alias chains
+    #
+    # @param [Symbol,String] target Method to rename.
+    # @param [Symbol,String] feature Feature to use for renaming.
+    # @param [Symbol,String] vocalize Override to use when renaming operators.
+    #
+    # @return [Module] Returns this module.
     #
     # @private
     def alias_method_chain( target, feature, vocalize = target )
@@ -44,6 +50,8 @@ class Proc
     #
     # @param [Object] object Object to bind this instance of +Proc+ to.
     #
+    # @return [Method] The bound method.
+    #
     # @private
     def bind( object )
       block, time = self, Time.now
@@ -416,22 +424,39 @@ end
 
 class Numeric
 
+  # Compute complex conjugate
+  #
+  # @return [Numeric] Returns +self+.
   def conj
     self
   end
 
+  # Get red component
+  #
+  # @return [Numeric] Returns +self+.
   def r
     self
   end
 
+  # Get green component
+  #
+  # @return [Numeric] Returns +self+.
   def g
     self
   end
 
+  # Get blue component
+  #
+  # @return [Numeric] Returns +self+.
   def b
     self
   end
 
+  # Get larger number of two numbers
+  #
+  # @param [Numeric] other The other number.
+  #
+  # @return [Numeric] The larger number of the two.
   def major( other )
     if other.is_a? Numeric
       ( self >= other ).conditional self, other
@@ -441,6 +466,11 @@ class Numeric
     end
   end
 
+  # Get smaller number of two numbers
+  #
+  # @param [Numeric] other The other number.
+  #
+  # @return [Numeric] The smaller number of the two.
   def minor( other )
     if other.is_a? Numeric
       ( self <= other ).conditional self, other
@@ -454,6 +484,13 @@ end
 
 class Array
 
+  # Element-wise operation based on element and its index
+  #
+  # Same as +Array#collect+ but with index.
+  #
+  # @param &action Closure accepting an element and an index.
+  #
+  # @return [Array<Object>] Array with results.
   def collect_with_index( &action )
     zip( ( 0 ... size ).to_a ).collect &action
   end
@@ -470,24 +507,29 @@ require 'multiarray/list'
 require 'multiarray/node'
 require 'multiarray/element'
 require 'multiarray/composite'
+require 'multiarray/store'
 require 'multiarray/object'
 require 'multiarray/index'
 require 'multiarray/bool'
 require 'multiarray/int'
 require 'multiarray/float'
-require 'multiarray/rgb'
-require 'multiarray/complex'
 require 'multiarray/pointer'
 require 'multiarray/variable'
 require 'multiarray/lambda'
 require 'multiarray/lookup'
 require 'multiarray/elementwise'
-require 'multiarray/operations'
-require 'multiarray/methods'
 require 'multiarray/inject'
 require 'multiarray/diagonal'
+require 'multiarray/histogram'
+require 'multiarray/lut'
+require 'multiarray/integral'
+require 'multiarray/operations'
+require 'multiarray/methods'
+require 'multiarray/rgb'
+require 'multiarray/complex'
 require 'multiarray/sequence'
 require 'multiarray/multiarray'
+require 'multiarray/shortcuts'
 require 'multiarray/gcctype'
 require 'multiarray/gccvalue'
 require 'multiarray/gcccontext'

data/test/tc_int.rb

@@ -209,5 +209,15 @@ class TC_Int < Test::Unit::TestCase
     assert_equal I( 4 ), I( 5 ).minor( I( 4 ) )
   end
 
+  def test_fill
+    i = I 0
+    assert_equal I( 3 ), i.fill!( 3 )
+    assert_equal I( 3 ), i
+  end
+
+  def test_integral
+    assert_equal I( 3 ), I( 3 ).integral
+  end
+
 end
 

data/test/tc_multiarray.rb

@@ -364,6 +364,14 @@ class TC_MultiArray < Test::Unit::TestCase
     assert_equal 7, M[ [ 5, 3, 7 ], [ 2, 1, 6 ] ].max
   end
 
+  def test_sum
+    assert_equal 24, M[ [ 5, 3, 7 ], [ 2, 1, 6 ] ].sum
+  end
+
+  def test_range
+    assert_equal 1 .. 7, M[ [ 5, 3, 7 ], [ 2, 1, 6 ] ].range
+  end
+
   def test_diagonal
     assert_equal S[ 'b1a2', 'c1b2a3', 'c2b3' ],
                  M[ [ 'a1', 'a2', 'a3' ],
@@ -398,6 +406,32 @@ class TC_MultiArray < Test::Unit::TestCase
     assert_raise( RuntimeError ) { M[ [ 1, 2, 3 ], [ 4, 5, 6 ] ].convolve S[ 1, 2 ] }
   end
 
+  def test_histogram
+    assert_equal S( I, 5 )[ 0, 1, 1, 2, 0 ],
+                 M[ [ 1, 2 ], [ 3, 3 ] ].histogram( 5, :target => I )
+    assert_equal M( I, 2, 2 )[ [ 1, 0 ], [ 1, 1 ] ],
+                 M[ [ 0, 0 ], [ 0, 1 ], [ 1, 1 ] ].histogram( 2, 2, :target => I )
+    assert_equal M( I, 2, 2, 1 )[ [ [ 0, 1 ], [ 1, 0 ] ] ],
+                 S[ C( 1, 0, 0 ), C( 0, 1, 0 ) ].histogram( 2, 2, 1, :target => I )
+    assert_raise( RuntimeError ) { S[ 1, 2, 3 ].histogram 4, 4 }
+    assert_raise( RuntimeError ) { M[ [ -1, 0 ] ].histogram 3, 2 }
+    assert_raise( RuntimeError ) { M[ [ 0, -1 ] ].histogram 3, 2 }
+    assert_raise( RuntimeError ) { M[ [ 3, 0 ] ].histogram 3, 2 }
+    assert_raise( RuntimeError ) { M[ [ 0, 2 ] ].histogram 3, 2 }
+  end
+
+  def test_lut
+    assert_equal M[ [ 1, 2 ], [ 3, 1 ] ],
+                 M[ [ 0, 1 ], [ 2, 0 ] ].lut( S[ 1, 2, 3, 4 ] )
+    assert_equal M[ 1, 3, 4 ],
+                 M[ [ 0, 0 ], [ 0, 1 ], [ 1, 1 ] ].lut( M[ [ 1, 2 ], [ 3, 4 ] ] )
+    assert_raise( RuntimeError ) { S[ 0, 1, 2 ].lut M[ [ 1, 2 ], [ 3, 4 ] ] }
+    assert_raise( RuntimeError ) { M[ [ -1, 0 ] ].lut M[ [ 1, 2 ] ] }
+    assert_raise( RuntimeError ) { M[ [ 0, -1 ] ].lut M[ [ 1, 2 ] ] }
+    assert_raise( RuntimeError ) { M[ [ 2, 0 ] ].lut M[ [ 1, 2 ] ] }
+    assert_raise( RuntimeError ) { M[ [ 0, 1 ] ].lut M[ [ 1, 2 ] ] }
+  end
+
   def test_zero
     assert_equal M[ [ false, true ], [ true, false ] ],
                  M[ [ -1, 0 ], [ 0, 1 ] ].zero?
@@ -554,10 +588,22 @@ class TC_MultiArray < Test::Unit::TestCase
     assert_equal M[ [ 1, 1 ], [ 0, -1 ] ], 3 <=> M[ [ 1, 2 ], [ 3, 4 ] ]
   end
 
+  def test_fill
+    m = M( I, 3, 2 )[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]
+    assert_equal M( I, 3, 2 )[ [ 1, 1, 1 ], [ 1, 1, 1 ] ], m.fill!( 1 )
+    assert_equal M( I, 3, 2 )[ [ 1, 1, 1 ], [ 1, 1, 1 ] ], m
+  end
+
   def test_to_type
     assert_equal M( C, 2, 2 )[ [ 1, 2 ], [ 3, 4 ] ],
-                 M( I, 2, 2 )[ [ 1, 2 ], [ 3, 4 ] ].to_type( C )
+                 M( I, 2, 2 )[ [ 1, 2 ], [ 3, 4 ] ].to_intrgb
   end
 
+  def test_integral
+    assert_equal M( O, 3, 2 )[ [ 1, 3, 6 ], [ 5, 12, 21 ] ],
+                 M( O, 3, 2 )[ [ 1, 2, 3 ], [ 4, 5, 6 ] ].integral
+    assert_equal M( I, 3, 2 )[ [ 1, 3, 6 ], [ 5, 12, 21 ] ],
+                 M( I, 3, 2 )[ [ 1, 2, 3 ], [ 4, 5, 6 ] ].integral
+  end
 
 end

data/test/tc_object.rb

@@ -134,4 +134,14 @@ class TC_Object < Test::Unit::TestCase
     assert_equal O( 2 ), O( true ).conditional( O( 2 ), O( 1 ) )
   end
 
+  def test_fill
+    o = O 3
+    assert_equal O( 1 ), o.fill!( 1 )
+    assert_equal O( 1 ), o
+  end
+
+  def test_integral
+    assert_equal O( 3 ), O( 3 ).integral
+  end
+
 end