enumerable-statistics 2.0.7 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caf1b8203b177aef325480c7d7d5a4c0ddb7cecdad3d12944d4b2caa71eebe13
-  data.tar.gz: 00d91f25e099eb2577eb1f6078dafb5c884538fe3863eb1b6795de58c0c3b642
+  metadata.gz: 79ac26fd5a37cf391fdc61c8cea73c3b29723ce5b6847f226d131f19279743af
+  data.tar.gz: 239e35a3a9e93f442057e77542611e7c53448ae2c5d418f46441c4c9b0aeecb1
 SHA512:
-  metadata.gz: 2c9ab8a29752eb46cd00bf8f3f9787d6f151bc10e06d2179fa5f80e3ebb4625b96144a49fd907eb52c02e8f88767f9da1717761643d87e1489677a9eab227af9
-  data.tar.gz: de2d3d348ead4d6e99cffdb66f95a56ac7cfe603a4450db23deaddb6eeb82e454f79e84c236ea89142ea334999a82c6c307e16ac7085b1afe2895c63a6a8c5d4
+  metadata.gz: eb0310d69650f1f5c6e9803356e04ba15f2a67741134fb7acdf50462afb95a51c4a1e6d43cd6820f8ab890ebd1b5ceca4b2b0648fd0eb19c1c2a907d2629cc98
+  data.tar.gz: c840a3d0ec6a7393999408d756778aafa2f0d14f271f176cdac590a16f1e81832c220939f311613ec7db05141754f733e561ab318dcae87f3da53e4c052eb35c

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -1,7 +1,11 @@
 name: CI
 
 on:
-- push
+  push:
+    branches:
+      - "**"
+      - "!dependabot/**"
+  pull_request:
 
 jobs:
   cruby:
@@ -12,36 +16,54 @@ jobs:
       fail-fast: false
       matrix:
         os:
-        - ubuntu-latest
-        - macos-latest
-        - windows-latest
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
         ruby:
-        - 3.0
-        - 2.7
-        - 2.6
-        - 2.5
-        - 2.4
-        - debug
+          - 3.4
+          - 3.3
+          - 3.2
+          - 3.1
+          - 3.0
+          - 2.7
+          - 2.6
+          - 2.5
+          - 2.4
+          - debug
         exclude:
-        - os: windows-latest
-          ruby: 3.0
-        - os: windows-latest
-          ruby: debug
+          - os: macos-latest
+            ruby: 2.5
+          - os: macos-latest
+            ruby: 2.4
+          - os: windows-latest
+            ruby: debug
 
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
 
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
 
-    - run: gem install bundler
-    - run: bundle install
+      - name: Detect installable bundler version
+        run: |
+          case "${{ matrix.ruby }}" in
+            2.7|2.6) bundler_version="2.4.22" ;;
+            2.5|2.4) bundler_version="2.3.27" ;;
+            *)       bundler_version="" ;;
+          esac
+          echo "bundler_version=$bundler_version" >> $GITHUB_ENV
+        shell: bash
 
-    - run: rake --trace compile
+      - run: gem install bundler${bundler_version:+ -v $bundler_version}
+        shell: bash
 
-    - run: rake build
-    - run: gem install pkg/*gem
+      - run: bundle install
 
-    - run: rake
+      - run: rake --trace compile
+
+      - run: rake build
+      - run: gem install pkg/*gem
+
+      - run: rake

data/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  github:
+    name: GitHub
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v6
+      - name: Extract release note
+        run: |
+          ruby \
+            -e 'print("## Enumerable::Statistics: "); \
+                puts(ARGF.read.split(/^# /)[1].strip)' \
+            CHANGELOG.md > release-note.md
+      - name: Upload to release
+        run: |
+          title=$(head -n1 release-note.md | sed -e 's/^## //')
+          tail -n +2 release-note.md > release-note-without-version.md
+          gh release create ${GITHUB_REF_NAME} \
+            --discussion-category Announcements \
+            --notes-file release-note-without-version.md \
+            --title "${title}"
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  rubygems:
+    name: RubyGems
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      id-token: write
+    environment: release
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - name: Push gems
+        run: |
+          bundle exec rake release:rubygem_push

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# 2.0.9
+
+- Add missing `#include <float.h>`
+  - [GH-35](https://github.com/red-data-tools/enumerable-statistics/issues/35)
+  - Patch by Tadashi Saito
+- Suppress `method redefined` warnings
+  - [GH-43](https://github.com/red-data-tools/enumerable-statistics/issues/43)
+  - [GH-46](https://github.com/red-data-tools/enumerable-statistics/issues/46)
+  - Reported by forthrin
+  - Patch by kojix2
+
+## Thanks
+
+- Tadashi Saito
+- forthrin
+- kojix2
+
+# 2.0.8
+
+- Prohibit the use of both `nbins` and `edges` kwargs simultaneously in the `histogram` method.
+- Support `skip_na` kwarg in `sum` and related methods.
+- Support Ruby 3.4+.
+
 # 2.0.7
 
 - Fix the bug of histogram with bin range that is smaller than value range

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in enumerable-statistics.gemspec
 gemspec
+
+gem "benchmark-driver"
+gem "bundler"
+gem "fuubar"
+gem "rake"
+gem "rake-compiler", ">= 0.9.8"
+gem "rspec", ">= 3.4"
+gem "test-unit"
+gem "yard"

data/README.md

@@ -1,6 +1,6 @@
 # Enumerable::Statistics
 
-[![Build Status](https://travis-ci.org/mrkn/enumerable-statistics.svg?branch=master)](https://travis-ci.org/mrkn/enumerable-statistics)
+[![Build Status](https://github.com/red-data-tools/enumerable-statistics/actions/workflows/ci.yml/badge.svg)](https://github.com/red-data-tools/enumerable-statistics/actions/workflows/ci.yml)
 
 Enumerable::Statistics provides some methods to calculate statistical summary in arrays and enumerables.
 
@@ -30,6 +30,9 @@ require 'enumerable/statistics'
 
 The following methods are supplied by this library:
 
+- `Array#sum`, `Enumerable#sum`
+  - Calculates a sum of values in an array or an enumerable
+  - Supports `skip_na: true` to skip `nil` and `NaN` values
 - `Array#mean`, `Enumerable#mean`
   - Calculates a mean of values in an array or an enumerable
 - `Array#variance`, `Enumerable#variance`
@@ -96,5 +99,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/mrkn/enumerable-statistics.
+Bug reports and pull requests are welcome on GitHub at https://github.com/red-data-tools/enumerable-statistics.
 

data/Rakefile

@@ -29,3 +29,13 @@ task :bench do
 end
 
 task default: [:test, :spec]
+
+release_task = Rake.application["release"]
+# We use Trusted Publishing.
+release_task.prerequisites.delete("build")
+release_task.prerequisites.delete("release:rubygem_push")
+release_task_comment = release_task.comment
+if release_task_comment
+  release_task.clear_comments
+  release_task.comment = release_task_comment.gsub(/ and build.*$/, "")
+end

data/enumerable-statistics.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Statistics features for Enumerable}
   spec.description   = %q{This library provides statistics features for Enumerable}
-  spec.homepage      = "https://github.com/mrkn/enumerable-statistics"
+  spec.homepage      = "https://github.com/red-data-tools/enumerable-statistics"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -27,12 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rake-compiler", ">= 0.9.8"
-  spec.add_development_dependency "rspec", ">= 3.4"
-  spec.add_development_dependency "test-unit"
-  spec.add_development_dependency "fuubar"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "benchmark-driver"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/red-data-tools/enumerable-statistics/issues",
+    "changelog_uri" =>
+      "https://github.com/red-data-tools/enumerable-statistics/releases/tag/v#{spec.version}",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/red-data-tools/enumerable-statistics.git",
+  }
 end

data/ext/enumerable/statistics/extension/statistics.c

@@ -2,6 +2,7 @@
 #include <ruby/util.h>
 #include <ruby/version.h>
 #include <assert.h>
+#include <float.h>
 #include <math.h>
 
 #if RUBY_API_VERSION_CODE >= 20400
@@ -96,11 +97,14 @@ static VALUE half_in_rational;
 static ID idPow, idPLUS, idMINUS, idSTAR, idDIV, idGE;
 static ID id_eqeq_p, id_idiv, id_negate, id_to_f, id_cmp, id_nan_p;
 static ID id_each, id_real_p, id_sum, id_population, id_closed, id_edge;
+static ID id_skip_na;
 
-static VALUE sym_auto, sym_left, sym_right;
+static VALUE sym_auto, sym_left, sym_right, sym_sturges;
 
 static VALUE cHistogram;
 
+static ID id_builtin_sum;
+
 inline static VALUE
 f_add(VALUE x, VALUE y)
 {
@@ -135,7 +139,7 @@ complex_new(VALUE klass, VALUE real, VALUE imag)
 {
   assert(!RB_TYPE_P(real, T_COMPLEX));
 
-  NEWOBJ_OF(obj, struct RComplex, klass, T_COMPLEX | (RGENGC_WB_PROTECTED_COMPLEX ? FL_WB_PROTECTED : 0));
+  VALUE obj = rb_get_alloc_func(klass)(klass);
 
   RCOMPLEX_SET_REAL(obj, real);
   RCOMPLEX_SET_IMAG(obj, imag);
@@ -535,9 +539,11 @@ f_gcd(VALUE x, VALUE y)
 inline static VALUE
 nurat_s_new_internal(VALUE klass, VALUE num, VALUE den)
 {
-  NEWOBJ_OF(obj, struct RRational, klass, T_RATIONAL | (RGENGC_WB_PROTECTED_RATIONAL ? FL_WB_PROTECTED : 0));
+  VALUE obj = rb_get_alloc_func(klass)(klass);
+
   RRATIONAL_SET_NUM(obj, num);
   RRATIONAL_SET_DEN(obj, den);
+
   return (VALUE)obj;
 }
 
@@ -632,39 +638,67 @@ rb_rational_plus(VALUE self, VALUE other)
 }
 #endif
 
-/* call-seq:
- *    ary.sum
- *
- * Calculate the sum of the values in `ary`.
- * This method utilizes
- * [Kahan summation algorithm](https://en.wikipedia.org/wiki/Kahan_summation_algorithm)
- * to compensate the result precision when the `ary` includes Float values.
- *
- * Note that This library does not redefine `sum` method introduced in Ruby 2.4.
- *
- * @return [Number] A summation value
- */
-static VALUE
-ary_sum(int argc, VALUE* argv, VALUE ary)
+static inline int
+is_na(VALUE v)
+{
+  if (NIL_P(v))
+    return 1;
+
+  if (RB_FLOAT_TYPE_P(v) && isnan(RFLOAT_VALUE(v)))
+    return 1;
+
+  if (rb_respond_to(v, id_nan_p) && RTEST(rb_funcall(v, id_nan_p, 0)))
+    return 1;
+
+  return 0;
+}
+
+static int opt_skip_na(VALUE opts)
+{
+  VALUE skip_na = Qfalse;
+
+  if (!NIL_P(opts)) {
+#ifdef HAVE_RB_GET_KWARGS
+    ID kwargs = id_skip_na;
+    rb_get_kwargs(opts, &kwargs, 0, 1, &skip_na);
+#else
+    VALUE val = rb_hash_aref(opts, ID2SYM(id_skip_na));
+    skip_na = NIL_P(val) ? skip_na : val;
+#endif
+  }
+
+  return RTEST(skip_na);
+}
+
+VALUE
+ary_calculate_sum(VALUE ary, VALUE init, int skip_na, long *na_count_out)
 {
   VALUE e, v, r;
   long i, n;
   int block_given;
-
-  if (rb_scan_args(argc, argv, "01", &v) == 0)
-    v = LONG2FIX(0);
+  long na_count = 0;
 
   block_given = rb_block_given_p();
 
-  if (RARRAY_LEN(ary) == 0)
-    return v;
+  if (RARRAY_LEN(ary) == 0) {
+    if (na_count_out != NULL) {
+      *na_count_out = 0;
+    }
+    return init;
+  }
 
   n = 0;
   r = Qundef;
+  v = init;
   for (i = 0; i < RARRAY_LEN(ary); i++) {
     e = RARRAY_AREF(ary, i);
     if (block_given)
       e = rb_yield(e);
+    if (skip_na && is_na(e)) {
+      ++na_count;
+      continue;
+    }
+
     if (FIXNUM_P(e)) {
       n += FIX2LONG(e); /* should not overflow long type */
       if (!FIXABLE(n)) {
@@ -688,7 +722,7 @@ ary_sum(int argc, VALUE* argv, VALUE ary)
     v = rb_fix_plus(LONG2FIX(n), v);
   if (r != Qundef)
     v = rb_rational_plus(r, v);
-  return v;
+  goto finish;
 
 not_exact:
   if (n != 0)
@@ -708,6 +742,11 @@ not_exact:
       e = RARRAY_AREF(ary, i);
       if (block_given)
         e = rb_yield(e);
+      if (skip_na && is_na(e)) {
+        ++na_count;
+        continue;
+      }
+
       if (RB_FLOAT_TYPE_P(e))
         has_float_value:
           x = RFLOAT_VALUE(e);
@@ -725,7 +764,9 @@ not_exact:
       c = (t - f) - y;
       f = t;
     }
-    return DBL2NUM(f);
+
+    v = DBL2NUM(f);
+    goto finish;
 
   not_float:
     v = DBL2NUM(f);
@@ -736,13 +777,53 @@ not_exact:
     e = RARRAY_AREF(ary, i);
     if (block_given)
       e = rb_yield(e);
+    if (skip_na && is_na(e)) {
+      ++na_count;
+      continue;
+    }
   has_some_value:
     v = rb_funcall(v, idPLUS, 1, e);
   }
 
+finish:
+  if (na_count_out != NULL) {
+    *na_count_out = na_count;
+  }
   return v;
 }
 
+/* call-seq:
+ *    ary.sum(skip_na: false)
+ *
+ * Calculate the sum of the values in `ary`.
+ * This method utilizes
+ * [Kahan summation algorithm](https://en.wikipedia.org/wiki/Kahan_summation_algorithm)
+ * to compensate the result precision when the `ary` includes Float values.
+ *
+ * Redefines `sum` (Ruby >= 2.4). Original is aliased as `__sum__`.
+ *
+ * @return [Number] A summation value
+ */
+static VALUE
+ary_sum(int argc, VALUE* argv, VALUE ary)
+{
+  VALUE v, opts;
+  int skip_na;
+
+  if (rb_scan_args(argc, argv, "01:", &v, &opts) == 0) {
+    v = LONG2FIX(0);
+  }
+  skip_na = opt_skip_na(opts);
+
+#ifndef HAVE_ENUM_SUM
+  if (!skip_na) {
+    return rb_funcall(ary, id_builtin_sum, argc, &v);
+  }
+#endif
+
+  return ary_calculate_sum(ary, v, skip_na, NULL);
+}
+
 static void
 calculate_and_set_mean(VALUE *mean_ptr, VALUE sum, long const n)
 {
@@ -771,9 +852,10 @@ calculate_and_set_mean(VALUE *mean_ptr, VALUE sum, long const n)
 }
 
 static void
-ary_mean_variance(VALUE ary, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof)
+ary_mean_variance(VALUE ary, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof, int skip_na)
 {
   long i;
+  long na_count;
   size_t n = 0;
   double m = 0.0, m2 = 0.0, f = 0.0, c = 0.0;
 
@@ -797,8 +879,8 @@ ary_mean_variance(VALUE ary, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof)
 
   if (variance_ptr == NULL) {
     VALUE init = DBL2NUM(0.0);
-    VALUE const sum = ary_sum(1, &init, ary);
-    long const n = RARRAY_LEN(ary);
+    VALUE const sum = ary_calculate_sum(ary, init, skip_na, &na_count);
+    long const n = RARRAY_LEN(ary) - na_count;
     calculate_and_set_mean(mean_ptr, sum, n);
     return;
   }
@@ -839,26 +921,46 @@ ary_mean_variance(VALUE ary, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof)
   }
 }
 
-static int
-opt_population_p(VALUE opts)
+struct variance_opts {
+  int population;
+  int skip_na;
+};
+
+static void
+get_variance_opts(VALUE opts, struct variance_opts *out)
 {
-  VALUE population = Qfalse;
+  assert(out != NULL);
+
+  out->population = 0;
+  out->skip_na = 0;
 
   if (!NIL_P(opts)) {
 #ifdef HAVE_RB_GET_KWARGS
-    ID kwargs = id_population;
-    rb_get_kwargs(opts, &kwargs, 0, 1, &population);
+    static ID kwarg_keys[2];
+    VALUE kwarg_vals;
+
+    if (!kwarg_keys[0]) {
+      kwarg_keys[0] = id_population;
+      kwarg_keys[1] = id_skip_na;
+    }
+
+    rb_get_kwargs(opts, &kwarg_keys, 0, 2, kwarg_vals);
+    out->population = (kwarg_vals[0] != Qundef) ? RTEST(kwarg_vals[0]) : out->population;
+    out->skip_na = (kwarg_vals[1] != Qundef) ? RTEST(kwarg_vals[1]) : out->skip_na;
 #else
-    VALUE val = rb_hash_aref(opts, ID2SYM(id_population));
-    population = NIL_P(val) ? population : val;
+    VALUE val;
+
+    val = rb_hash_aref(opts, ID2SYM(id_population));
+    out->population = NIL_P(val) ? out->population : RTEST(val);
+
+    val = rb_hash_aref(opts, ID2SYM(id_skip_na));
+    out->skip_na = NIL_P(val) ? out->skip_na : RTEST(val);
 #endif
   }
-
-  return RTEST(population);
 }
 
 /* call-seq:
- *    ary.mean_variance(population: false)
+ *    ary.mean_variance(population: false, skip_na: false)
  *
  * Calculate a mean and a variance of the values in `ary`.
  * The first element of the result array is the mean, and the second is the variance.
@@ -876,19 +978,21 @@ opt_population_p(VALUE opts)
 static VALUE
 ary_mean_variance_m(int argc, VALUE* argv, VALUE ary)
 {
-  VALUE opts, mean, variance;
+  struct variance_opts options;
+  VALUE opts, mean = Qnil, variance = Qnil;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
-  ary_mean_variance(ary, &mean, &variance, ddof);
+  ary_mean_variance(ary, &mean, &variance, ddof, options.skip_na);
   return rb_assoc_new(mean, variance);
 }
 
 /* call-seq:
- *    ary.mean
+ *    ary.mean(skip_na: false)
  *
  * Calculate a mean of the values in `ary`.
  * This method utilizes
@@ -898,15 +1002,20 @@ ary_mean_variance_m(int argc, VALUE* argv, VALUE ary)
  * @return [Number] A mean value
  */
 static VALUE
-ary_mean(VALUE ary)
+ary_mean(int argc, VALUE *argv, VALUE ary)
 {
-  VALUE mean;
-  ary_mean_variance(ary, &mean, NULL, 1);
+  VALUE mean = Qnil, opts;
+  int skip_na;
+
+  rb_scan_args(argc, argv, ":", &opts);
+  skip_na = opt_skip_na(opts);
+
+  ary_mean_variance(ary, &mean, NULL, 1, skip_na);
   return mean;
 }
 
 /* call-seq:
- *    ary.variance(population: false)
+ *    ary.variance(population: false, skip_na: false)
  *
  * Calculate a variance of the values in `ary`.
  * This method scan values in `ary` only once,
@@ -922,14 +1031,16 @@ ary_mean(VALUE ary)
 static VALUE
 ary_variance(int argc, VALUE* argv, VALUE ary)
 {
+  struct variance_opts options;
   VALUE opts, variance;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
-  ary_mean_variance(ary, NULL, &variance, ddof);
+  ary_mean_variance(ary, NULL, &variance, ddof, options.skip_na);
   return variance;
 }
 
@@ -943,6 +1054,7 @@ struct enum_sum_memo {
   double f, c;
   int block_given;
   int float_value;
+  int skip_na;
 };
 
 static void
@@ -956,8 +1068,12 @@ sum_iter(VALUE e, struct enum_sum_memo *memo)
   double f = memo->f;
   double c = memo->c;
 
-  if (memo->block_given)
+  if (memo->block_given) {
     e = rb_yield(e);
+  }
+  if (memo->skip_na && is_na(e)) {
+    return;
+  }
 
   memo->count += 1;
 
@@ -1090,7 +1206,7 @@ int_range_sum_count(VALUE beg, VALUE end, int excl,
 }
 
 static void
-enum_sum_count(VALUE obj, VALUE init, VALUE *sum_ptr, long *count_ptr)
+enum_sum_count(VALUE obj, VALUE init, int skip_na, VALUE *sum_ptr, long *count_ptr)
 {
   struct enum_sum_memo memo;
   VALUE beg, end;
@@ -1101,6 +1217,7 @@ enum_sum_count(VALUE obj, VALUE init, VALUE *sum_ptr, long *count_ptr)
   memo.block_given = rb_block_given_p();
   memo.n = 0;
   memo.r = Qundef;
+  memo.skip_na = skip_na;
 
   if ((memo.float_value = RB_FLOAT_TYPE_P(memo.v))) {
     memo.f = RFLOAT_VALUE(memo.v);
@@ -1138,32 +1255,42 @@ enum_sum_count(VALUE obj, VALUE init, VALUE *sum_ptr, long *count_ptr)
     *count_ptr = memo.count;
 }
 
-#ifndef HAVE_ENUM_SUM
 /* call-seq:
- *    enum.sum
+ *    enum.sum(skip_na: false)
  *
  * Calculate the sum of the values in `enum`.
  * This method utilizes
  * [Kahan summation algorithm](https://en.wikipedia.org/wiki/Kahan_summation_algorithm)
  * to compensate the result precision when the `enum` includes Float values.
  *
- * Note that This library does not redefine `sum` method introduced in Ruby 2.4.
+ * Redefines `sum` (Ruby >= 2.4). Original is aliased as `__sum__`.
  *
  * @return [Number] A summation value
  */
 static VALUE
 enum_sum(int argc, VALUE* argv, VALUE obj)
 {
-  VALUE sum, init;
+  VALUE sum, init, opts;
+  int skip_na;
 
-  if (rb_scan_args(argc, argv, "01", &init) == 0)
+  if (rb_scan_args(argc, argv, "01:", &init, &opts) == 0) {
     init = LONG2FIX(0);
+  }
+  skip_na = opt_skip_na(opts);
 
-  enum_sum_count(obj, init, &sum, NULL);
+#ifndef HAVE_ENUM_SUM
+  if (skip_na) {
+    enum_sum_count(obj, init, skip_na, &sum, NULL);
+  }
+  else {
+    sum = rb_funcall(obj, id_builtin_sum, argc, &init);
+  }
+#else
+  enum_sum_count(obj, init, skip_na, &sum, NULL);
+#endif
 
   return sum;
 }
-#endif
 
 struct enum_mean_variance_memo {
   int block_given;
@@ -1253,7 +1380,7 @@ enum_mean_variance(VALUE obj, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof)
     long n;
     VALUE sum;
     VALUE init = DBL2NUM(0.0);
-    enum_sum_count(obj, init, &sum, &n);
+    enum_sum_count(obj, init, 0, &sum, &n); /* TODO: skip_na */
     if (n > 0)
       calculate_and_set_mean(mean_ptr, sum, n);
     return;
@@ -1303,11 +1430,13 @@ enum_mean_variance(VALUE obj, VALUE *mean_ptr, VALUE *variance_ptr, size_t ddof)
 static VALUE
 enum_mean_variance_m(int argc, VALUE* argv, VALUE obj)
 {
+  struct variance_opts options;
   VALUE opts, mean, variance;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
   enum_mean_variance(obj, &mean, &variance, ddof);
@@ -1349,11 +1478,13 @@ enum_mean(VALUE obj)
 static VALUE
 enum_variance(int argc, VALUE* argv, VALUE obj)
 {
+  struct variance_opts options;
   VALUE opts, variance;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
   enum_mean_variance(obj, NULL, &variance, ddof);
@@ -1392,11 +1523,13 @@ sqrt_value(VALUE x)
 static VALUE
 enum_mean_stdev(int argc, VALUE* argv, VALUE obj)
 {
+  struct variance_opts options;
   VALUE opts, mean, variance;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
   enum_mean_variance(obj, &mean, &variance, ddof);
@@ -1446,14 +1579,16 @@ enum_stdev(int argc, VALUE* argv, VALUE obj)
 static VALUE
 ary_mean_stdev(int argc, VALUE* argv, VALUE ary)
 {
+  struct variance_opts options;
   VALUE opts, mean, variance;
   size_t ddof = 1;
 
   rb_scan_args(argc, argv, "0:", &opts);
-  if (opt_population_p(opts))
+  get_variance_opts(opts, &options);
+  if (options.population)
     ddof = 0;
 
-  ary_mean_variance(ary, &mean, &variance, ddof);
+  ary_mean_variance(ary, &mean, &variance, ddof, options.skip_na);
   VALUE stdev = sqrt_value(variance);
   return rb_assoc_new(mean, stdev);
 }
@@ -1479,21 +1614,6 @@ ary_stdev(int argc, VALUE* argv, VALUE ary)
   return stdev;
 }
 
-static inline int
-is_na(VALUE v)
-{
-  if (NIL_P(v))
-    return 1;
-
-  if (RB_FLOAT_TYPE_P(v) && isnan(RFLOAT_VALUE(v)))
-    return 1;
-
-  if (rb_respond_to(v, id_nan_p) && RTEST(rb_funcall(v, id_nan_p, 0)))
-    return 1;
-
-  return 0;
-}
-
 static int
 ary_percentile_sort_cmp(const void *ap, const void *bp, void *dummy)
 {
@@ -1900,7 +2020,7 @@ any_value_counts(int argc, VALUE *argv, VALUE obj,
   struct value_counts_opts opts;
   struct value_counts_memo memo;
 
-  rb_scan_args(argc, argv, ":", &kwargs);
+  rb_scan_args(argc, argv, "0:", &kwargs);
   value_counts_extract_opts(kwargs, &opts);
 
   memo.result = rb_hash_new();
@@ -2255,9 +2375,9 @@ ary_histogram_calculate_edge_lo_hi(const double lo, const double hi, const long
 }
 
 static VALUE
-ary_histogram_calculate_edge(VALUE ary, const long nbins, const int left_p)
+ary_histogram_calculate_edge(VALUE ary, VALUE arg0, const int left_p)
 {
-  long n;
+  long n, nbins;
   VALUE minmax;
   VALUE edge = Qnil;
   double lo, hi;
@@ -2265,6 +2385,22 @@ ary_histogram_calculate_edge(VALUE ary, const long nbins, const int left_p)
   Check_Type(ary, T_ARRAY);
   n = RARRAY_LEN(ary);
 
+  if (NIL_P(arg0)) {
+    arg0 = sym_auto;
+  }
+
+  if (RB_TYPE_P(arg0, T_SYMBOL)) {
+    if (arg0 != sym_auto && arg0 != sym_sturges) {
+      rb_raise(rb_eArgError, "Unknown method to calculate bin width: %+"PRIsVALUE, arg0);
+    }
+    else {
+      nbins = sturges(n);
+    }
+  }
+  else {
+    nbins = NUM2LONG(arg0);
+  }
+
   if (n == 0 && nbins < 0) {
     rb_raise(rb_eArgError, "nbins must be >= 0 for an empty array, got %ld", nbins);
   }
@@ -2337,19 +2473,13 @@ static VALUE
 ary_histogram(int argc, VALUE *argv, VALUE ary)
 {
   VALUE arg0, kwargs, bin_weights;
-  long nbins, n_bin_weights, i;
+  long n_bin_weights, i;
 
   VALUE weight_array = Qnil;
   VALUE edges = Qnil;
   int left_p = 1;
 
   rb_scan_args(argc, argv, "01:", &arg0, &kwargs);
-  if (NIL_P(arg0) || arg0 == sym_auto) {
-    nbins = sturges(RARRAY_LEN(ary));
-  }
-  else {
-    nbins = NUM2LONG(arg0);
-  }
 
   if (!NIL_P(kwargs)) {
     enum { kw_weights, kw_edges, kw_closed };
@@ -2370,7 +2500,10 @@ ary_histogram(int argc, VALUE *argv, VALUE ary)
   }
 
   if (NIL_P(edges)) {
-    edges = ary_histogram_calculate_edge(ary, nbins, left_p);
+    edges = ary_histogram_calculate_edge(ary, arg0, left_p);
+  }
+  else if (! NIL_P(arg0)) {
+    rb_raise(rb_eArgError, "Unable to use both `nbins` and `edges` together");
   }
 
   n_bin_weights = RARRAY_LEN(edges) - 1;
@@ -2395,10 +2528,12 @@ Init_extension(void)
   rb_ext_ractor_safe(true);
 #endif
 
-#ifndef HAVE_ENUM_SUM
-  rb_define_method(rb_mEnumerable, "sum", enum_sum, -1);
-#endif
+  mEnumerableStatistics = rb_const_get_at(rb_cObject, rb_intern("EnumerableStatistics"));
 
+  id_builtin_sum = rb_intern("__sum__");
+
+  rb_define_alias(rb_mEnumerable, "__sum__", "sum");
+  rb_define_method(rb_mEnumerable, "sum", enum_sum, -1);
   rb_define_method(rb_mEnumerable, "mean_variance", enum_mean_variance_m, -1);
   rb_define_method(rb_mEnumerable, "mean", enum_mean, 0);
   rb_define_method(rb_mEnumerable, "variance", enum_variance, -1);
@@ -2406,11 +2541,10 @@ Init_extension(void)
   rb_define_method(rb_mEnumerable, "stdev", enum_stdev, -1);
   rb_define_method(rb_mEnumerable, "value_counts", enum_value_counts, -1);
 
-#ifndef HAVE_ARRAY_SUM
+  rb_define_alias(rb_cArray, "__sum__", "sum");
   rb_define_method(rb_cArray, "sum", ary_sum, -1);
-#endif
   rb_define_method(rb_cArray, "mean_variance", ary_mean_variance_m, -1);
-  rb_define_method(rb_cArray, "mean", ary_mean, 0);
+  rb_define_method(rb_cArray, "mean", ary_mean, -1);
   rb_define_method(rb_cArray, "variance", ary_variance, -1);
   rb_define_method(rb_cArray, "mean_stdev", ary_mean_stdev, -1);
   rb_define_method(rb_cArray, "stdev", ary_stdev, -1);
@@ -2423,7 +2557,6 @@ Init_extension(void)
   half_in_rational = nurat_s_new_internal(rb_cRational, INT2FIX(1), INT2FIX(2));
   rb_gc_register_mark_object(half_in_rational);
 
-  mEnumerableStatistics = rb_const_get_at(rb_cObject, rb_intern("EnumerableStatistics"));
   cHistogram = rb_const_get_at(mEnumerableStatistics, rb_intern("Histogram"));
 
   rb_define_method(rb_cArray, "histogram", ary_histogram, -1);
@@ -2449,6 +2582,7 @@ Init_extension(void)
   id_population = rb_intern("population");
   id_closed = rb_intern("closed");
   id_edge = rb_intern("edge");
+  id_skip_na = rb_intern("skip_na");
 
   sym_auto = ID2SYM(rb_intern("auto"));
   sym_left = ID2SYM(rb_intern("left"));

data/lib/enumerable_statistics/version.rb

@@ -1,5 +1,5 @@
 module EnumerableStatistics
-  VERSION = '2.0.7'
+  VERSION = '2.0.9'
 
   module Version
     numbers, TAG = VERSION.split('-', 2)

metadata

@@ -1,127 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerable-statistics
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.9
 platform: ruby
 authors:
 - Kenta Murata
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.8
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: benchmark-driver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: This library provides statistics features for Enumerable
 email:
 - mrkn@mrkn.jp
@@ -130,7 +17,9 @@ extensions:
 - ext/enumerable/statistics/extension/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".yardopts"
@@ -270,10 +159,13 @@ files:
 - yard/templates/mathjax/tags/text/overload.erb
 - yard/templates/mathjax/tags/text/see.erb
 - yard/templates/mathjax/tags/text/tag.erb
-homepage: https://github.com/mrkn/enumerable-statistics
+homepage: https://github.com/red-data-tools/enumerable-statistics
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/red-data-tools/enumerable-statistics/issues
+  changelog_uri: https://github.com/red-data-tools/enumerable-statistics/releases/tag/v2.0.9
+  homepage_uri: https://github.com/red-data-tools/enumerable-statistics
+  source_code_uri: https://github.com/red-data-tools/enumerable-statistics.git
 rdoc_options: []
 require_paths:
 - ext
@@ -289,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Statistics features for Enumerable
 test_files: []