multiarray 0.2.3 → 0.2.4

data/Rakefile

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+require 'date'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rbconfig'
+
+PKG_NAME = 'multiarray'
+PKG_VERSION = '0.2.4'
+RB_FILES = FileList[ 'lib/**/*.rb' ]
+TC_FILES = FileList[ 'test/tc_*.rb' ]
+TS_FILES = FileList[ 'test/ts_*.rb' ]
+PKG_FILES = [ 'Rakefile', 'README', 'COPYING', '.document' ] +
+            RB_FILES + TS_FILES + TC_FILES
+SUMMARY = %q{Multi-dimensional and uniform Ruby arrays}
+DESCRIPTION = %q{This Ruby-extension defines Hornetseye::MultiArray and other native datatypes. Hornetseye::MultiArray provides multi-dimensional Ruby arrays with elements of same type. The extension is designed to be mostly compatible with Masahiro Tanaka's NArray. However it allows the definition of custom element types and operations on them. This work was also inspired by Ronald Garcia's boost::multi_array and by Todd Veldhuizen's Blitz++.}
+AUTHOR = %q{Jan Wedekind}
+EMAIL = %q{jan@wedesoft.de}
+HOMEPAGE = %q{http://wedesoft.github.com/multiarray/}
+
+$SITELIBDIR = Config::CONFIG[ 'sitelibdir' ]
+
+task :default do
+end
+
+desc 'Install Ruby extension'
+task :install do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.mkdir_p "#{$SITELIBDIR}/#{File.dirname( f[ 4 .. -1 ] )}"
+      FileUtils.cp_r f, "#{$SITELIBDIR}/#{f[ 4 .. -1 ]}"
+    end
+  end
+end
+
+desc 'Uninstall Ruby extension'
+task :uninstall do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.rm_f "#{$SITELIBDIR}/#{f[ 4 .. -1 ]}"
+    end
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = TC_FILES
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new :yard do |y|
+    y.options << '--no-private'
+    y.files << FileList[ 'lib/**/*.rb' ]
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'yard\' if you want to generate documentation'
+end
+
+Rake::PackageTask.new PKG_NAME, PKG_VERSION do |p|
+  p.need_tar = true
+  p.package_files = PKG_FILES
+end
+
+begin
+  require 'rubygems/builder'
+  $SPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::RUBY
+    s.date = Date.today.to_s
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    s.author = AUTHOR
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.files = PKG_FILES
+    s.test_files = TC_FILES
+    s.require_paths = [ 'lib' ]
+    s.rubyforge_project = %q{hornetseye}
+    s.extensions = %w{Rakefile}
+    s.has_rdoc = 'yard'
+    s.extra_rdoc_files = []
+    s.rdoc_options = %w{--no-private}
+    s.add_dependency %q<malloc>, [ '~> 0.2' ]
+  end
+  GEM_SOURCE = "#{PKG_NAME}-#{PKG_VERSION}.gem"
+  desc "Build the gem file #{GEM_SOURCE}"
+  task :gem => [ "pkg/#{GEM_SOURCE}" ]
+  file "pkg/#{GEM_SOURCE}" => [ 'pkg' ] + $SPEC.files do
+    Gem::Builder.new( $SPEC ).build
+    verbose true do
+      FileUtils.mv GEM_SOURCE, "pkg/#{GEM_SOURCE}"
+    end
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'rubygems\' if you want to create Gem packages'
+end
+
+CLOBBER.include 'doc'

data/lib/multiarray.rb

@@ -5,6 +5,7 @@ require 'multiarray/memory'
 require 'multiarray/type'
 require 'multiarray/type_operation'
 require 'multiarray/descriptortype'
+require 'multiarray/object'
 require 'multiarray/int_'
 require 'multiarray/int'
 require 'multiarray/composite_type'

data/lib/multiarray/composite_type.rb

@@ -22,8 +22,8 @@ module Hornetseye
       # @return [Class] Returns the storage type for the element type.
       #
       # @private
-      def memory
-        element_type.memory
+      def storage
+        element_type.storage
       end
 
       # Number of bytes for storing an object of this type

data/lib/multiarray/int_.rb

@@ -33,7 +33,7 @@ module Hornetseye
       # @return [Class] Returns +Memory+.
       #
       # @private
-      def memory
+      def storage
         Memory
       end
 
@@ -49,7 +49,7 @@ module Hornetseye
 
       # Default value for integers
       #
-      # @return [Integer] Returns +0+.
+      # @return [Object] Returns +0+.
       #
       # @private
       def default

data/lib/multiarray/object.rb

@@ -0,0 +1,53 @@
+module Hornetseye
+
+  # Class for representing Ruby objects
+  class OBJECT < Type
+
+    class << self
+
+      # Returns the type of storage object for storing values
+      #
+      # @return [Class] Returns +List+.
+      #
+      # @private
+      def storage
+        List
+      end
+
+      # Number of storage elements for storing an object of this type
+      #
+      # @return [Integer] Returns +1+.
+      #
+      # @private
+      def bytesize
+        1
+      end
+
+      # Default value for Ruby objects.
+      #
+      # @return [Object] Returns +nil+. 
+      #
+      # @private
+      def default
+        nil
+      end
+
+      # Get string with information about this type
+      #
+      # @return [String] Returns +'OBJECT'+.
+      def to_s
+        'OBJECT'
+      end
+
+      # Get string with information about this type
+      #
+      # @return [String] Returns +'OBJECT'+.
+      def inspect
+        to_s
+      end
+
+    end
+
+  end
+
+end

data/lib/multiarray/sequence.rb

@@ -40,7 +40,6 @@ module Hornetseye
   # @see #MultiArray
   # @see CompositeType.element_type
   # @see CompositeType.num_elements
-  # @see Sequence_.stride
   def Sequence( element_type, num_elements,
                 stride = element_type.size )
     retval = Class.new Sequence_

data/lib/multiarray/sequence_.rb

@@ -32,7 +32,7 @@ module Hornetseye
 
       # Get default value for this array type.
       #
-      # @return [Sequence_] Returns a multi-dimensional array filled with the
+      # @return [Object] Returns a multi-dimensional array filled with the
       # default value of the element type.
       #
       # @private

data/lib/multiarray/sequence_operation.rb

@@ -29,8 +29,8 @@ module Hornetseye
           raise "Index must be in 0 ... #{num_elements} " +
                 "(was #{indices.last.inspect})"
         end
-        element_memory = @memory + indices.last * stride * typecode.bytesize
-        element_type.wrap( element_memory ).sel *indices[ 0 ... -1 ]
+        element_storage = @storage + indices.last * stride * typecode.bytesize
+        element_type.wrap( element_storage ).sel *indices[ 0 ... -1 ]
       end
     end
 

data/lib/multiarray/type.rb

@@ -13,7 +13,7 @@ module Hornetseye
       #
       # @private
       def alloc
-        memory.alloc bytesize
+        storage.alloc bytesize
       end
 
       # Create new instance viewing the data of the indicated +Storage+ object
@@ -21,8 +21,8 @@ module Hornetseye
       # @return [Type] Object of this class.
       #
       # @private
-      def wrap( memory )
-        new nil, :memory => memory
+      def wrap( storage )
+        new nil, :storage => storage
       end
 
       # Returns the element type for arrays. Otherwise it returns +self+
@@ -78,7 +78,7 @@ module Hornetseye
     # @return [Storage]
     #
     # @private
-    attr_accessor :memory
+    attr_accessor :storage
 
     # Get number of bytes memory required to store the data of an instance
     #
@@ -144,14 +144,14 @@ module Hornetseye
     # Create new instance of this type
     #
     # @param value [Object] Optional initial value for this instance.
-    # @option options [Storage] :memory (self.class.alloc) Use specified
+    # @option options [Storage] :storage (self.class.alloc) Use specified
     # +Storage+ object instead of creating a new one.
     #
     # @see alloc
     #
     # @private
     def initialize( value = nil, options = {} )
-      @memory = options[ :memory ] ? options[ :memory ] : self.class.alloc
+      @storage = options[ :storage ] ? options[ :storage ] : self.class.alloc
       set value unless value.nil?
     end
 

data/lib/multiarray/type_operation.rb

@@ -5,13 +5,13 @@ module Hornetseye
 
     # @private
     def set( value = typecode.default )
-      @memory.store self.class, value
+      @storage.store self.class, value
       value
     end
 
     # @private
     def get
-      @memory.load self.class
+      @storage.load self.class
     end
 
     # @private

data/test/tc_object.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+Kernel::require 'multiarray'
+
+class TC_Object < Test::Unit::TestCase
+
+  def setup
+    @@t = Hornetseye::OBJECT
+  end
+
+  def teardown
+    @@t = nil
+  end
+
+  def test_object_default
+    assert_nil @@t.default
+  end
+
+  def test_int_to_s
+    assert_equal 'OBJECT', @@t.to_s
+  end
+
+  def test_int_inspect
+    assert_equal @@t.to_s, @@t.inspect
+  end
+
+  def test_bytesize
+    assert_equal 1, @@t.bytesize
+  end
+
+  def test_typecode
+    assert_equal @@t, @@t.typecode
+  end
+
+  def test_shape
+    assert_equal [], @@t.shape
+  end
+
+  def test_size
+    assert_equal 1, @@t.size
+  end
+
+  def test_to_s
+    assert_equal '42', @@t.new( 42 ).to_s
+  end
+
+  def test_inspect
+    assert_equal "OBJECT(42)", @@t.new( 42 ).inspect
+  end
+
+  def test_get_set
+    i = @@t.new nil
+    assert_nil i.get
+    assert_equal 42, i.set( 42 )
+    assert_equal 42, i.get
+    assert_nil i.set
+    assert_nil i.get
+  end
+
+  def test_at_assign
+    i = @@t.new nil
+    assert_nil i.at
+    assert_equal 42, i.assign( 42 )
+    assert_equal 42, i.at
+    assert_raise( ArgumentError ) { i.at 0 }
+    assert_raise( ArgumentError ) { i.assign 0, nil }
+    i = @@t.new nil
+    assert_nil i[]
+    assert_equal 42, i[] = 42 
+    assert_equal 42, i[]
+    assert_raise( ArgumentError ) { i[ 0 ] }
+    assert_raise( ArgumentError ) { i[ 0 ] = nil }
+  end
+
+  def test_op
+    i = @@t.new 1
+    assert_equal 3, i.op( 2 ) { |x| set get + x }.get
+  end
+
+end

data/test/tc_sequence.rb

@@ -4,7 +4,8 @@ Kernel::require 'multiarray'
 class TC_Sequence < Test::Unit::TestCase
 
   def setup
-    @@types = [ Hornetseye::UBYTE,
+    @@types = [ Hornetseye::OBJECT,
+                Hornetseye::UBYTE,
                 Hornetseye::BYTE,
                 Hornetseye::USINT,
                 Hornetseye::SINT,
@@ -28,7 +29,7 @@ class TC_Sequence < Test::Unit::TestCase
     for t in @@types
       s = Hornetseye::Sequence.new t, 3
       s.set
-      assert_equal [ 0, 0, 0 ], s.to_a
+      assert_equal [ t.default ] * 3, s.to_a
     end
   end
 
@@ -105,13 +106,13 @@ class TC_Sequence < Test::Unit::TestCase
     for t in @@types
       s1 = Hornetseye::Sequence( t, 3 ).new
       s1[] = 2
-      assert_equal 0, s1.set
-      assert_equal [ 0, 0, 0 ], s1.get.to_a
-      assert_equal [ 0, 0, 0 ], s1.to_a
+      assert_equal t.default, s1.set
+      assert_equal [ t.default ] * 3, s1.get.to_a
+      assert_equal [ t.default ] * 3, s1.to_a
       assert_equal 1, s1.set( 1 )
       assert_equal [ 1, 1, 1 ], s1.to_a
       assert_equal [ 2, 3 ], s1.set( [ 2, 3 ] )
-      assert_equal [ 2, 3, 0 ], s1.to_a
+      assert_equal [ 2, 3, t.default ], s1.to_a
       s2 = Hornetseye::Sequence( t, 3 ).new
       s2[] = [ 1, 2, 3 ]
       s1[] = s2

data/test/ts_multiarray.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'tc_int'
+require 'tc_object'
 require 'tc_sequence'
 require 'tc_multiarray'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: multiarray
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 +00:00
+date: 2009-12-14 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,13 +26,12 @@ description: This Ruby-extension defines Hornetseye::MultiArray and other native
 email: jan@wedesoft.de
 executables: []
 
-extensions: []
-
+extensions: 
+- Rakefile
 extra_rdoc_files: []
 
 files: 
-- source.gemspec
-- Makefile
+- Rakefile
 - README
 - COPYING
 - .document
@@ -47,11 +46,13 @@ files:
 - lib/multiarray/int.rb
 - lib/multiarray/type.rb
 - lib/multiarray/storage.rb
+- lib/multiarray/object.rb
 - lib/multiarray/int_.rb
 - lib/multiarray/memory.rb
 - lib/multiarray/sequence_operation.rb
-- test/tc_multiarray.rb
 - test/ts_multiarray.rb
+- test/tc_multiarray.rb
+- test/tc_object.rb
 - test/tc_int.rb
 - test/tc_sequence.rb
 has_rdoc: yard
@@ -84,5 +85,6 @@ specification_version: 3
 summary: Multi-dimensional and uniform Ruby arrays
 test_files: 
 - test/tc_multiarray.rb
+- test/tc_object.rb
 - test/tc_int.rb
 - test/tc_sequence.rb

data/Makefile

@@ -1,78 +0,0 @@
-.SUFFIXES:
-.SUFFIXES: .gem .o .cc .hh .rb .tar .gz .bz2
-
-RUBY_VERSION = 1.8
-MULTIARRAY_VERSION = 0.2.3
-
-CP = cp
-RM = rm -Rf
-MKDIR = mkdir -p
-GEM = gem$(RUBY_VERSION)
-RUBY = ruby$(RUBY_VERSION)
-YARDOC = yardoc
-RI = ri$(RUBY_VERSION)
-TAR = tar
-GIT = git
-SITELIBDIR = $(shell $(RUBY) -r mkmf -e "puts \"\#{Config::CONFIG['sitelibdir']}\"")
-
-MAIN = Makefile source.gemspec README COPYING .document
-LIB = $(wildcard lib/*.rb)
-PKG_LIB = $(wildcard lib/multiarray/*.rb)
-TEST = $(wildcard test/*.rb)
-DOC = $(wildcard doc/*.rb)
-SOURCES = $(MAIN) $(LIB) $(PKG_LIB) $(TEST) $(DOC)
-
-all:: target
-
-target::
-
-gem:: multiarray-$(MULTIARRAY_VERSION).gem
-
-install:: $(LIB) $(PKG_LIB)
-	$(MKDIR) $(SITELIBDIR)
-	$(MKDIR) $(SITELIBDIR)/multiarray
-	$(CP) $(LIB) $(SITELIBDIR)
-	$(CP) $(PKG_LIB) $(SITELIBDIR)/multiarray
-
-uninstall::
-	$(RM) $(addprefix $(SITELIBDIR)/,$(notdir $(LIB))) $(addprefix $(SITELIBDIR)/multiarray/,$(notdir $(PKG_LIB)))
-
-install-gem:: multiarray-$(MULTIARRAY_VERSION).gem
-	$(GEM) install --local $<
-
-uninstall-gem::
-	$(GEM) uninstall multiarray || echo Nothing to uninstall
-
-yardoc:: README $(LIB)
-	$(YARDOC) --no-private
-
-check:: $(LIB) $(PKG_LIB) $(TEST)
-	$(RUBY) -rrubygems -Ilib -Itest test/ts_multiarray.rb
-
-push-gem:: multiarray-$(MULTIARRAY_VERSION).gem
-	echo Pushing $< in 3 seconds!
-	sleep 3
-	$(GEM) push $<
-
-push-git::
-	echo Pushing to origin in 3 seconds!
-	sleep 3
-	$(GIT) push origin master
-
-dist:: dist-gzip
-
-dist-gzip:: multiarray-$(MULTIARRAY_VERSION).tar.gz
-
-dist-bzip2:: multiarray-$(MULTIARRAY_VERSION).tar.bz2
-
-multiarray-$(MULTIARRAY_VERSION).gem: $(SOURCES)
-	$(GEM) build source.gemspec
-
-multiarray-$(MULTIARRAY_VERSION).tar.gz: $(SOURCES)
-	$(TAR) czf $@ $(SOURCES)
-
-multiarray-$(MULTIARRAY_VERSION).tar.bz2: $(SOURCES)
-	$(TAR) cjf $@ $(SOURCES)
-
-clean::
-	$(RM) *~ lib/*~ lib/multiarray/*~ test/*~ *.gem doc

data/source.gemspec

@@ -1,24 +0,0 @@
-require 'date'
-Gem::Specification.new do |s|
-  s.name = %q{multiarray}
-  s.version = '0.2.3'
-  s.platform = Gem::Platform::RUBY
-  s.date = Date.today.to_s
-  s.summary = %q{Multi-dimensional and uniform Ruby arrays}
-  s.description = %q{This Ruby-extension defines Hornetseye::MultiArray and other native datatypes. Hornetseye::MultiArray provides multi-dimensional Ruby arrays with elements of same type. The extension is designed to be mostly compatible with Masahiro Tanaka's NArray. However it allows the definition of custom element types and operations on them. This work was also inspired by Ronald Garcia's boost::multi_array and by Todd Veldhuizen's Blitz++.}
-  s.author = %q{Jan Wedekind}
-  s.email = %q{jan@wedesoft.de}
-  s.homepage = %q{http://wedesoft.github.com/multiarray/}
-  s.files = [ 'source.gemspec', 'Makefile', 'README', 'COPYING',
-              '.document' ] +
-              Dir.glob( 'lib/*.rb' ) +
-              Dir.glob( 'lib/multiarray/*.rb' ) +
-              Dir.glob( 'test/*.rb' )
-  s.test_files = Dir.glob( 'test/tc_*.rb' )
-  s.require_paths = [ 'lib' ]
-  s.rubyforge_project = %q{hornetseye}
-  s.has_rdoc = 'yard'
-  s.extra_rdoc_files = []
-  s.rdoc_options = %w{--no-private}
-  s.add_dependency %q<malloc>, [ '~> 0.2' ]
-end