enumerable-statistics 2.0.0 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f55135e55fd08e3beda3b0935996ba719d2ad6d345f84321e7bb386e085ef2
-  data.tar.gz: 9d94090f25eefbfe568acc8ddd3c168d04bcbc50d39d858ff2c5ffd2a02f0ab6
+  metadata.gz: 9ca7750e402868e65da3619203a19ad1b7bd86348aee8ca2168c35db6fe6f262
+  data.tar.gz: 425bd2623655dd3f189ee50f12b0d44d3c25bed86194d2f31eb530431cab1090
 SHA512:
-  metadata.gz: 9d8fcb3f97e9852200f9d0735f4e25408303c6621680220c74caa519f1c268aa389ae3bfcb1b3d743867e9d4429d7f2c12c63ce26c573a1d3b401c4371876a5a
-  data.tar.gz: c430bc88e14b6f438db7f234b20718047073199b4d905d7c8f771550790eb0e2891625d643bb35a3b43422dbf9e5fc67b10d4cb991348c787791fdc870510e23
+  metadata.gz: 37a9f4e270fee3e34852bccd0adc18d288514c1d8363807b2db16877ada2174aea7c1f8c8ef7cea94cb3274bb5716c35ee689ecde95a5a71cb7724e1afd2a164
+  data.tar.gz: 5426b9ff42ce8033cf403be706da8a3dea94c88056a7a621218c0bc9aabe676571f868c263bef55266175759c95cc7f54267108f86cb483b0adacd11ce844968

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

data/CHANGELOG.md

@@ -1,4 +1,30 @@
-# 2.0.0-pre
+# 2.0.6
+
+- Add edges parameter in histogram
+- Rename parameter in histogram to fix typo: `weight` to `weights`
+
+# 2.0.5
+
+- Add weighted histogram support
+
+# 2.0.4
+
+- Add `find_min`, `find_max`, `argmin`, `argmax` methods
+- Fix `nbin=:auto` case in `histogram` method
+
+# 2.0.3
+
+- Ractor-safe version
+
+# 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

data/Rakefile

@@ -8,7 +8,14 @@ Rake::ExtensionTask.new('enumerable/statistics/extension')
 
 directory 'lib/enumerable/statistics'
 
+desc "Run test"
+task :test do
+  ruby("test/run-test.rb")
+end
+task :test => :compile
+
 RSpec::Core::RakeTask.new(:spec)
+task :spec => :compile
 
 task :bench do
   puts "# sum\n"
@@ -20,3 +27,5 @@ task :bench do
   puts "# variance\n"
   system('benchmark-driver bench/variance.yml')
 end
+
+task default: [:test, :spec]

data/enumerable-statistics.gemspec

@@ -27,10 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_development_dependency "bundler", ">= 1.17.2"
+  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"

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

@@ -0,0 +1,60 @@
+#include <ruby/ruby.h>
+
+static VALUE
+ary_find_max(VALUE ary)
+{
+  const long n = RARRAY_LEN(ary);
+  if (n == 0) {
+    return Qnil;
+  }
+
+  long imax = 0;
+  VALUE max = RARRAY_AREF(ary, imax);
+
+  long i;
+  for (i = 1; i < n; ++i) {
+    VALUE v = RARRAY_AREF(ary, i);
+    if (RTEST(rb_funcall(v, '>', 1, max))) {
+      imax = i;
+      max = v;
+    }
+  }
+
+  return rb_assoc_new(max, LONG2NUM(imax));
+}
+
+static VALUE
+ary_find_min(VALUE ary)
+{
+  const long n = RARRAY_LEN(ary);
+  if (n == 0) {
+    return Qnil;
+  }
+
+  long imin = 0;
+  VALUE min = RARRAY_AREF(ary, imin);
+
+  long i;
+  for (i = 1; i < n; ++i) {
+    VALUE v = RARRAY_AREF(ary, i);
+    if (RTEST(rb_funcall(v, '<', 1, min))) {
+      imin = i;
+      min = v;
+    }
+  }
+
+  return rb_assoc_new(min, LONG2NUM(imin));
+}
+
+void
+Init_array_extension(void)
+{
+  VALUE mEnumerableStatistics = rb_const_get_at(rb_cObject, rb_intern("EnumerableStatistics"));
+  VALUE mArrayExtension = rb_const_get_at(mEnumerableStatistics, rb_intern("ArrayExtension"));
+
+  rb_undef_method(mArrayExtension, "find_max");
+  rb_define_method(mArrayExtension, "find_max", ary_find_max, 0);
+
+  rb_undef_method(mArrayExtension, "find_min");
+  rb_define_method(mArrayExtension, "find_min", ary_find_min, 0);
+}

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

@@ -44,7 +44,7 @@ struct RRational {
 #endif
 
 #ifndef RRATIONAL
-# define RRATIONAL(obj) (R_CAST(RRational)(obj))
+# define RRATIONAL(obj) ((struct RRational *)(obj))
 #endif
 
 #ifndef RRATIONAL_SET_NUM
@@ -64,7 +64,7 @@ struct RComplex {
 #endif
 
 #ifndef RCOMPLEX
-# define RCOMPLEX(obj) (R_CAST(RComplex)(obj))
+# define RCOMPLEX(obj) ((struct RComplex *)(obj))
 #endif
 
 #ifndef RCOMPLEX_SET_REAL
@@ -97,7 +97,7 @@ 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 VALUE sym_left, sym_right;
+static VALUE sym_auto, sym_left, sym_right;
 
 static VALUE cHistogram;
 
@@ -2102,50 +2102,61 @@ histogram_edge_bin_index(VALUE edge, VALUE rb_x, int left_p)
 }
 
 static void
-histogram_weights_push_values(VALUE weights, VALUE edge, VALUE values, int left_p)
+histogram_weights_push_values(VALUE bin_weights, VALUE edge, VALUE values, VALUE weight_array, int left_p)
 {
   VALUE x, cur;
-  long i, n, bi;
+  long i, n, bi, one, weighted = 0;
 
   n = RARRAY_LEN(values);
+
+  if (! NIL_P(weight_array)) {
+    assert(RB_TYPE_P(weight_array, T_ARRAY));
+    assert(RARRAY_LEN(weight_array) == n);
+    weighted = 1;
+  }
+
+  one = INT2FIX(1);
   for (i = 0; i < n; ++i) {
     x = RARRAY_AREF(values, i);
 
+    VALUE w;
+    if (weighted) {
+      w = RARRAY_AREF(weight_array, i);
+      if (RB_TYPE_P(w, T_COMPLEX)) {
+        VALUE imag = RCOMPLEX(w)->imag;
+        if (! RTEST(f_zero_p(imag))) {
+          goto type_error;
+        }
+      }
+      else if (rb_obj_is_kind_of(w, rb_cNumeric)) {
+        if (!RTEST(f_real_p(w))) {
+          goto type_error;
+        }
+      }
+      else {
+        goto type_error;
+      }
+    }
+    else {
+      w = one;
+    }
+
     bi = histogram_edge_bin_index(edge, x, left_p);
 
-    cur = rb_ary_entry(weights, bi);
+    cur = rb_ary_entry(bin_weights, bi);
     if (NIL_P(cur)) {
-      cur = INT2FIX(1);
+      cur = w;
     }
     else {
-      cur = rb_funcall(cur, idPLUS, 1, INT2FIX(1));
+      cur = rb_funcall(cur, idPLUS, 1, w);
     }
 
-    rb_ary_store(weights, bi, cur);
+    rb_ary_store(bin_weights, bi, cur);
   }
-}
+  return;
 
-static int
-opt_closed_left_p(VALUE opts)
-{
-  int left_p = 1;
-
-  if (!NIL_P(opts)) {
-    VALUE closed;
-#ifdef HAVE_RB_GET_KWARGS
-    ID kwargs = id_closed;
-    rb_get_kwargs(opts, &kwargs, 0, 1, &closed);
-#else
-    closed = rb_hash_lookup2(opts, ID2SYM(id_closed), sym_left);
-#endif
-    left_p = (closed != sym_right);
-    if (left_p && closed != sym_left) {
-      rb_raise(rb_eArgError, "invalid value for :closed keyword "
-               "(%"PRIsVALUE" for :left or :right)", closed);
-    }
-  }
-
-  return left_p;
+type_error:
+      rb_raise(rb_eTypeError, "weight array must have only real numbers");
 }
 
 static inline long
@@ -2269,10 +2280,47 @@ ary_histogram_calculate_edge(VALUE ary, const long nbins, const int left_p)
   return edge;
 }
 
+static VALUE
+check_histogram_weight_array(VALUE weight_array, const long ary_len)
+{
+  if (weight_array == Qundef) return Qnil;
+
+  weight_array = rb_check_convert_type(weight_array, T_ARRAY, "Array", "to_ary");
+  if (RARRAY_LEN(weight_array) != ary_len) {
+    rb_raise(rb_eArgError, "weight array must have the same number of items as the receiver array");
+  }
+
+  return weight_array;
+}
+
+static VALUE
+check_histogram_edges(VALUE edges)
+{
+  if (edges == Qundef) return Qnil;
+  return rb_check_convert_type(edges, T_ARRAY, "Array", "to_ary");
+}
+
+static int
+check_histogram_left_p(VALUE closed)
+{
+  int left_p = (closed != sym_right);
+  if (left_p && closed != Qundef && closed != sym_left) {
+    rb_raise(rb_eArgError, "invalid value for :closed keyword "
+        "(%"PRIsVALUE" for :left or :right)", closed);
+  }
+  return left_p;
+}
+
 /* call-seq:
- *    ary.histogram(nbins=:auto, closed: :left)
+ *    ary.histogram(nbins=:auto, weight: nil, closed: :left)
  *
  * @param [Integer] nbins  The approximate number of bins
+ * @params [Array<Numeric>] weights
+ *   An optional weight array, that has the same length as the receiver.
+ *   `weight[i]` means the weight value of the i-th element in the receiver.
+ * @params [Array<Numeric>] edges
+ *   An optional edge array, that specify the bin edges.
+ *   This array must be sorted.
  * @param [:left, :right] closed
  *   If :left (the default), the bin interval are left-closed.
  *   If :right, the bin interval are right-closed.
@@ -2282,24 +2330,52 @@ ary_histogram_calculate_edge(VALUE ary, const long nbins, const int left_p)
 static VALUE
 ary_histogram(int argc, VALUE *argv, VALUE ary)
 {
-  VALUE arg0, opts, edge, weights;
-  int left_p;
-  long nbins;
+  VALUE arg0, kwargs, bin_weights;
+  long nbins, n_bin_weights, i;
 
-  rb_scan_args(argc, argv, "01:", &arg0, &opts);
-  if (NIL_P(arg0)) {
+  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);
   }
-  left_p = opt_closed_left_p(opts);
 
-  edge = ary_histogram_calculate_edge(ary, nbins, left_p);
-  weights = rb_ary_new_capa(RARRAY_LEN(edge) - 1);
-  histogram_weights_push_values(weights, edge, ary, left_p);
+  if (!NIL_P(kwargs)) {
+    enum { kw_weights, kw_edges, kw_closed };
+    static ID kwarg_keys[3];
+    VALUE kwarg_vals[3];
 
-  return rb_struct_new(cHistogram, edge, weights,
+    if (!kwarg_keys[0]) {
+      kwarg_keys[kw_weights] = rb_intern("weights");
+      kwarg_keys[kw_edges]  = rb_intern("edges");
+      kwarg_keys[kw_closed] = rb_intern("closed");
+    }
+
+    rb_get_kwargs(kwargs, kwarg_keys, 0, 3, kwarg_vals);
+
+    weight_array = check_histogram_weight_array(kwarg_vals[kw_weights], RARRAY_LEN(ary));
+    edges = check_histogram_edges(kwarg_vals[kw_edges]);
+    left_p = check_histogram_left_p(kwarg_vals[kw_closed]);
+  }
+
+  if (NIL_P(edges)) {
+    edges = ary_histogram_calculate_edge(ary, nbins, left_p);
+  }
+
+  n_bin_weights = RARRAY_LEN(edges) - 1;
+  bin_weights = rb_ary_new_capa(n_bin_weights);
+  for (i = 0; i < n_bin_weights; ++i) {
+    rb_ary_store(bin_weights, i, INT2FIX(0));
+  }
+
+  histogram_weights_push_values(bin_weights, edges, ary, weight_array, left_p);
+
+  return rb_struct_new(cHistogram, edges, bin_weights,
                        left_p ? sym_left : sym_right,
                        Qfalse);
 }
@@ -2309,6 +2385,10 @@ Init_extension(void)
 {
   VALUE mEnumerableStatistics;
 
+#ifdef HAVE_RB_EXT_RACTOR_SAFE
+  rb_ext_ractor_safe(true);
+#endif
+
 #ifndef HAVE_ENUM_SUM
   rb_define_method(rb_mEnumerable, "sum", enum_sum, -1);
 #endif
@@ -2342,6 +2422,9 @@ Init_extension(void)
 
   rb_define_method(rb_cArray, "histogram", ary_histogram, -1);
 
+  void Init_array_extension(void);
+  Init_array_extension();
+
   idPLUS = '+';
   idMINUS = '-';
   idSTAR = '*';
@@ -2361,6 +2444,7 @@ Init_extension(void)
   id_closed = rb_intern("closed");
   id_edge = rb_intern("edge");
 
+  sym_auto = ID2SYM(rb_intern("auto"));
   sym_left = ID2SYM(rb_intern("left"));
   sym_right = ID2SYM(rb_intern("right"));
 }

data/lib/enumerable_statistics.rb

@@ -1,2 +1,3 @@
 require_relative "enumerable_statistics/version"
+require_relative "enumerable_statistics/array_ext"
 require_relative "enumerable_statistics/histogram"

data/lib/enumerable_statistics/array_ext.rb

@@ -0,0 +1,37 @@
+module EnumerableStatistics
+  module ArrayExtension
+    def find_max
+      n = size
+      return nil if n == 0
+
+      imax, i = 0, 1
+      while i < n
+        imax = i if self[i] > self[imax]
+        i += 1
+      end
+      [self[imax], imax]
+    end
+
+    def argmax
+      find_max[1]
+    end
+
+    def find_min
+      n = size
+      return nil if n == 0
+
+      imin, i = 0, 1
+      while i < n
+        imin = i if self[i] < self[imax]
+        i += 1
+      end
+      [self[imin], imin]
+    end
+
+    def argmin
+      find_min[1]
+    end
+  end
+
+  Array.include ArrayExtension
+end

data/lib/enumerable_statistics/histogram.rb

@@ -1,5 +1,6 @@
 module EnumerableStatistics
-  class Histogram < Struct.new(:edge, :weights, :closed, :isdensity)
+  class Histogram < Struct.new(:edges, :weights, :closed, :isdensity)
+    alias edge edges
     alias density? isdensity
   end
 end

data/lib/enumerable_statistics/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumerable-statistics
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.6
 platform: ruby
 authors:
 - Kenta Murata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !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
@@ -114,12 +128,11 @@ email:
 executables: []
 extensions:
 - ext/enumerable/statistics/extension/extconf.rb
-- ext/-bench-/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -136,12 +149,13 @@ files:
 - bin/rspec
 - bin/setup
 - enumerable-statistics.gemspec
-- ext/-bench-/extconf.rb
+- ext/enumerable/statistics/extension/array_ext.c
 - ext/enumerable/statistics/extension/extconf.rb
 - ext/enumerable/statistics/extension/statistics.c
 - images/benchmark.png
 - lib/enumerable/statistics.rb
 - lib/enumerable_statistics.rb
+- lib/enumerable_statistics/array_ext.rb
 - lib/enumerable_statistics/histogram.rb
 - lib/enumerable_statistics/version.rb
 - templates/default/layout/html/headers.erb
@@ -275,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Statistics features for Enumerable

data/.travis.yml

@@ -1,32 +0,0 @@
----
-notification:
-  email:
-  - mrkn@ruby-lang.org
-
-language: ruby
-
-before_install:
-  - yes | gem update --system
-  - gem install bundler
-
-install:
-  - bundle install
-
-script:
-  - bundle exec rake --trace clobber compile
-  - bundle exec rake spec
-
-matrix:
-  include:
-    - name: "2.3"
-      rvm: 2.3
-    - name: "2.4"
-      rvm: 2.4.5
-    - name: "2.5"
-      rvm: 2.5.2
-    - name: "2.6"
-      rvm: 2.6
-    - name: "trunk"
-      rvm: ruby-head
-  allow_failures:
-    - rvm: 2.3

data/ext/-bench-/extconf.rb

@@ -1,3 +0,0 @@
-require 'mkmf'
-
-create_makefile('-bench-')