multiarray 0.2.2 → 0.2.3

data/.document

@@ -0,0 +1 @@
+lib/**/*.rb

data/Makefile

@@ -2,7 +2,7 @@
 .SUFFIXES: .gem .o .cc .hh .rb .tar .gz .bz2
 
 RUBY_VERSION = 1.8
-MULTIARRAY_VERSION = 0.2.2
+MULTIARRAY_VERSION = 0.2.3
 
 CP = cp
 RM = rm -Rf
@@ -15,7 +15,7 @@ TAR = tar
 GIT = git
 SITELIBDIR = $(shell $(RUBY) -r mkmf -e "puts \"\#{Config::CONFIG['sitelibdir']}\"")
 
-MAIN = Makefile source.gemspec README COPYING
+MAIN = Makefile source.gemspec README COPYING .document
 LIB = $(wildcard lib/*.rb)
 PKG_LIB = $(wildcard lib/multiarray/*.rb)
 TEST = $(wildcard test/*.rb)
@@ -44,7 +44,7 @@ uninstall-gem::
 	$(GEM) uninstall multiarray || echo Nothing to uninstall
 
 yardoc:: README $(LIB)
-	$(YARDOC)
+	$(YARDOC) --no-private
 
 check:: $(LIB) $(PKG_LIB) $(TEST)
 	$(RUBY) -rrubygems -Ilib -Itest test/ts_multiarray.rb

data/lib/multiarray.rb

@@ -6,14 +6,17 @@ require 'multiarray/type'
 require 'multiarray/type_operation'
 require 'multiarray/descriptortype'
 require 'multiarray/int_'
+require 'multiarray/int'
 require 'multiarray/composite_type'
 require 'multiarray/sequence_'
 require 'multiarray/sequence'
 require 'multiarray/sequence_operation'
 require 'multiarray/multiarray'
 
+# @private
 class Proc
 
+  # @private
   unless method_defined? :bind
     def bind( object )
       block, time = self, Time.now
@@ -29,8 +32,10 @@ class Proc
 
 end
 
+# @private
 class Object
 
+  # @private
   unless method_defined? :instance_exec
     def instance_exec( *arguments, &block )
       block.bind( self )[ *arguments ]

data/lib/multiarray/composite_type.rb

@@ -1,30 +1,63 @@
 module Hornetseye
 
+  # Abstract class for arrays and composite numbers
+  #
+  # @abstract
   class CompositeType < Type
 
     class << self
 
+      # Type of elements this type is composed of
+      #
+      # @return [Type,Sequence_] The element type of this type.
       attr_accessor :element_type
+
+      # Number of elements this type is composed of
+      #
+      # @return [Integer] The number of elements this type is composed of.
       attr_accessor :num_elements
 
+      # Returns the type of storage object for storing values
+      #
+      # @return [Class] Returns the storage type for the element type.
+      #
+      # @private
       def memory
         element_type.memory
       end
 
+      # Number of bytes for storing an object of this type
+      #
+      # @return [Integer] Number of bytes to store +num_elements+ elements of
+      # type +element_type+.
+      #
+      # @private
       def bytesize
         element_type.bytesize * num_elements
       end
 
+      # Returns the element type of this composite type
+      #
+      # @return [Class] Returns +element_type.basetype+.
+      #
+      # @private
       def basetype
         element_type.basetype
       end
 
     end
 
+    # The element type of this object's type
+    #
+    # @return [Type,Sequence_] The element type of this object's type.
     def element_type
       self.class.element_type
     end
 
+    # The number of elements this object's type is composed of
+    #
+    # @return [Integer] The number of elements this object's type is composed
+    # of.
     def num_elements
       self.class.num_elements
     end

data/lib/multiarray/descriptortype.rb

@@ -1,13 +1,37 @@
 module Hornetseye
 
+  # Abstract class for describing scalar data types
+  #
+  # This class is for descriping scalar data types which are known to the Ruby
+  # standard library. I.e. there is a descriptor for +Array#pack+ and
+  # +String#unpack+.
+  #
+  # @see Array#pack
+  # @see String#unpack
+  #
+  # @abstract
   class DescriptorType < Type
 
     class << self
 
+      # Convert a Ruby object to a string containing the native representation
+      #
+      # @return [String] A string with the native representation of the value.
+      #
+      # @see Array#pack
+      #
+      # @private
       def pack( value )
         [ value ].pack descriptor
       end
 
+      # Convert a string with the native representation to a Ruby object
+      #
+      # @return [Object] The corresponding Ruby object to the native value.
+      #
+      # @see String#unpack
+      #
+      # @private
       def unpack( value )
         value.unpack( descriptor ).first
       end

data/lib/multiarray/int.rb

@@ -0,0 +1,62 @@
+module Hornetseye
+
+  # Boolean constant to use as a parameter for creating integer classes
+  #
+  # The value is +false+.
+  #
+  # @see #INT
+  UNSIGNED = false
+
+  # Boolean constant to use as a parameter for creating integer classes
+  #
+  # The value is +true+.
+  #
+  # @see #INT
+  SIGNED   = true
+
+  # Create a class deriving from +INT_+
+  #
+  # The parameters +bits+ and +signed+ are assigned to the corresponding
+  # attributes of the resulting class.
+  #
+  # @param [Integer] bits Number of bits of native integer.
+  # @param [FalseClass,TrueClass] signed Specify +UNSIGNED+ or +SIGNED+ here.
+  # @return [Class] A class deriving from +INT_+.
+  #
+  # @see INT_
+  # @see INT_.bits
+  # @see INT_.signed
+  def INT( bits, signed )
+    retval = Class.new INT_
+    retval.bits   = bits
+    retval.signed = signed
+    retval
+  end
+
+  module_function :INT
+
+  # 8-bit signed integer
+  BYTE  = INT  8, SIGNED
+
+  # 8-bit unsigned integer
+  UBYTE = INT  8, UNSIGNED
+
+  # 16-bit signed integer
+  SINT  = INT 16, SIGNED
+
+  # 16-bit unsigned integer
+  USINT = INT 16, UNSIGNED
+
+  # 32-bit signed integer
+  INT   = INT 32, SIGNED
+
+  # 32-bit unsigned integer
+  UINT  = INT 32, UNSIGNED
+
+  # 64-bit signed integer
+  LONG  = INT 64, SIGNED
+
+  # 64-bit unsigned integer
+  ULONG = INT 64, UNSIGNED
+
+end

data/lib/multiarray/int_.rb

@@ -1,28 +1,64 @@
 module Hornetseye
 
+  # Abstract class for representing native integers
+  #
+  # @see #INT
+  #
+  # @abstract
   class INT_ < DescriptorType
 
     class << self
 
+      # The number of bits of native integers represented by this class
+      #
+      # @return [Integer] Number of bits of native integer.
+      #
+      # @see signed
+      #
+      # @private
       attr_accessor :bits
+
+      # A boolean indicating whether this is a signed integer or not
+      #
+      # @return [FalseClass,TrueClass] Boolean indicating whether this is a
+      # signed integer.
+      #
+      # @see bits
+      #
+      # @private
       attr_accessor :signed
 
+      # Returns the type of storage object for storing values
+      #
+      # @return [Class] Returns +Memory+.
+      #
+      # @private
       def memory
         Memory
       end
 
+      # Number of bytes for storing an object of this type
+      #
+      # @return [Integer] Number of bytes to store a native integer of this
+      # type.
+      #
+      # @private
       def bytesize
-        bits / 8
+        ( bits + 7 ).div 8
       end
 
+      # Default value for integers
+      #
+      # @return [Integer] Returns +0+.
+      #
+      # @private
       def default
         0
       end
 
-      def inspect
-        to_s
-      end
-
+      # Get string with information about this type
+      #
+      # @return [String] Information about this integer type.
       def to_s
         case [ bits, signed ]
         when [  8, true  ]
@@ -46,6 +82,19 @@ module Hornetseye
         end
       end
 
+      # Get string with information about this type
+      #
+      # @return [String] Information about this integer type.
+      def inspect
+        to_s
+      end
+
+      # Get descriptor for packing/unpacking native values
+      #
+      # @see DescriptorType.pack
+      # @see DescriptorType.unpack
+      #
+      # @private
       def descriptor
         case [ bits, signed ]
         when [  8, true  ]
@@ -73,25 +122,4 @@ module Hornetseye
 
   end
 
-  UNSIGNED = false
-  SIGNED   = true
-
-  def INT( bits, signed )
-    retval = Class.new INT_
-    retval.bits   = bits
-    retval.signed = signed
-    retval
-  end
-
-  module_function :INT
-
-  BYTE  = INT  8, SIGNED
-  UBYTE = INT  8, UNSIGNED
-  SINT  = INT 16, SIGNED
-  USINT = INT 16, UNSIGNED
-  INT   = INT 32, SIGNED
-  UINT  = INT 32, UNSIGNED
-  LONG  = INT 64, SIGNED
-  ULONG = INT 64, UNSIGNED
-
 end

data/lib/multiarray/list.rb

@@ -1,42 +1,108 @@
 module Hornetseye
 
+  # Class for creating views on Ruby arrays
+  #
+  # @see Storage
+  # @see Memory
+  # @private
   class List < Storage
 
     class << self
 
+      # Create a +List+ object viewing a new Ruby array
+      #
+      # @param [Integer] size Number of elements the new Ruby array should
+      # have.
+      # @return [List] The new +List+ object.
+      #
+      # @private
       def alloc( size )
-        List.new Array.new( size )
+        new Array.new( size )
       end
 
+      # Create a +List+ object viewing an existing Ruby array
+      #
+      # @param [Array<Object>] arr Existing Ruby array.
+      # @return [List] The new +List+ object.
+      #
+      # @private
       def import( arr )
-        List.new arr
+        new arr
       end
 
     end
 
+    # Offset of this view
+    #
+    # @private
     attr_accessor :offset
 
+    # Create zero-offset view on a Ruby array
+    #
+    # @param [Array<Object>] arr A Ruby array.
+    #
+    # @private
     def initialize( arr )
       super arr
       @offset = 0
     end
 
+    # Retrieve an element from the array
+    #
+    # @param [Type] typecode This parameter is ignored.
+    # @return [Object] The element from the array.
+    #
+    # @see #store
+    # @see Memory#load
+    # @private
     def load( typecode )
       @data[ @offset ]
     end
 
+    # Store an element in the array
+    #
+    # @param [Type] typecode This parameter is ignored.
+    # @param [Object] value The Ruby object to store.
+    # @return [Object] Returns the parameter +value+.
+    #
+    # @see #load
+    # @see Memory#store
+    # @private
     def store( typecode, value )
       @data[ @offset ] = value
     end
 
+    # Store multiple elements in the array
+    #
+    # @param [Array<Object>] data A Ruby array with the new data.
+    # @return [Array<Object>] The parameter +data+.
+    #
+    # @see #export
+    # @see Memory#import
+    # @private
     def import( data )
       @data[ @offset ... @offset + data.size ] = data
     end
 
+    # Retrieve multiple elements from the array
+    #
+    # @param [Integer] size Number of elements to retrieve
+    # @return [Array<Object>] A Ruby array with the elements.
+    #
+    # @see #import
+    # @see Memory#export
+    # @private
     def export( size )
       @data[ @offset ... @offset + size ]
     end
 
+    # Create a new view with the specified offset
+    #
+    # @param [Integer] offset A non-negative offset.
+    # @return [List] A new view for the specified part of the array.
+    #
+    # @see Memory#+
+    # @private
     def +( offset )
       retval = List.new @data
       retval.offset = @offset + offset

data/lib/multiarray/memory.rb

@@ -1,13 +1,33 @@
 module Hornetseye
 
+  # Class for creating views on raw memory
+  #
+  # @see Storage
+  # @see List
+  # @private
   class Memory < Storage
 
     class << self
 
+      # Create a +Memory+ object viewing a new +Malloc+ object
+      #
+      # @param [Integer] bytesize Number of bytes to allocate.
+      # @return [Memory] The new +Memory+ object.
+      #
+      # @see Malloc
+      # @private
       def alloc( bytesize )
         Memory.new Malloc.new( bytesize )
       end
 
+      # Create a +Memory+ object viewing a new +Malloc+ object initialised with
+      # the content of a string
+      #
+      # @param [String] str A Ruby string with data to write to memory.
+      # object.
+      # @return [Memory] The new +Memory+ object initialised with the data.
+      #
+      # @private
       def import( str )
         retval = alloc str.bytesize
         retval.import str
@@ -16,26 +36,73 @@ module Hornetseye
 
     end
 
+    # Create zero-offset view on a +Malloc+ object
+    #
+    # @param [Malloc] ptr A +Malloc+ object with the raw data.
+    #
+    # @private
     def initialize( ptr )
       super ptr
     end
 
+    # Read an element from the memory
+    #
+    # @param [Type] typecode Information for converting native data type to
+    # a Ruby object.
+    # @return [Object] The element from the memory.
+    #
+    # @see #store
+    # @see List#load
+    # @private
     def load( typecode )
       typecode.unpack export( typecode.bytesize )
     end
 
+    # Write an element to the memory
+    #
+    # @param [Type] typecode Information for converting Ruby object to native
+    # data type.
+    # @return [Object] Returns the parameter +value+.
+    #
+    # @see #load
+    # @see List#store
+    # @private
     def store( typecode, value )
       import typecode.pack( value )
+      value
     end
 
+    # Write multiple elements to memory
+    #
+    # @param [String] data A ruby string with data to write to memory.
+    # @return [String] The parameter +data+.
+    #
+    # @see #export
+    # @see List#import
+    # @private
     def import( data )
       @data.write data
     end
 
+    # Read multiple elements from memory
+    #
+    # @param [Integer] bytesize Number of bytes to read from memory.
+    # @return [String] A Ruby string with the resulting data.
+    #
+    # @see #import
+    # @see List#export
+    # @private
     def export( bytesize )
       @data.read bytesize
     end
 
+    # Create a new view with the specified offset
+    #
+    # @param [Integer] offset A non-negative offset.
+    # @return [Memory] A new view for the specified part of the memory.
+    #
+    # @see List#+
+    # @private
     def +( offset )
       Memory.new @data + offset
     end

data/lib/multiarray/multiarray.rb

@@ -4,6 +4,19 @@ module Hornetseye
 
     class << self
 
+      # Create a multi-dimensional array
+      #
+      # Creates a multi-dimensional array with elements of type
+      # +element_type+ and dimensions +*shape+.
+      #
+      # @param [Class] element_type Element type of the array. Should derive
+      # from +Type+.
+      # @param [Array<Integer>] *shape The dimensions of the array.
+      # @return [Type,Sequence_] An array with the specified element type and
+      # the specified dimensions.
+      #
+      # @see #MultiArray
+      # @see Sequence.new
       def new( element_type, *shape )
         Hornetseye::MultiArray( element_type, *shape ).new
       end
@@ -12,6 +25,18 @@ module Hornetseye
 
   end
 
+  # Create a multi-dimensional array class
+  #
+  # Creates a multi-dimensional array class with elements of type
+  # +element_type+ and dimensions +*shape+.
+  #
+  # @param [Class] element_type Element type of the array type. Should derive
+  # from +Type+.
+  # @param [Array<Integer>] *shape The dimensions of the array type.
+  # @return [Class] A class deriving from +Type+ or +Sequence_+.
+  #
+  # @see MultiArray.new
+  # @see #Sequence
   def MultiArray( element_type, *shape )
     if shape.empty?
       element_type

data/lib/multiarray/sequence.rb

@@ -4,6 +4,18 @@ module Hornetseye
 
     class << self
 
+      # Create a one-dimensional array
+      #
+      # Create an array with +num_elements+ elements of type +element_type+.
+      #
+      # @param [Class] element_type Element type of the array. Should derive
+      # from +Type+.
+      # @param [Integer] num_elements Number of elements of the array.
+      # @return [Sequence_] An array with the specified element type and the
+      # specified number of elements.
+      #
+      # @see #Sequence
+      # @see MultiArray.new
       def new( element_type, num_elements )
         Hornetseye::Sequence( element_type, num_elements ).new
       end
@@ -12,6 +24,23 @@ module Hornetseye
 
   end
 
+  # Create a class deriving from +Sequence_+
+  #
+  # The parameters +element_type+, +num_elements+, and +stride+ are assigned
+  # to the corresponding attributes of the resulting class.
+  #
+  # @param [Class] element_type Element type of the array type. Should derive
+  # from +Type+.
+  # @param [Integer] num_elements Number of elements of the array type.
+  # @param [Integer] stride Optional stride size for transposed or
+  # non-contiguous array types.
+  # @return [Class] A class deriving from +Sequence_+.
+  #
+  # @see Sequence.new
+  # @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

@@ -1,21 +1,50 @@
 module Hornetseye
 
+  # Abstract class for representing multi-dimensional arrays
+  #
+  # @see #Sequence
+  # @see #MultiArray
+  # @see Sequence
+  # @see MultiArray
+  #
+  # @abstract
   class Sequence_ < CompositeType
 
     class << self
 
+      # Distance of two consecutive elements divided by size of single element
+      #
+      # @return [Integer] Stride size to iterate over array.
+      #
+      # @see #Sequence
+      # @see List#+
+      # @see Memory#+
+      #
+      # @private
       attr_accessor :stride
 
+      # Get string with information about this type
+      #
+      # @return [String] Information about this array type.
       def inspect
         to_s
       end
 
+      # Get default value for this array type.
+      #
+      # @return [Sequence_] Returns a multi-dimensional array filled with the
+      # default value of the element type.
+      #
+      # @private
       def default
         retval = new
         retval.set
         retval
       end
 
+      # Get string with information about this type
+      #
+      # @return [String] Information about this array type.
       def to_s
         if element_type
           shortcut = element_type < Sequence_ ? 'MultiArray' : 'Sequence'
@@ -30,24 +59,47 @@ module Hornetseye
         end
       end
 
+      # Returns the element type of this array
+      #
+      # @return [Class] Returns +element_type.typecode+.
       def typecode
         element_type.typecode
       end
 
+      # Check whether arrays of this type are empty or not
+      #
+      # @return [FalseClass,TrueClass] Returns boolean indicating whether
+      # arrays of this type are empty or not.
       def empty?
         num_elements == 0
       end
 
+      # Get shape of multi-dimensional array
+      #
+      # @return [Array<Integer>] Ruby array with the shape of this array type.
       def shape
         element_type.shape + [ num_elements ]
       end
 
     end
 
+    # Distance of two consecutive elements divided by size of single element
+    #
+    # @return [Integer] Stride size to iterate over array.
+    #
+    # @see #Sequence
+    # @see List#+
+    # @see Memory#+
+    #
+    # @private
     def stride
       self.class.stride
     end
 
+    # Display type and values of this array
+    #
+    # @return [String] Returns string with information about the type and the
+    # values of this array.
     def inspect( indent = nil, lines = nil )
       if indent
         prepend = ''
@@ -96,10 +148,16 @@ module Hornetseye
       prepend + retval
     end
 
+    # Display values of this array
+    #
+    # @return [String] Returns string with the values of this array.
     def to_s
       to_a.to_s
     end
 
+    # Convert to Ruby array
+    #
+    # @return [Array<Object>] Result of the conversion.
     def to_a
       ( 0 ... num_elements ).collect do |i|
         x = at i

data/lib/multiarray/sequence_operation.rb

@@ -1,7 +1,9 @@
 module Hornetseye
 
+  # @private
   module SequenceOperation
 
+    # @private
     def set( value = typecode.default )
       if value.is_a? Array
         for i in 0 ... num_elements
@@ -13,10 +15,12 @@ module Hornetseye
       value
     end
 
+    # @private
     def get
       self
     end
 
+    # @private
     def sel( *indices )
       if indices.empty?
         super *indices
@@ -30,6 +34,7 @@ module Hornetseye
       end
     end
 
+    # @private
     def op( *args, &action )
       for i in 0 ... num_elements
         sub_args = args.collect do |arg|

data/lib/multiarray/storage.rb

@@ -1,9 +1,19 @@
 module Hornetseye
 
+  # Abstract class inherited by +Memory+ and +List+
+  #
+  # @see Memory
+  # @see List
+  #
+  # @private
+  # @abstract
   class Storage
 
-    attr_reader :ptr
-
+    # Create storage object based on raw data or Ruby array
+    #
+    # @param [Malloc,Array] data Delegate object for storing the data.
+    #
+    # @private
     def initialize( data )
       @data = data
     end

data/lib/multiarray/type.rb

@@ -1,91 +1,199 @@
 module Hornetseye
 
+  # This class is used to map Ruby objects to native data types
+  #
+  # @abstract
   class Type
 
     class << self
 
+      # Allocate +Storage+ object for storing a value
+      #
+      # @return [Storage] Object for storing a value of this type.
+      #
+      # @private
       def alloc
         memory.alloc bytesize
       end
 
+      # Create new instance viewing the data of the indicated +Storage+ object
+      #
+      # @return [Type] Object of this class.
+      #
+      # @private
       def wrap( memory )
-        new :memory => memory
+        new nil, :memory => memory
       end
 
+      # Returns the element type for arrays. Otherwise it returns +self+
+      #
+      # @return [Class] Returns +self+.
       def typecode
         self
       end
 
+      # Returns the element type for arrays and composite numbers
+      #
+      # Otherwise it returns +self+.
+      #
+      # @return [Class] Returns +self+.
+      #
+      # @private
       def basetype
         self
       end
 
+      # Check whether an array is empty or not
+      #
+      # Returns +false+ if this is not an array.
+      #
+      # @return [FalseClass,TrueClass] Returns +false+.
       def empty?
         size == 0
       end
 
+      # Get shape of multi-dimensional array
+      #
+      # Returns +[]+ if this is not an array.
+      #
+      # @return [Array<Integer>] Returns +[]+.
       def shape
         []
       end
 
+      # Get number of elements of multi-dimensional array
+      #
+      # Returns +1+ if this is not an array.
+      #
+      # @return [Integer] Number of elements of array. +1+ if this is not an
+      # array.
       def size
         shape.inject( 1 ) { |a,b| a * b }
       end
 
     end
 
+    # Get +Storage+ object used to store the data of this instance
+    #
+    # @return [Storage]
+    #
+    # @private
     attr_accessor :memory
 
+    # Get number of bytes memory required to store the data of an instance
+    #
+    # @return [Integer] Number of bytes.
+    #
+    # @private
     def bytesize
       self.class.bytesize
     end
 
+    # Returns the element type for arrays
+    #
+    # Otherwise it returns +self.class+.
+    #
+    # @return [Class] Element type for arrays. Returns +self.class+ if this is
+    # not an array.
     def typecode
       self.class.typecode
     end
 
+    # Returns the element type for arrays and composite numbers
+    #
+    # Otherwise it returns +self.class+.
+    #
+    # @return [Class] Element type for arrays and composite numbers. Returns
+    # +self.class+ if this is not an array.
+    #
+    # @private
     def basetype
       self.class.basetype
     end
     
+    # Check whether an array is empty or not
+    #
+    # Returns +false+ if this is not an array.
+    #
+    # @return [FalseClass,TrueClass] Returns boolean indicating whether the
+    # array is empty or not. Returns +false+ if this is not an array.
     def empty?
       self.class.empty?
     end
 
+    # Get shape of multi-dimensional array
+    #
+    # Returns +[]+ if this is not an array.
+    #
+    # @return [Array<Integer>] Returns shape of array or +[]+ if this is not
+    # an array.
     def shape
       self.class.shape
     end
 
+    # Get number of elements of multi-dimensional array
+    #
+    # Returns +1+ if this is not an array.
+    #
+    # @return [Integer] Number of elements of array. +1+ if this is not an
+    # array.
     def size
       self.class.size
     end
 
-    def initialize( *args )
-      options = args.last.is_a?( Hash ) ? args.pop : {}
-      raise ArgumentError.new( 'Too many arguments' ) unless args.size <= 1
-      value = args.empty? ? nil : args.first
+    # Create new instance of this type
+    #
+    # @param value [Object] Optional initial value for this instance.
+    # @option options [Storage] :memory (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
       set value unless value.nil?
     end
 
+    # Display type and value of this instance
+    #
+    # @return [String] Returns string with information about type and value.
     def inspect
       "#{self.class.inspect}(#{to_s})"
     end
 
+    # Display value of this instance
+    #
+    # @return [String] Returns string with the value of this instance.
     def to_s
       get.to_s
     end
 
+    # Convert value of this instance to array
+    #
+    # @return [Array] Result of calling +to_a+ on value of this instance.
     def to_a
       get.to_a
     end
 
+    # Retrieve element of array
+    #
+    # @param *indices [Array<Integer>] Index/indices to access element.
+    # @return [Object,Type] Ruby object with value of element.
+    #
+    # @see #[]
     def at( *indices )
       sel( *indices ).get
     end
 
     alias_method :[], :at
 
+    # Assign value to element of array
+    #
+    # @param *args [Array<Integer,Object>] Index/indices to access element.
+    # The last element of +args+ is the new value to store in the array.
+    #
+    # @return [Object] Returns +args.last+.
     def assign( *args )
       sel( *args[ 0 ... -1 ] ).set args.last
     end

data/lib/multiarray/type_operation.rb

@@ -1,20 +1,25 @@
 module Hornetseye
 
+  # @private
   module TypeOperation
 
+    # @private
     def set( value = typecode.default )
       @memory.store self.class, value
       value
     end
 
+    # @private
     def get
       @memory.load self.class
     end
 
+    # @private
     def sel
       self
     end
 
+    # @private
     def op( *args, &action )
       instance_exec *args, &action
       self

data/source.gemspec

@@ -1,7 +1,7 @@
 require 'date'
 Gem::Specification.new do |s|
   s.name = %q{multiarray}
-  s.version = '0.2.2'
+  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}
@@ -9,7 +9,8 @@ Gem::Specification.new do |s|
   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' ] +
+  s.files = [ 'source.gemspec', 'Makefile', 'README', 'COPYING',
+              '.document' ] +
               Dir.glob( 'lib/*.rb' ) +
               Dir.glob( 'lib/multiarray/*.rb' ) +
               Dir.glob( 'test/*.rb' )
@@ -17,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = [ 'lib' ]
   s.rubyforge_project = %q{hornetseye}
   s.has_rdoc = 'yard'
-  # s.extra_rdoc_files = [ 'README' ]
-  # s.rdoc_options = %w{--exclude=/Makefile|.*\.(rb)/ --main README}
+  s.extra_rdoc_files = []
+  s.rdoc_options = %w{--no-private}
   s.add_dependency %q<malloc>, [ '~> 0.2' ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: multiarray
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -35,30 +35,32 @@ files:
 - Makefile
 - README
 - COPYING
+- .document
 - lib/multiarray.rb
 - lib/multiarray/sequence_.rb
-- lib/multiarray/storage.rb
-- lib/multiarray/type_operation.rb
-- lib/multiarray/list.rb
-- lib/multiarray/sequence.rb
-- lib/multiarray/int_.rb
-- lib/multiarray/multiarray.rb
 - lib/multiarray/composite_type.rb
-- lib/multiarray/type.rb
+- lib/multiarray/multiarray.rb
+- lib/multiarray/sequence.rb
+- lib/multiarray/list.rb
 - lib/multiarray/descriptortype.rb
-- lib/multiarray/sequence_operation.rb
+- lib/multiarray/type_operation.rb
+- lib/multiarray/int.rb
+- lib/multiarray/type.rb
+- lib/multiarray/storage.rb
+- lib/multiarray/int_.rb
 - lib/multiarray/memory.rb
-- test/tc_sequence.rb
+- lib/multiarray/sequence_operation.rb
 - test/tc_multiarray.rb
 - test/ts_multiarray.rb
 - test/tc_int.rb
+- test/tc_sequence.rb
 has_rdoc: yard
 homepage: http://wedesoft.github.com/multiarray/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --no-private
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -81,6 +83,6 @@ signing_key:
 specification_version: 3
 summary: Multi-dimensional and uniform Ruby arrays
 test_files: 
-- test/tc_sequence.rb
 - test/tc_multiarray.rb
 - test/tc_int.rb
+- test/tc_sequence.rb