enumerable-statistics 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa86766eb3c5369422d08bac77705368b0bde5faa216eecd9f78115eb7548b6
-  data.tar.gz: 313dc69fe5d6b193278489b576af4bb90679eebf6814c36a2924a1241cd5c8be
+  metadata.gz: 9ca7750e402868e65da3619203a19ad1b7bd86348aee8ca2168c35db6fe6f262
+  data.tar.gz: 425bd2623655dd3f189ee50f12b0d44d3c25bed86194d2f31eb530431cab1090
 SHA512:
-  metadata.gz: 13fd8a73ae4e83aa85210cbbec1882a2129802aa377f7100ffa72e48ec7df685ba5eff1553cd2ef0b29eddd2b13715769de822adcc881c6d57122212d4c8c13a
-  data.tar.gz: d4dc08f32d2d9a43d743e213b2725f0bc41ac7d6d14c68ccecd1b3563d022c8c1c8b60eea682bce554bc7b5425e3c4b552766bb8b3a7faa386164ee8f00303b7
+  metadata.gz: 37a9f4e270fee3e34852bccd0adc18d288514c1d8363807b2db16877ada2174aea7c1f8c8ef7cea94cb3274bb5716c35ee689ecde95a5a71cb7724e1afd2a164
+  data.tar.gz: 5426b9ff42ce8033cf403be706da8a3dea94c88056a7a621218c0bc9aabe676571f868c263bef55266175759c95cc7f54267108f86cb483b0adacd11ce844968

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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

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

@@ -2280,13 +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, weight: nil, closed: :left)
  *
  * @param [Integer] nbins  The approximate number of bins
- * @params [Array<Numeric>] weight
+ * @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.
@@ -2296,10 +2330,11 @@ 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, kwargs, edge, bin_weights;
+  VALUE arg0, kwargs, bin_weights;
   long nbins, n_bin_weights, i;
 
   VALUE weight_array = Qnil;
+  VALUE edges = Qnil;
   int left_p = 1;
 
   rb_scan_args(argc, argv, "01:", &arg0, &kwargs);
@@ -2311,48 +2346,36 @@ ary_histogram(int argc, VALUE *argv, VALUE ary)
   }
 
   if (!NIL_P(kwargs)) {
-    enum { kw_weight, kw_closed };
-    static ID kwarg_keys[2];
-    VALUE kwarg_vals[2];
-    VALUE closed;
+    enum { kw_weights, kw_edges, kw_closed };
+    static ID kwarg_keys[3];
+    VALUE kwarg_vals[3];
 
     if (!kwarg_keys[0]) {
-      kwarg_keys[kw_weight] = rb_intern("weight");
+      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, 2, kwarg_vals);
+    rb_get_kwargs(kwargs, kwarg_keys, 0, 3, kwarg_vals);
 
-    weight_array = kwarg_vals[kw_weight];
-    if (weight_array != Qundef) {
-      weight_array = rb_check_convert_type(weight_array, T_ARRAY, "Array", "to_ary");
-      if (RARRAY_LEN(weight_array) != RARRAY_LEN(ary)) {
-        rb_raise(rb_eArgError, "weight array must have the same number of items as the receiver array");
-      }
-    }
-    else {
-      weight_array = Qnil;
-    }
-
-    closed = kwarg_vals[kw_closed];
-    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);
-    }
+    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]);
   }
 
-  edge = ary_histogram_calculate_edge(ary, nbins, left_p);
+  if (NIL_P(edges)) {
+    edges = ary_histogram_calculate_edge(ary, nbins, left_p);
+  }
 
-  n_bin_weights = RARRAY_LEN(edge) - 1;
+  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, edge, ary, weight_array, left_p);
+  histogram_weights_push_values(bin_weights, edges, ary, weight_array, left_p);
 
-  return rb_struct_new(cHistogram, edge, bin_weights,
+  return rb_struct_new(cHistogram, edges, bin_weights,
                        left_p ? sym_left : sym_right,
                        Qfalse);
 }

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.5'
+  VERSION = '2.0.6'
 
   module Version
     numbers, TAG = VERSION.split('-', 2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerable-statistics
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Kenta Murata