flex_array 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cb0e2598e518e574d21b0a5e5de9dea1189f735b
-  data.tar.gz: e606ee6ff4d0534806f2e3cc7fe2c856165ced56
+SHA256:
+  metadata.gz: 2a0c986a8a3bc388dfa3d0d96afaff0dbcaf55a1749100e73276d3dffc19b370
+  data.tar.gz: a9adeb41ec4608673a3753e29815eaadaeb4997f01a254746f3fadfd53ebc375
 SHA512:
-  metadata.gz: 1681e59f906deebb217eadd4e71b3c1c5f07654e60a3a015a5a15e294b4e048b1e54df2ab2d3c9206604151c2d01991499e8837ed38b3b7db82ffbea37754129
-  data.tar.gz: dc833e48d0c0695d3c94135491bc99f0fbe7d5ce9c35767472b2249262f52b993e25cfcd35ea3b64a2cdd7aa0ae427a0f75d45752b732e708a33b87bda17893d
+  metadata.gz: 9d26f1fa463c4218278794227cb9500ec2dee8ad77809ec3bca733093725915ff05e729a9548e5163989d3c62f48e20d91c4ea0f74e74c8adc0c5e5fa5969c87
+  data.tar.gz: 8a8e88add9c6278457846e0b0d3a4c0ada5560118f3ae783de3e2416045fbfc9197c56c77d2ece1cab195e154b2bc1df236c53e85fce3ab09101e995f90ceef8

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,67 @@
+# The flex array gem.
+
+This project contains the Ruby FlexArray gem. A gem used to facilitate the
+creation and processing of multi-dimensional arrays in a flexible manner.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flex_array'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flex_array
+
+The flex_array gem itself is found at: ( https://rubygems.org/gems/flex_array )
+
+## Usage
+
+Using flex_array in an application can be as simple as:
+```ruby
+require 'flex_array'
+
+arr1 = FlexArray.new([10,10])                       # 10 by 10 of nil
+arr2 = FlexArray.new([10,10], 0)                    # 10 by 10 of zero
+arr2 = FlexArray.new([1..12,1..12]) {|i| i[0]*i[1]} # Times table.
+
+arr2[4..5,4..5] = 42 #Set the middle of the array.
+
+```
+
+A lot more information on the operation of this gem may be found in the docs
+folder in the Flex_Array_UG, available in both open office (.odt) and portable
+document (.pdf) formats.
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/flex_array/fork )
+2. Switch to the development branch ('git branch development')
+3. Create your feature branch ('git checkout -b my-new-feature')
+4. Commit your changes ('git commit -am "Add some feature"')
+5. Push to the branch ('git push origin my-new-feature')
+6. Create new Pull Request
+
+#### Plan B
+
+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)
+