flex_array 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a2ffc260fe1a786395e26576283e344a772d54
-  data.tar.gz: 2c314b80cac241e0442a61889fa648027ad7daae
+  metadata.gz: 63cdb72eff0521ddcf4d821c6d1cdf901191414a
+  data.tar.gz: 95937c185aa498a223074cac92eb191206e46122
 SHA512:
-  metadata.gz: 85c0c995f99a42f39d5f401adcddb67e7a09103c7ff931fb5e23cb71230cb92dc35d94958b5bb201fbda321099f907a7e3e6a4d97e5cb717e8387c56a4e5712a
-  data.tar.gz: 4663bc54d8d906df52e03492100848e9f51cb9301ae4fabfa5b06480bc1d78b979467d1b4df1f39a4633284d3ca892ca20ae5768c31e7dbaf7575900efb165f0
+  metadata.gz: c1a80120b2cabf12997f3f735f31a949e5d91d6f1a74a4bfbd54cb5f0f19dc9cc925062d55af30f72a69b218197b52086f702e925afd9fb7b7e4d626e48b23ea
+  data.tar.gz: 9edda6248e614cedfe4051e1e5ea1b24dfc6d7dab37a13e9d4089c0f844009d14c22942488b28e68010dc7b0d3178e070881732bb47dd3ea78ea7e56d18e1f3c

data/.gitignore

@@ -2,19 +2,4 @@
 *.zip
 *.tmp
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.reek.yml

@@ -0,0 +1,17 @@
+---
+
+### Generic smell configuration
+
+detectors:
+
+  TooManyStatements:
+    max_statements: 7
+
+  InstanceVariableAssumption:
+    enabled: false
+
+  TooManyMethods:
+    enabled: false
+
+  LongParameterList:
+    max_params: 3

data/README.md

@@ -54,3 +54,14 @@ document (.pdf) formats.
 
 Go to the GitHub repository and raise an issue calling attention to some
 aspect that could use some TLC or a suggestion or an idea.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/bench/benchmark.rb

@@ -0,0 +1,243 @@
+#Benchmark studies of flex array.
+
+require 'benchmark'
+require_relative '../lib/flex_array'
+
+puts "Ruby version      = #{RUBY_VERSION}"
+puts "FlexArray version = #{FlexArray::VERSION}"
+puts
+
+enable_creating_tests   = true
+enable_accessing_tests  = true
+
+ct     = 1000
+
+sz  = 10000
+s2d = [100, 100]
+s3d = [10, 10, 100]
+s4d = [10, 10, 10, 10]
+s5d = [5, 5, 4, 10, 10]
+
+c1s = [1..9998]
+c2s = [1..98, 1..98]
+c3s = [1..8, 1..8, 1..98]
+c4s = [1..8, 1..8, 1..8, 1..8]
+c5s = [1..3, 1..3, 1..2, 1..8, 1..8]
+
+
+cyc_ct = ct*sz
+
+
+puts "Creating arrays:"
+puts "=============================================================================="
+
+if enable_creating_tests
+
+  Benchmark.bmbm do |x|
+
+    x.report("Array obj:") {
+      ct.times { Array.new(sz, "cat") }
+    }
+
+    x.report("Flex 1d obj:") {
+      ct.times { FlexArray.new(sz, "cat") }
+    }
+
+    x.report("Flex 2d obj:") {
+      ct.times { FlexArray.new(s2d, "cat") }
+    }
+
+    x.report("Flex 3d obj:") {
+      ct.times { FlexArray.new(s3d, "cat") }
+    }
+
+    x.report("Flex 4d obj:") {
+      ct.times { FlexArray.new(s4d, "cat") }
+    }
+
+    x.report("Flex 5d obj:") {
+      ct.times { FlexArray.new(s5d, "cat") }
+    }
+
+
+    x.report("Array blk:") {
+      ct.times { Array.new(sz) {"cat"} }
+    }
+
+    x.report("Flex 1d blk:") {
+      ct.times { FlexArray.new(sz) {"cat"} }
+    }
+
+    x.report("Flex 2d blk:") {
+      ct.times { FlexArray.new(s2d) {"cat"} }
+    }
+
+    x.report("Flex 3d blk:") {
+      ct.times { FlexArray.new(s3d) {"cat"} }
+    }
+
+    x.report("Flex 4d blk:") {
+      ct.times { FlexArray.new(s4d) {"cat"} }
+    }
+
+    x.report("Flex 5d blk:") {
+      ct.times { FlexArray.new(s5d) {"cat"} }
+    }
+
+
+    src = Array.new(sz, "cat")
+
+    x.report("Flex 1d from:") {
+      ct.times { FlexArray.new_from(sz, src) }
+    }
+
+    x.report("Flex 2d from:") {
+      ct.times { FlexArray.new_from(s2d, src) }
+    }
+
+    x.report("Flex 3d from:") {
+      ct.times { FlexArray.new_from(s3d, src) }
+    }
+
+    x.report("Flex 4d from:") {
+      ct.times { FlexArray.new_from(s4d, src) }
+    }
+
+    x.report("Flex 5d from:") {
+      ct.times { FlexArray.new_from(s5d, src) }
+    }
+  end
+
+else
+  puts "Test disabled."
+end
+
+puts
+
+puts "Accessing arrays:"
+puts "=============================================================================="
+
+if enable_accessing_tests
+  array =     Array.new(sz,  1.0)
+  fa_1d = FlexArray.new(sz,  1.0)
+  fa_2d = FlexArray.new(s2d, 1.0)
+  fa_3d = FlexArray.new(s3d, 1.0)
+  fa_4d = FlexArray.new(s4d, 1.0)
+  fa_5d = FlexArray.new(s5d, 1.0)
+
+  temp = 0.0
+
+  Benchmark.bmbm do |x|
+
+    x.report("Array each:") {
+      ct.times { array.each { |item| temp += item } }
+    }
+
+    x.report("Flex 1d each:") {
+      ct.times { fa_1d.each { |item| temp += item } }
+    }
+
+    x.report("Flex 2d each:") {
+      ct.times { fa_2d.each { |item| temp += item } }
+    }
+
+    x.report("Flex 3d each:") {
+      ct.times { fa_3d.each { |item| temp += item } }
+    }
+
+    x.report("Flex 4d each:") {
+      ct.times { fa_4d.each { |item| temp += item } }
+    }
+
+    x.report("Flex 5d each:") {
+      ct.times { fa_5d.each { |item| temp += item } }
+    }
+
+
+    x.report("Array cycle:") {
+      cyc = array.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 1d cycle:") {
+      cyc = fa_1d.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 2d cycle:") {
+      cyc = fa_2d.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 3d cycle:") {
+      cyc = fa_3d.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 4d cycle:") {
+      cyc = fa_4d.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 5d cycle:") {
+      cyc = fa_5d.cycle
+      cyc_ct.times { temp += cyc.next }
+    }
+
+
+    x.report("Flex 1d cysel:") {
+      cyc = fa_1d.select_cycle(c1s)
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 2d cysel:") {
+      cyc = fa_2d.select_cycle(c2s)
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 3d cysel:") {
+      cyc = fa_3d.select_cycle(c3s)
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 4d cysel:") {
+      cyc = fa_4d.select_cycle(c4s)
+      cyc_ct.times { temp += cyc.next }
+    }
+
+    x.report("Flex 5d cysel:") {
+      cyc = fa_5d.select_cycle(c5s)
+      cyc_ct.times { temp += cyc.next }
+    }
+
+
+    x.report("Array []=:") {
+      ct.times { sz.times { |index| array[index] = 2.0 } }
+    }
+
+    x.report("Flex 1d []=:") {
+      ct.times { fa_1d[:all] = 2.0 }
+    }
+
+    x.report("Flex 2d []=:") {
+      ct.times { fa_2d[:all] = 2.0 }
+    }
+
+    x.report("Flex 3d []=:") {
+      ct.times { fa_3d[:all] = 2.0 }
+    }
+
+    x.report("Flex 4d []=:") {
+      ct.times { fa_4d[:all] = 2.0 }
+    }
+
+    x.report("Flex 5d []=:") {
+      ct.times { fa_5d[:all] = 2.0 }
+    }
+
+  end
+else
+  puts "Test disabled."
+end
+
+puts

data/bench/results.txt

@@ -0,0 +1,97 @@
+Ruby version      = 2.3.3
+FlexArray version = 0.3.5
+
+Creating arrays:
+==============================================================================
+Rehearsal -------------------------------------------------
+Array obj:      0.031000   0.000000   0.031000 (  0.029280)
+Flex 1d obj:    0.032000   0.000000   0.032000 (  0.034108)
+Flex 2d obj:    0.031000   0.016000   0.047000 (  0.042788)
+Flex 3d obj:    0.031000   0.000000   0.031000 (  0.028039)
+Flex 4d obj:    0.031000   0.000000   0.031000 (  0.029970)
+Flex 5d obj:    0.016000   0.000000   0.016000 (  0.031100)
+Array blk:      1.185000   0.016000   1.201000 (  1.249085)
+Flex 1d blk:    6.334000   0.000000   6.334000 (  6.320979)
+Flex 2d blk:    6.599000   0.000000   6.599000 (  6.629046)
+Flex 3d blk:    6.801000   0.000000   6.801000 (  6.820932)
+Flex 4d blk:    8.190000   0.000000   8.190000 (  8.182340)
+Flex 5d blk:    8.269000   0.000000   8.269000 (  8.293787)
+Flex 1d from:   9.750000   0.015000   9.765000 (  9.760498)
+Flex 2d from:   9.999000   0.047000  10.046000 ( 10.037197)
+Flex 3d from:  10.031000   0.047000  10.078000 ( 10.102979)
+Flex 4d from:  11.607000   0.015000  11.622000 ( 11.644530)
+Flex 5d from:  11.590000   0.032000  11.622000 ( 11.630430)
+--------------------------------------- total: 90.715000sec
+
+                    user     system      total        real
+Array obj:      0.031000   0.000000   0.031000 (  0.028856)
+Flex 1d obj:    0.047000   0.000000   0.047000 (  0.041917)
+Flex 2d obj:    0.031000   0.000000   0.031000 (  0.035824)
+Flex 3d obj:    0.016000   0.015000   0.031000 (  0.033661)
+Flex 4d obj:    0.047000   0.000000   0.047000 (  0.040366)
+Flex 5d obj:    0.031000   0.000000   0.031000 (  0.038743)
+Array blk:      1.232000   0.000000   1.232000 (  1.242158)
+Flex 1d blk:    6.381000   0.000000   6.381000 (  6.378779)
+Flex 2d blk:    6.194000   0.031000   6.225000 (  6.481757)
+Flex 3d blk:    6.630000   0.000000   6.630000 (  6.680507)
+Flex 4d blk:    8.112000   0.000000   8.112000 (  8.115420)
+Flex 5d blk:    8.237000   0.000000   8.237000 (  8.228091)
+Flex 1d from:   9.657000   0.016000   9.673000 (  9.716532)
+Flex 2d from:   9.937000   0.000000   9.937000 (  9.999748)
+Flex 3d from:  10.109000   0.015000  10.124000 ( 10.136534)
+Flex 4d from:  11.809000   0.016000  11.825000 ( 11.878319)
+Flex 5d from:  11.685000   0.047000  11.732000 ( 11.723940)
+
+Accessing arrays:
+==============================================================================
+Rehearsal --------------------------------------------------
+Array each:      1.045000   0.000000   1.045000 (  1.049537)
+Flex 1d each:    1.076000   0.000000   1.076000 (  1.075475)
+Flex 2d each:    1.092000   0.000000   1.092000 (  1.086814)
+Flex 3d each:    1.092000   0.000000   1.092000 (  1.096500)
+Flex 4d each:    1.077000   0.000000   1.077000 (  1.081033)
+Flex 5d each:    1.092000   0.000000   1.092000 (  1.084849)
+Array cycle:     4.337000   0.000000   4.337000 (  4.344979)
+Flex 1d cycle:   4.383000   0.000000   4.383000 (  4.375415)
+Flex 2d cycle:   4.353000   0.000000   4.353000 (  4.351397)
+Flex 3d cycle:   4.305000   0.000000   4.305000 (  4.297517)
+Flex 4d cycle:   4.321000   0.000000   4.321000 (  4.337608)
+Flex 5d cycle:   4.400000   0.000000   4.400000 (  4.412436)
+Flex 1d cysel:  10.265000   0.000000  10.265000 ( 10.272564)
+Flex 2d cysel:  10.342000   0.031000  10.373000 ( 10.403735)
+Flex 3d cysel:  10.359000   0.062000  10.421000 ( 10.445309)
+Flex 4d cysel:  11.482000   0.016000  11.498000 ( 11.535809)
+Flex 5d cysel:  12.230000   0.140000  12.370000 ( 12.388114)
+Array []=:       0.983000   0.000000   0.983000 (  0.974042)
+Flex 1d []=:     8.486000   0.000000   8.486000 (  8.487866)
+Flex 2d []=:     8.705000   0.047000   8.752000 (  8.779844)
+Flex 3d []=:     8.923000   0.031000   8.954000 (  8.971719)
+Flex 4d []=:    10.281000   0.047000  10.328000 ( 10.338109)
+Flex 5d []=:    10.296000   0.016000  10.312000 ( 10.406798)
+--------------------------------------- total: 135.315000sec
+
+                     user     system      total        real
+Array each:      1.030000   0.000000   1.030000 (  1.037024)
+Flex 1d each:    1.076000   0.000000   1.076000 (  1.068122)
+Flex 2d each:    1.061000   0.000000   1.061000 (  1.068019)
+Flex 3d each:    1.092000   0.000000   1.092000 (  1.073313)
+Flex 4d each:    1.076000   0.000000   1.076000 (  1.078664)
+Flex 5d each:    1.077000   0.000000   1.077000 (  1.073763)
+Array cycle:     4.336000   0.000000   4.336000 (  4.343807)
+Flex 1d cycle:   4.275000   0.000000   4.275000 (  4.289805)
+Flex 2d cycle:   4.227000   0.000000   4.227000 (  4.248021)
+Flex 3d cycle:   4.197000   0.000000   4.197000 (  4.219823)
+Flex 4d cycle:   4.228000   0.000000   4.228000 (  4.256224)
+Flex 5d cycle:   4.196000   0.015000   4.211000 (  4.273239)
+Flex 1d cysel:   9.890000   0.016000   9.906000 (  9.940829)
+Flex 2d cysel:  10.094000   0.015000  10.109000 ( 10.105926)
+Flex 3d cysel:  10.202000   0.063000  10.265000 ( 10.352745)
+Flex 4d cysel:  11.404000   0.062000  11.466000 ( 11.462466)
+Flex 5d cysel:  11.653000   0.141000  11.794000 ( 11.784468)
+Array []=:       0.967000   0.000000   0.967000 (  0.963400)
+Flex 1d []=:     8.471000   0.031000   8.502000 (  8.527261)
+Flex 2d []=:     8.752000   0.000000   8.752000 (  8.757735)
+Flex 3d []=:     8.892000   0.015000   8.907000 (  9.115369)
+Flex 4d []=:    10.234000   0.016000  10.250000 ( 10.635380)
+Flex 5d []=:    10.374000   0.062000  10.436000 ( 15.463252)
+

data/flex_array.gemspec

@@ -13,25 +13,21 @@ Gem::Specification.new do |s|
   s.version = FlexArray::VERSION
   s.author = ["Peter Camilleri"]
   s.email = "peter.c.camilleri@gmail.com"
-  s.homepage = "http://teuthida-technologies.com/"
+  s.homepage = "https://github.com/PeterCamilleri/flex_array"
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = '>=1.9.3'
 
   s.add_development_dependency "bundler", "~> 1.3"
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'reek', "~> 1.3.8"
+  s.add_development_dependency 'rake', ">= 12.3.3"
+  s.add_development_dependency 'reek', "~> 5.0.2"
   s.add_development_dependency 'minitest', "~> 4.7.5"
-  s.add_development_dependency 'rdoc', "~> 4.0.1"
-  s.add_development_dependency 'minitest_visible', ">= 0.1.0"
 
   s.add_runtime_dependency 'in_array'
 
-  s.files       = `git ls-files`.split($/)
-  s.extra_rdoc_files = ['license.txt']
-  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+  s.files       = `git ls-files`.split($/).select {|f| f !~ /^docs\//}
+  s.test_files  = s.files.grep(%r{^(test)/})
 
   s.license = 'MIT'
-  s.has_rdoc = true
   s.require_paths = ["lib"]
 end
 

data/lib/flex_array.rb

@@ -19,79 +19,62 @@ require_relative 'flex_array/flex_array_each'
 require_relative 'flex_array/flex_array_validate'
 require_relative 'flex_array/flex_array_process'
 
-#\FlexArray - A flexible array class.
-#* flex_array.rb - The root file that gathers up all the flex array parts.
+# A flexible array class.
 class FlexArray
   include InArrayAlready
 
-  #The version of this class.
-  #<br>Returns
-  #* A version string; <major>.<minor>.<step>
+  # The version of this class. "<major>.<minor>.<step>"
   def self.version
     FlexArray::VERSION
   end
 
-  #The version of the class of this instance.
-  #<br>Returns
-  #* A version string; <major>.<minor>.<step>
+  # The version of the class of this instance.
   def version
     FlexArray::VERSION
   end
 
-  #The array specifications. An array of spec components.
+  # The array specifications. An array of spec components.
   attr_accessor :array_specs
 
-  #The underlying array data used by the flex array.
+  # The underlying array data used by the flex array.
   attr_accessor :array_data
 
-  #The total number of elements in this array.
+  # The total number of elements in this array.
   def length
     @array_specs.spec_count
   end
 
   alias size length
 
-  #The number of dimensions in this array.
+  # The number of dimensions in this array.
   def dimensions
     @array_specs.spec_dimensions
   end
 
-  #Is this flex array transposed?
+  # Is this flex array transposed?
   attr_reader :transposed
 
-  #Get the limits of the subscripts of the flex array.
+  # Get the limits of the subscripts of the flex array.
   def limits
     @array_specs.collect {|spec| spec.range }
   end
 
-  #Return this flex array as a flex array!
-  #<br>Returns
-  #* A flex array -- self
+  # Return this flex array as a flex array!
   def to_flex_array
     self
   end
 
-  #Are these FlexArrays equal?
-  #<br>Parameters
-  #* other - The object being tested for equality.
-  #<br>Returns
-  #* true if the flex arrays are equal shape and data.
+  # Are these FlexArrays equal?
   def ==(other)
     self.compatible?(other) && @array_data == other.array_data
   end
 
-  #Make FlexArrays comparable.
-  #<br>Parameters
-  #* other - The object being tested for compariositality.
-  #<br>Returns
-  #* 1 if self > other
-  #* 0 if self = other
-  #* -1 if self < other
+  # Make FlexArrays comparable with the compariositality method.
   def <=>(other)
     @array_data <=> other.array_data
   end
 
-  #Is this flex array empty?
+  # Is this flex array empty?
   def empty?
     length == 0
   end