flex_array 0.2.0 → 0.3.0

data/lib/flex_array/integer.rb

@@ -1,5 +1,3 @@
-require_relative 'spec_component'
-
 #Extensions to Integer needed to support flex array.
 class Integer
   #Convert this integer to a limits component.
@@ -14,7 +12,7 @@ class Integer
       fail ArgumentError, "Invalid flex array dimension: #{self.inspect}"
     end
   end
-  
+
   #Convert this integer to an range index against the spec.
   #<br>Parameters
   #* spec - The spec component used to validate this index.
@@ -24,7 +22,7 @@ class Integer
   #* IndexError if the range is not valid.
   def to_index_range(spec)
     alter_ego = (self >= 0) ? self : (spec.max + self + 1)
-  
+
     if spec === alter_ego
       alter_ego..alter_ego
     else

data/lib/flex_array/object.rb

@@ -1,5 +1,3 @@
-require_relative 'spec_component'
-
 #Extensions to Object needed to support flex array.
 class Object
   #Fail with message since the array dimension is invalid.
@@ -10,7 +8,7 @@ class Object
   def to_spec_component(_stride)
     fail ArgumentError, "Invalid flex array dimension: #{self.inspect}"
   end
-  
+
   #Convert this object to an range index against the spec.
   #<br>Parameters
   #* spec - The spec component used to validate this index.
@@ -25,5 +23,5 @@ class Object
       fail IndexError, "Invalid subscript: #{self.inspect}"
     end
   end
-  
+
 end

data/lib/flex_array/range.rb

@@ -1,5 +1,3 @@
-require_relative 'spec_component'
-
 #Extensions to Range needed to support flex array.
 class Range
   #Convert this integer to a limits component.
@@ -9,7 +7,7 @@ class Range
   #* A SpecComponent object with the same range as self.
   def to_spec_component(stride)
     min = self.min
-    
+
     if self == (0...0)
       SpecComponent.new(0...0, stride)
     elsif !self.none? && min.is_a?(Integer) && (min >= 0) && self.max.is_a?(Integer)
@@ -18,7 +16,7 @@ class Range
       fail ArgumentError, "Invalid flex array dimension: #{self.inspect}"
     end
   end
-  
+
   #Convert this range to an range index against the spec.
   #<br>Parameters
   #* spec - The spec component used to validate this index.
@@ -27,16 +25,14 @@ class Range
   #<br>Exceptions
   #* IndexError if the range is not valid.
   def to_index_range(spec)
-    self_min, self_max, spec_max = self.min, self.max, spec.max
-    
-    if self_min < 0 && self_max < 0
-      alter_ego = (spec_max + self_min + 1)..(spec_max + self_max + 1)
-    else
-      alter_ego = self
-    end
-    
-    if spec === alter_ego.min && spec === alter_ego.max
-      alter_ego
+    self_min, self_max, spec_max = self.begin, self.end, spec.max
+    self_max -= 1 if self_max > 0 && self.exclude_end?
+
+    self_min = spec_max + self_min + 1 if self_min < 0
+    self_max = spec_max + self_max + 1 if self_max < 0
+
+    if spec === self_min && spec === self_max && self_min < self_max
+      self_min..self_max
     else
       fail IndexError, "Subscript out of range: #{self.inspect}"
     end

data/lib/flex_array/spec_array.rb

@@ -0,0 +1,47 @@
+#This helper class encapsulates an array of flex array spec components.
+class SpecArray < Array
+  #The number of elements defined by this array specification.
+  attr_reader :spec_count
+
+  #The number of dimensions specified by this specification
+  alias spec_dimensions length
+
+  #Create a flex array specification.
+  #<br>Parameters
+  #* array_specs - The specification of the flex array subscript limits.
+  #  These can either be an array of containing integers, in which case
+  #  the limits are 0...n or they can be ranges, in which case the
+  #  limits are those of the range.
+  def initialize(array_specs)
+    super(0)
+    @spec_count = 1
+
+    #Parse the array limits.
+    array_specs.reverse_each do |spec|
+      self.insert(0, spec.to_spec_component(@spec_count))
+      @spec_count *= self[0].span
+    end
+
+    self
+  end
+
+  #Is this array specification transposed in any way?
+  def transposed?
+    check = 1
+
+    self.reverse_each do |component|
+      return true unless check == component.stride
+      check *= component.span
+    end
+
+    false
+  end
+
+  #Enlarge the flex array along its first dimension.
+  def enlarge(growth)
+    self[0].enlarge(growth)
+
+    #Compute the new size.
+    @spec_count = self.inject(1) {|product, element| product*element.span}
+  end
+end

data/lib/flex_array/spec_component.rb

@@ -2,11 +2,11 @@
 class SpecComponent
   #The range of acceptable values for this limit.
   attr_reader :range
-  
+
   #The stride of this array dimension. That is, for each step in this
   #dimension, how many steps are required in the low level array?
   attr_reader :stride
-  
+
   #Create a limits component from its constituent data.
   #<br>Parameters
   #* range - the range of values for this index limit.
@@ -14,34 +14,34 @@ class SpecComponent
   def initialize(range, stride)
     @range, @stride = range, stride
   end
-  
+
   #Forward '=== value' to the range.
   def ===(value)
     @range === value
   end
-  
+
   #Limits are equal if their ranges are equal.
   #<br>Returns
   #* true if the spec components have equal ranges.
   def ==(other)
     @range == other.range
   end
-  
+
   #Forward 'min' to the range.
   def min
     @range.min
   end
-  
+
   #Forward 'max' to the range.
-  def max 
+  def max
     @range.max
   end
-  
+
   #Forward 'each' and the block to the range.
   def each(&block)
     @range.each(&block)
   end
-  
+
   #Compute the span of indexes in this limit component.
   #<br>Returns
   #* The span of the range or zero if there is none.
@@ -52,7 +52,7 @@ class SpecComponent
       @range.max - @range.min + 1
     end
   end
-  
+
   #Enlarge the range of this spec by the growth term.
   def enlarge(growth)
     if @range.none?
@@ -61,7 +61,7 @@ class SpecComponent
       @range = (@range.min)..(@range.max + growth)
     end
   end
-  
+
   #Compute the step required for the index value.
   #<br>Returns
   #* The number of array cells to be skipped for this index.

data/rakefile.rb

@@ -4,7 +4,7 @@ require 'rdoc/task'
 
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.rdoc_files = ["lib/flex_array.rb", 
+  rdoc.rdoc_files = ["lib/flex_array.rb",
                      "lib/flex_array/flex_array_new.rb",
                      "lib/flex_array/flex_array_index.rb",
                      "lib/flex_array/flex_array_each.rb",
@@ -13,10 +13,12 @@ RDoc::Task.new do |rdoc|
                      "lib/flex_array/flex_array_transpose.rb",
                      "lib/flex_array/flex_array_process.rb",
                      "lib/flex_array/flex_array_validate.rb",
+                     "lib/flex_array/flex_array_forever.rb",
                      "lib/flex_array/object.rb",
                      "lib/flex_array/integer.rb",
                      "lib/flex_array/range.rb",
                      "lib/flex_array/array.rb",
+                     "lib/flex_array/spec_array.rb",
                      "lib/flex_array/spec_component.rb",
                      "license.txt", "README.txt"]
   rdoc.options << '--visibility' << 'private'
@@ -24,6 +26,7 @@ end
 
 Rake::TestTask.new do |t|
   t.test_files = ["tests/spec_component_test.rb",
+                  "tests/spec_array_test.rb",
                   "tests/object_test.rb",
                   "tests/integer_test.rb",
                   "tests/range_test.rb",
@@ -40,5 +43,22 @@ Rake::TestTask.new do |t|
 end
 
 task :reek do |t|
-  `reek lib > reek.txt`
+  `reek --no-color lib > reek.txt`
+end
+
+def eval_puts(str)
+  puts str
+  eval str
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require_relative 'lib/flex_array'
+  eval_puts "@a = FlexArray.new([2,3,4]) {|i| i.clone}"
+  eval_puts "@b = FlexArray.new([2,3,4]) {|i| (i[0]+i[2])*(i[1] + i[2])}"
+  eval_puts "@c = FlexArray.new([0,3])"
+  eval_puts "@d = FlexArray.new([3,3]) {|i| i[0]*3 + i[1]}"
+  ARGV.clear
+  IRB.start
 end

data/reek.txt

@@ -1,29 +1,2 @@
-lib/flex_array.rb -- 0 warnings
-lib/flex_array/array.rb -- 0 warnings
-lib/flex_array/flex_array_append.rb -- 0 warnings
-lib/flex_array/flex_array_each.rb -- 11 warnings:
-  [91, 94]:FlexArray#_each_raw calls process_indexes(indexes) twice (DuplicateMethodCall)
-  [94]:FlexArray#_each_raw contains iterators nested 2 deep (NestedIterators)
-  [41, 44]:FlexArray#cycle calls @array_data[posn] twice (DuplicateMethodCall)
-  [41, 44]:FlexArray#cycle calls process_indexes(indexes) twice (DuplicateMethodCall)
-  [44]:FlexArray#cycle contains iterators nested 3 deep (NestedIterators)
-  [18, 21]:FlexArray#each calls @array_data[posn] twice (DuplicateMethodCall)
-  [18, 21]:FlexArray#each calls process_indexes(indexes) twice (DuplicateMethodCall)
-  [21]:FlexArray#each contains iterators nested 2 deep (NestedIterators)
-  [65, 68]:FlexArray#each_with_index calls @array_data[posn] twice (DuplicateMethodCall)
-  [65, 68]:FlexArray#each_with_index calls process_indexes(indexes) twice (DuplicateMethodCall)
-  [68]:FlexArray#each_with_index contains iterators nested 2 deep (NestedIterators)
-lib/flex_array/flex_array_index.rb -- 0 warnings
-lib/flex_array/flex_array_new.rb -- 0 warnings
-lib/flex_array/flex_array_process.rb -- 3 warnings:
-  [89]:FlexArray#process_all_worker has approx 7 statements (TooManyStatements)
-  [47]:FlexArray#process_indexes_worker has 4 parameters (LongParameterList)
-  [47]:FlexArray#process_indexes_worker has approx 9 statements (TooManyStatements)
-lib/flex_array/flex_array_reshape.rb -- 0 warnings
-lib/flex_array/flex_array_transpose.rb -- 0 warnings
-lib/flex_array/flex_array_validate.rb -- 0 warnings
-lib/flex_array/integer.rb -- 0 warnings
-lib/flex_array/object.rb -- 0 warnings
-lib/flex_array/range.rb -- 0 warnings
-lib/flex_array/spec_component.rb -- 0 warnings
-14 total warnings
+
+0 total warnings

data/tests/array_test.rb

@@ -1,24 +1,24 @@
-require_relative '../lib/flex_array/array'
+require_relative '../lib/flex_array'
 require          'minitest/autorun'
 
 class ArrayTester < MiniTest::Unit::TestCase
   $do_this_only_one_time = "" unless defined? $do_this_only_one_time
-  
+
   def initialize(*all)
     if $do_this_only_one_time != __FILE__
       puts
-      puts "Running test file: #{File.split(__FILE__)[1]}" 
+      puts "Running test file: #{File.split(__FILE__)[1]}"
       $do_this_only_one_time = __FILE__
     end
-    
+
     super(*all)
   end
 
   def test_the_limits_method
     test = [1,2,3,4,5,6]
-    assert_equal([0...6], test.limits)   
+    assert_equal([0...6], test.limits)
   end
-  
+
   def test_the_array_specs_method
     test = [1,2,3,4,5,6].array_specs
     assert_equal(1, test.length)
@@ -26,37 +26,32 @@ class ArrayTester < MiniTest::Unit::TestCase
     assert_equal(0...6, test[0].range)
     assert_equal(1, test[0].stride)
   end
-  
+
   def test_the_array_data_method
     test = [1,2,3,4,5,6]
     assert_equal(test, test.array_data)
     assert_equal(test.object_id, test.array_data.object_id)
   end
-  
+
   def test_the_count_method
     test = [1,2,3,4,5,6]
     assert_equal(test.count, 6)
     assert_equal(test.count, test.length)
   end
-  
+
   def test_the_to_index_range_method
     spec = SpecComponent.new(0...10, 1)
-    
-    assert_equal(0..0, [0,0].to_index_range(spec))
-    assert_equal(9..9, [9,9].to_index_range(spec))
-    assert_equal(0..9, [0,9].to_index_range(spec))
-    
-    assert_equal(0..9, [0,-1].to_index_range(spec))
-    assert_equal(1..8, [1,-2].to_index_range(spec))
-    assert_equal(8..9, [-2,-1].to_index_range(spec))
-    
-    assert_raises(IndexError) { [0,9,0].to_index_range(spec) }
-    assert_raises(IndexError) { [9,0].to_index_range(spec) }
-    assert_raises(IndexError) { [-1,-2].to_index_range(spec) }
+
+    assert_equal([0], [0].to_index_range(spec))
+    assert_equal([9,9], [9,9].to_index_range(spec))
+    assert_equal([0,9], [0,9].to_index_range(spec))
+
+    assert_equal([0, 9], [0,-1].to_index_range(spec))
+    assert_equal([1, 8], [1,-2].to_index_range(spec))
+    assert_equal([8, 9], [-2,-1].to_index_range(spec))
+
     assert_raises(IndexError) { [0,10].to_index_range(spec) }
-    
-    assert_raises(TypeError) { [].to_index_range(spec) }
-    assert_raises(TypeError) { [0].to_index_range(spec) }
+
     assert_raises(TypeError) { [:one, :two].to_index_range(spec) }
   end
 end

data/tests/flex_array_append_test.rb

@@ -3,14 +3,14 @@ require          'minitest/autorun'
 
 class FlexArrayAppendTester < MiniTest::Unit::TestCase
   $do_this_only_one_time = "" unless defined? $do_this_only_one_time
-  
+
   def initialize(*all)
     if $do_this_only_one_time != __FILE__
       puts
-      puts "Running test file: #{File.split(__FILE__)[1]}" 
+      puts "Running test file: #{File.split(__FILE__)[1]}"
       $do_this_only_one_time = __FILE__
     end
-    
+
     super(*all)
   end
 
@@ -18,13 +18,13 @@ class FlexArrayAppendTester < MiniTest::Unit::TestCase
     f = FlexArray.new([1,3], "Title")
     assert_equal(2, f.dimensions)
     assert_equal([0...1, 0...3], f.limits)
-    
+
     f << [1,2,3]
     assert_equal(2, f.dimensions)
     assert_equal([0..1, 0...3], f.limits)
     a = ["Title","Title","Title",1,2,3]
     assert_equal(a, f.array_data)
-    
+
     g = FlexArray.new_from_array([4,5,6])
     f << g
     assert_equal(2, f.dimensions)
@@ -37,7 +37,7 @@ class FlexArrayAppendTester < MiniTest::Unit::TestCase
     f = FlexArray.new([0,3])
     assert_equal(2, f.dimensions)
     assert_equal([0...0, 0...3], f.limits)
-    
+
     f << [1,2,3]
     assert_equal(2, f.dimensions)
     assert_equal([0...1, 0...3], f.limits)
@@ -55,11 +55,11 @@ class FlexArrayAppendTester < MiniTest::Unit::TestCase
     f = FlexArray.new([1,3], "Title")
     assert_raises(ArgumentError) { f << [3,4] }
     assert_raises(ArgumentError) { f << [1,2,3,4] }
-    
+
     g = FlexArray.new([1,2], "Title")
     assert_raises(ArgumentError) { f << g }
   end
-  
+
   def test_the_copy_data_method
     f = FlexArray.new([2,3], "Title")
     g = FlexArray.new([2,3], "Fight")
@@ -67,12 +67,12 @@ class FlexArrayAppendTester < MiniTest::Unit::TestCase
     assert_equal(f.array_data, g.array_data)
     assert(f.array_data.object_id != g.array_data.object_id)
   end
-  
+
   def test_copy_data_method_failures
     f = FlexArray.new([2,3], "Title")
     g = FlexArray.new([2,4], "Fight")
     assert_raises(ArgumentError) { f.copy_data(g) }
-    
+
     g = FlexArray.new([1,3], "Fight")
     assert_raises(ArgumentError) { f.copy_data(g) }