enumerable-statistics 0.1.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9bbba060f2298fae081d18782b237d693663558c
-  data.tar.gz: f4b5aa2e3bdaed71938a0bb4fb699f9d04daf3e5
+SHA256:
+  metadata.gz: e03fe8a749cc70b480ba4ab50285b63b3829cf88e3b24c1fef315d1db26caebb
+  data.tar.gz: ca1ba053b0aa133190f170a253d16d5153033e37d27851084d2484276ae4da48
 SHA512:
-  metadata.gz: 6b2cc2848db0d8103e09bf770d565be0fcfe360f6dbb45b18ebbbca48027d0f96ae6488a90f3f0ddf3111a82200e14e3b07509f3f7e6cd5ce2fa115350f34224
-  data.tar.gz: 2fdc7b8b992a2194aabd6aa82af286d93d03772f385ed1927f2c412eaf2667dd9c9472a65b438c9a1a9660012a014bd879ec16e5dc934ac76d9a543a936539cd
+  metadata.gz: 5c0f2f284ec0565ee1b15661a1abfed165f4ce26f36a8fd30fd8ca66a0a92d4be118ef114de3d02a2a567688b46f579b06f6704c6f01b4bb02dcb4ebcdb73de4
+  data.tar.gz: a0ba31fe6bdc536cdf7152840cd69e6ef47763904fb4e4cf1ec7498c7748a7d246f7a32c90e1d524bd9932af8df9cb942194db3eb593de6979171c5258c8fd67

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+- push
+
+jobs:
+  cruby:
+    name: Test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        ruby:
+        - 3.0
+        - 2.7
+        - 2.6
+        - 2.5
+        - 2.4
+        - debug
+        exclude:
+        - os: windows-latest
+          ruby: 3.0
+        - os: windows-latest
+          ruby: debug
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - run: gem install bundler
+    - run: bundle install
+
+    - run: rake --trace compile
+
+    - run: rake build
+    - run: gem install pkg/*gem
+
+    - run: rake spec

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+-p templates

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# 2.0.2
+
+- Support Ruby 3.0
+
+# 2.0.1
+
+- Fix a bug of `histogram` (#9)
+
+# 2.0.0
+
+- Add `value_counts` method in Array, Hash, and Enumerable
+- Add `median` method in Array
+- Add `percentile` method in Array
+- Add `histogram` method in Array
+
+# 1.0.1
+
+- Add `mean_variance` method in Array class and Enumerable module
+- Add optimized implementation of `mean_variance` method for a Hash
+- Add the following methods, implemented by using `mean_variance`, in Array class and Enumerable module
+    - `mean`
+    - `variance`
+    - `stddev`
+    - `mean_stddev`
+- Add `sum` method in Array class and Enumerable module when Ruby < 2.4, that is almost same as introduced in Ruby 2.4
+- Add optimized implementation of `sum` method for a Range with integer ends and a Hash, that is almost same as introduced in Ruby 2.4
+
+# 1.0.0
+
+- This version was yanked due to documentation issue

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Kenta Murata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,8 @@
 # Enumerable::Statistics
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/enumerable/statistics`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/mrkn/enumerable-statistics.svg?branch=master)](https://travis-ci.org/mrkn/enumerable-statistics)
 
-TODO: Delete this and the text above, and describe your gem
+Enumerable::Statistics provides some methods to calculate statistical summary in arrays and enumerables.
 
 ## Installation
 
@@ -22,7 +22,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You should load this library by the following line in your script at first.
+
+```ruby
+require 'enumerable/statistics'
+```
+
+The following methods are supplied by this library:
+
+- `Array#mean`, `Enumerable#mean`
+  - Calculates a mean of values in an array or an enumerable
+- `Array#variance`, `Enumerable#variance`
+  - Calculates a variance of values in an array or an enumerable
+- `Array#stdev`, `Enumerable#stdev`
+  - Calculates a standard deviation of values in an array or an enumerable
+- `Array#mean_variance`, `Enumerable#mean_variance`
+  - Calculates a mean and a variance simultaneously
+- `Array#mean_stdev`, `Enumerable#mean_stdev`
+  - Calculates a mean and a standard deviation simultaneously
+- `Array#median`
+  - Calculates a median of values in an array
+- `Array#percentile(q)`
+  - Calculates a percentile or percentiles of values in an array
+- `Array#value_counts`, `Enumerable#value_counts`, and `Hash#value_counts`
+  - Count how many items for each value in the container
+- `Array#histogram`
+  - Calculate histogram of the values in the array
+
+Moreover, for Ruby < 2.4, `Array#sum` and `Enumerable#sum` are provided.
+
+All methods scan a collection once to calculate statistics and preserve precision as possible.
+
+## Performance
+
+```
+$ bundle exec rake bench
+# sum
+Warming up --------------------------------------
+              inject     1.545k i/100ms
+               while     2.342k i/100ms
+                 sum    11.009k i/100ms
+Calculating -------------------------------------
+              inject     15.016k (± 9.6%) i/s -     75.705k in   5.098723s
+               while     22.238k (±16.2%) i/s -    107.732k in   5.068156s
+                 sum    112.992k (± 6.9%) i/s -    572.468k in   5.091868s
+# mean
+Warming up --------------------------------------
+              inject     1.578k i/100ms
+               while     2.057k i/100ms
+                mean     9.855k i/100ms
+Calculating -------------------------------------
+              inject     15.347k (± 8.6%) i/s -     77.322k in   5.076009s
+               while     21.669k (±14.5%) i/s -    106.964k in   5.074312s
+                mean    108.861k (± 8.9%) i/s -    542.025k in   5.021786s
+# variance
+Warming up --------------------------------------
+              inject   586.000  i/100ms
+               while   826.000  i/100ms
+            variance     8.475k i/100ms
+Calculating -------------------------------------
+              inject      6.187k (± 6.7%) i/s -     31.058k in   5.043418s
+               while      8.597k (± 7.4%) i/s -     42.952k in   5.024587s
+            variance     84.702k (± 8.5%) i/s -    423.750k in   5.039936s
+```
+
+![](./images/benchmark.png)
 
 ## Development
 
@@ -32,5 +96,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enumerable-statistics.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrkn/enumerable-statistics.
 

data/Rakefile

@@ -6,4 +6,19 @@ task :default => :spec
 
 Rake::ExtensionTask.new('enumerable/statistics/extension')
 
+directory 'lib/enumerable/statistics'
+
 RSpec::Core::RakeTask.new(:spec)
+
+task :spec => :compile
+
+task :bench do
+  puts "# sum\n"
+  system('benchmark-driver bench/sum.yml')
+
+  puts "# mean\n"
+  system('benchmark-driver bench/mean.yml')
+
+  puts "# variance\n"
+  system('benchmark-driver bench/variance.yml')
+end

data/bench/array_value_counts.yml

@@ -0,0 +1,42 @@
+contexts:
+  - name: "1.1.0.dev"
+    gems:
+      enumerable-statistics: "1.1.0.dev"
+    require: false
+    prelude: |-
+      require 'enumerable/statistics'
+  - name: "HEAD"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  chars = ('a'..'m').to_a
+  ary = Array.new(n) { chars.sample }
+benchmark:
+  inject: |-
+    ary.inject(Hash.new(0)) { |h, x| h[x] += 1; h }
+  unsort_keepna: |-
+    ary.value_counts(sort: false, dropna: false)
+  unsort_dropna: |-
+    ary.value_counts(sort: false, dropna: true)
+  sort_keepna: |-
+    ary.value_counts(sort: true, dropna: false)
+  sort_dropna: |-
+    ary.value_counts(sort: true, dropna: true)
+  norm_unsort_keepna: |-
+    ary.value_counts(normalize: true, sort: false, dropna: false)
+  norm_unsort_dropna: |-
+    ary.value_counts(normalize: true, sort: false, dropna: true)
+  norm_sort_keepna: |-
+    ary.value_counts(normalize: true, sort: true, dropna: false)
+  norm_sort_dropna: |-
+    ary.value_counts(normalize: true, sort: true, dropna: true)
+  sort_asc_keepna: |-
+    ary.value_counts(sort: true, ascending: true, dropna: false)
+  sort_asc_dropna: |-
+    ary.value_counts(sort: true, ascending: true, dropna: true)
+  norm_sort_asc_keepna: |-
+    ary.value_counts(normalize: true, sort: true, ascending: true, dropna: false)
+  norm_sort_asc_dropna: |-
+    ary.value_counts(normalize: true, sort: true, ascending: true, dropna: true)

data/bench/enum_value_counts.yml

@@ -0,0 +1,42 @@
+contexts:
+  - name: "1.1.0.dev"
+    gems:
+      enumerable-statistics: "1.1.0.dev"
+    require: false
+    prelude: |-
+      require 'enumerable/statistics'
+  - name: "HEAD"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  chars = ('a'..'m').to_a
+  enum = Array.new(n) { chars.sample }.each
+benchmark:
+  inject: |-
+    enum.inject(Hash.new(0)) { |h, x| h[x] += 1; h }
+  unsort_keepna: |-
+    enum.value_counts(sort: false, dropna: false)
+  unsort_dropna: |-
+    enum.value_counts(sort: false, dropna: true)
+  sort_keepna: |-
+    enum.value_counts(sort: true, dropna: false)
+  sort_dropna: |-
+    enum.value_counts(sort: true, dropna: true)
+  norm_unsort_keepna: |-
+    enum.value_counts(normalize: true, sort: false, dropna: false)
+  norm_unsort_dropna: |-
+    enum.value_counts(normalize: true, sort: false, dropna: true)
+  norm_sort_keepna: |-
+    enum.value_counts(normalize: true, sort: true, dropna: false)
+  norm_sort_dropna: |-
+    enum.value_counts(normalize: true, sort: true, dropna: true)
+  sort_asc_keepna: |-
+    enum.value_counts(sort: true, ascending: true, dropna: false)
+  sort_asc_dropna: |-
+    enum.value_counts(sort: true, ascending: true, dropna: true)
+  norm_sort_asc_keepna: |-
+    enum.value_counts(normalize: true, sort: true, ascending: true, dropna: false)
+  norm_sort_asc_dropna: |-
+    enum.value_counts(normalize: true, sort: true, ascending: true, dropna: true)

data/bench/hash_value_counts.yml

@@ -0,0 +1,42 @@
+contexts:
+  - name: "1.1.0.dev"
+    gems:
+      enumerable-statistics: "1.1.0.dev"
+    require: false
+    prelude: |-
+      require 'enumerable/statistics'
+  - name: "HEAD"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  chars = ('a'..'m').to_a
+  hash = Array.new(n) { chars.sample }.each_with_index.to_h
+benchmark:
+  inject: |-
+    hash.inject(Hash.new(0)) { |h, (k, v)| h[v] += 1; h }
+  unsort_keepna: |-
+    hash.value_counts(sort: false, dropna: false)
+  unsort_dropna: |-
+    hash.value_counts(sort: false, dropna: true)
+  sort_keepna: |-
+    hash.value_counts(sort: true, dropna: false)
+  sort_dropna: |-
+    hash.value_counts(sort: true, dropna: true)
+  norm_unsort_keepna: |-
+    hash.value_counts(normalize: true, sort: false, dropna: false)
+  norm_unsort_dropna: |-
+    hash.value_counts(normalize: true, sort: false, dropna: true)
+  norm_sort_keepna: |-
+    hash.value_counts(normalize: true, sort: true, dropna: false)
+  norm_sort_dropna: |-
+    hash.value_counts(normalize: true, sort: true, dropna: true)
+  sort_asc_keepna: |-
+    hash.value_counts(sort: true, ascending: true, dropna: false)
+  sort_asc_dropna: |-
+    hash.value_counts(sort: true, ascending: true, dropna: true)
+  norm_sort_asc_keepna: |-
+    hash.value_counts(normalize: true, sort: true, ascending: true, dropna: false)
+  norm_sort_asc_dropna: |-
+    hash.value_counts(normalize: true, sort: true, ascending: true, dropna: true)

data/bench/mean.yml

@@ -0,0 +1,30 @@
+contexts:
+  - name: "master"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  ary = Array.new(n) { rand }
+benchmark:
+  inject: mean = ary.inject(:+) / n.to_f
+  while: |-
+    i, mean = 0, 0
+    while i < n
+      mean += ary[i]
+      i += 1
+    end
+    mean /= n.to_f
+  pure_ruby: |-
+    i, f, c = 0, 0.0, 0.0, 0.0, 0.0
+    while i < n
+      x = ary[i]
+      y = x - c
+      t = f + y
+      c = (t - f) - y
+      f = t
+
+      i += 1
+    end
+    mean = f / n
+  c_ext: mean = ary.mean

data/bench/sum.yml

@@ -0,0 +1,29 @@
+contexts:
+  - name: "master"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  ary = Array.new(n) { rand }
+benchmark:
+  inject: sum = ary.inject(:+)
+  while: |-
+    i, sum = 0, 0
+    while i < n
+      sum += ary[i]
+      i += 1
+    end
+  pure_ruby: |-
+    i, f, c = 0, 0.0, 0.0, 0.0, 0.0
+    while i < n
+      x = ary[i]
+      y = x - c
+      t = f + y
+      c = (t - f) - y
+      f = t
+
+      i += 1
+    end
+    sum = f
+  sum: sum = ary.sum

data/bench/variance.yml

@@ -0,0 +1,39 @@
+contexts:
+  - name: "master"
+    prelude: |-
+      require 'bundler/setup'
+      require 'enumerable/statistics'
+prelude: |-
+  n = 1000
+  ary = Array.new(n) { rand }
+benchmark:
+  inject: |-
+    mean = ary.mean
+    var = ary.inject(0.0) { |sum, x|
+      sum += (x - mean) ** 2
+    } / (n - 1).to_f
+  while: |-
+    mean = ary.mean
+    i, var = 0, 0
+    while i < n
+      var += (ary[i] - mean) ** 2
+      i += 1
+    end
+    var /= n.to_f
+  pure_ruby: |-
+    i, m, m2, f, c = 0, 0.0, 0.0, 0.0, 0.0
+    while i < n
+      x = ary[i]
+      y = x - c
+      t = f + y
+      c = (t - f) - y
+      f = t
+
+      delta = x - m
+      m += delta / i
+      m2 += delta * (x - m)
+
+      i += 1
+    end
+    var = m2 / n
+  c_ext: var = ary.variance