numo-narray 0.9.1.4 → 0.9.1.5

data/ext/numo/narray/gen/tmpl/aref.c

@@ -1,40 +1,10 @@
 /*
-  Array element referenece or slice view.
+  Multi-dimensional element reference.
   @overload [](dim0,...,dimL)
-  @param [Numeric,Range,etc] dim0,...,dimL  Multi-dimensional Index.
-  @return [Numeric,NArray::<%=class_name%>] Element object or NArray view.
-
-  --- Returns the element at +dim0+, +dim1+, ... are Numeric indices
-  for each dimension, or returns a NArray View as a sliced subarray if
-  +dim0+, +dim1+, ... includes other than Numeric index, e.g., Range
-  or Array or true.
-
-  @example
-      a = Numo::DFloat.new(4,5).seq
-      => Numo::DFloat#shape=[4,5]
-      [[0, 1, 2, 3, 4],
-       [5, 6, 7, 8, 9],
-       [10, 11, 12, 13, 14],
-       [15, 16, 17, 18, 19]]
-
-      a[1,1]
-      => 6.0
-
-      a[1..3,1]
-      => Numo::DFloat#shape=[3]
-      [6, 11, 16]
-
-      a[1,[1,3,4]]
-      => Numo::DFloat#shape=[3]
-      [6, 8, 9]
-
-      a[true,2].fill(99)
-      a
-      => Numo::DFloat#shape=[4,5]
-      [[0, 1, 99, 3, 4],
-       [5, 6, 99, 8, 9],
-       [10, 11, 99, 13, 14],
-       [15, 16, 99, 18, 19]]
+  @param [Numeric,Range,Array,Numo::Int32,Numo::Int64,Numo::Bit,TrueClass,FalseClass,Symbol] dim0,...,dimL  multi-dimensional indices.
+  @return [Numeric,Numo::<%=class_name%>] an element or NArray view.
+  @see Numo::NArray#[]
+  @see #[]=
  */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *argv, VALUE self)

data/ext/numo/narray/gen/tmpl/aset.c

@@ -1,41 +1,11 @@
 /*
-  Array element(s) set.
-  @overload []=(dim0,..,dimL,val)
-  @param [Numeric,Range,etc] dim0,..,dimL  Multi-dimensional Index.
-  @param [Numeric,Numo::NArray,etc] val  Value(s) to be set to self.
-  @return [Numeric] returns val (last argument).
-
-  --- Replace element(s) at +dim0+, +dim1+, ... (index/range/array/true
-  for each dimention). Broadcasting mechanism is applied.
-
-  @example
-      a = Numo::DFloat.new(3,4).seq
-      => Numo::DFloat#shape=[3,4]
-      [[0, 1, 2, 3],
-       [4, 5, 6, 7],
-       [8, 9, 10, 11]]
-
-      a[1,2]=99
-      a
-      => Numo::DFloat#shape=[3,4]
-      [[0, 1, 2, 3],
-       [4, 5, 99, 7],
-       [8, 9, 10, 11]]
-
-      a[1,[0,2]] = [101,102]
-      a
-      => Numo::DFloat#shape=[3,4]
-      [[0, 1, 2, 3],
-       [101, 5, 102, 7],
-       [8, 9, 10, 11]]
-
-      a[1,true]=99
-      a
-      => Numo::DFloat#shape=[3,4]
-      [[0, 1, 2, 3],
-       [99, 99, 99, 99],
-       [8, 9, 10, 11]]
-
+  Multi-dimensional element assignment.
+  @overload []=(dim0,...,dimL,val)
+  @param [Numeric,Range,Array,Numo::Int32,Numo::Int64,Numo::Bit,TrueClass,FalseClass,Symbol] dim0,...,dimL  multi-dimensional indices.
+  @param [Numeric,Numo::NArray,Array] val  Value(s) to be set to self.
+  @return [Numeric,Numo::NArray,Array] returns `val` (last argument).
+  @see Numo::NArray#[]=
+  @see #[]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *argv, VALUE self)

data/ext/numo/narray/gen/tmpl/bincount.c

@@ -115,22 +115,22 @@ static VALUE
     otherwise returns UInt32 or UInt64 depending on the size along last axis.
   @example
     Numo::Int32[0..4].bincount
-    => Numo::UInt32#shape=[5]
-       [1, 1, 1, 1, 1]
+    # => Numo::UInt32#shape=[5]
+    # [1, 1, 1, 1, 1]
 
     Numo::Int32[0, 1, 1, 3, 2, 1, 7].bincount
-    => Numo::UInt32#shape=[8]
-       [1, 3, 1, 1, 0, 0, 0, 1]
+    # => Numo::UInt32#shape=[8]
+    # [1, 3, 1, 1, 0, 0, 0, 1]
 
     x = Numo::Int32[0, 1, 1, 3, 2, 1, 7, 23]
     x.bincount.size == x.max+1
-    => true
+    # => true
 
     w = Numo::DFloat[0.3, 0.5, 0.2, 0.7, 1.0, -0.6]
     x = Numo::Int32[0, 1, 1, 2, 2, 2]
     x.bincount(w)
-    => Numo::DFloat#shape=[3]
-       [0.3, 0.7, 1.1]
+    # => Numo::DFloat#shape=[3]
+    # [0.3, 0.7, 1.1]
 
 */
 static VALUE

data/ext/numo/narray/gen/tmpl/clip.c

@@ -69,28 +69,24 @@ static void
 
   @example
       a = Numo::Int32.new(10).seq
-      p a.clip(1,8)
-      # Numo::Int32#shape=[10]
-      # [1, 1, 2, 3, 4, 5, 6, 7, 8, 8]
-
-      p a
-      # Numo::Int32#shape=[10]
+      # => Numo::Int32#shape=[10]
       # [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
-      p a.inplace.clip(3,6)
-      # Numo::Int32(view)#shape=[10]
-      # [3, 3, 3, 3, 4, 5, 6, 6, 6, 6]
+      a.clip(1,8)
+      # => Numo::Int32#shape=[10]
+      # [1, 1, 2, 3, 4, 5, 6, 7, 8, 8]
 
-      p a
-      # Numo::Int32#shape=[10]
+      a.inplace.clip(3,6)
+      a
+      # => Numo::Int32#shape=[10]
       # [3, 3, 3, 3, 4, 5, 6, 6, 6, 6]
 
-      p a = Numo::Int32.new(10).seq
-      # Numo::Int32#shape=[10]
+      b = Numo::Int32.new(10).seq
+      # => Numo::Int32#shape=[10]
       # [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
-      p a.clip([3,4,1,1,1,4,4,4,4,4], 8)
-      # Numo::Int32#shape=[10]
+      b.clip([3,4,1,1,1,4,4,4,4,4], 8)
+      # => Numo::Int32#shape=[10]
       # [3, 4, 2, 3, 4, 5, 6, 7, 8, 8]
 */
 static VALUE

data/ext/numo/narray/gen/tmpl/cum.c

@@ -27,7 +27,7 @@ static void
 /*
   <%=name%> of self.
   @overload <%=name%>(axis:nil, nan:false)
-  @param [Numeric,Array,Range] axis  Affected dimensions.
+  @param [Numeric,Array,Range] axis  Performs <%=name%> along the axis.
   @param [TrueClass] nan  If true, apply NaN-aware algorithm (avoid NaN if exists).
   @return [Numo::<%=class_name%>] <%=name%> of self.
 */

data/ext/numo/narray/gen/tmpl/each.c

@@ -29,8 +29,10 @@ static void
   passing that element as a parameter.
   @overload <%=name%>
   @return [Numo::NArray] self
-  For a block {|x| ... }
-  @yield [x]  x is element of NArray.
+  For a block `{|x| ... }`,
+  @yieldparam [Numeric] x  an element of NArray.
+  @see #each_with_index
+  @see #map
 */
 static VALUE
 <%=c_func(0)%>(VALUE self)

data/ext/numo/narray/gen/tmpl/each_with_index.c

@@ -50,9 +50,12 @@ static void
   Invokes the given block once for each element of self,
   passing that element and indices along each axis as parameters.
   @overload <%=name%>
+  For a block `{|x,i,j,...| ... }`,
+  @yieldparam [Numeric] x  an element
+  @yieldparam [Integer] i,j,...  multitimensional indices
   @return [Numo::NArray] self
-  For a block {|x,i,j,...| ... }
-  @yield [x,i,j,...]  x is an element, i,j,... are multidimensional indices.
+  @see #each
+  @see #map_with_index
 */
 static VALUE
 <%=c_func(0)%>(VALUE self)

data/ext/numo/narray/gen/tmpl/lib.c

@@ -1,9 +1,9 @@
 /*
   <%= file_name %>
-  Ruby/Numo::GSL - GSL wrapper for Ruby/Numo::NArray
+  Ruby/Numo::NArray - Numerical Array class for Ruby
 
   created on: 2017-03-11
-  Copyright (C) 2017 Masahiro Tanaka
+  Copyright (C) 2017-2019 Masahiro Tanaka
 */
 
 #include <ruby.h>

data/ext/numo/narray/gen/tmpl/logseq.c

@@ -42,7 +42,7 @@ static void
 
 /*
   Set logarithmic sequence of numbers to self. The sequence is obtained from
-     base**(beg+i*step)
+     `base**(beg+i*step)`
   where i is 1-dimensional index.
   Applicable classes: DFloat, SFloat, DComplex, SCopmplex.
 
@@ -54,11 +54,12 @@ static void
 
   @example
     Numo::DFloat.new(5).logseq(4,-1,2)
-    => Numo::DFloat#shape=[5]
-      [16, 8, 4, 2, 1]
+    # => Numo::DFloat#shape=[5]
+    # [16, 8, 4, 2, 1]
+
     Numo::DComplex.new(5).logseq(0,1i*Math::PI/3,Math::E)
-    => Numo::DComplex#shape=[5]
-      [1+7.26156e-310i, 0.5+0.866025i, -0.5+0.866025i, -1+1.22465e-16i, ...]
+    # => Numo::DComplex#shape=[5]
+    # [1+7.26156e-310i, 0.5+0.866025i, -0.5+0.866025i, -1+1.22465e-16i, ...]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *args, VALUE self)

data/ext/numo/narray/gen/tmpl/map_with_index.c

@@ -75,14 +75,13 @@ static void
   passing that element and indices along each axis as parameters.
   Creates a new NArray containing the values returned by the block.
   Inplace option is allowed, i.e., `nary.inplace.map` overwrites `nary`.
-
   @overload <%=name%>
-
-  For a block {|x,i,j,...| ... }
-  @yield [x,i,j,...]  x is an element, i,j,... are multidimensional indices.
-
+  For a block `{|x,i,j,...| ... }`,
+  @yieldparam [Numeric] x  an element
+  @yieldparam [Integer] i,j,...  multitimensional indices
   @return [Numo::NArray] mapped array
-
+  @see #map
+  @see #each_with_index
 */
 static VALUE
 <%=c_func(0)%>(VALUE self)

data/ext/numo/narray/gen/tmpl/median.c

@@ -39,8 +39,8 @@ static void
 <% else %>
   @overload <%=name%>(axis:nil, keepdims:false)
 <% end %>
-  @param [Numeric,Array,Range] axis (keyword) Affected dimensions.
-  @param [TrueClass] keepdims (keyword) If true, the reduced axes are left in the result array as dimensions with size one.
+  @param [Numeric,Array,Range] axis  Finds <%=name%> along the axis.
+  @param [TrueClass] keepdims  If true, the reduced axes are left in the result array as dimensions with size one.
   @return [Numo::<%=class_name%>] returns <%=name%> of self.
 */
 

data/ext/numo/narray/gen/tmpl/minmax.c

@@ -25,7 +25,7 @@ static void
 <% else %>
   @overload <%=name%>(axis:nil, keepdims:false)
 <% end %>
-  @param [Numeric,Array,Range] axis (keyword) Affected dimensions.
+  @param [Numeric,Array,Range] axis  Finds min-max along the axis.
   @param [TrueClass] keepdims (keyword) If true, the reduced axes are left in the result array as dimensions with size one.
   @return [Numo::<%=class_name%>,Numo::<%=class_name%>] min and max of self.
 */

data/ext/numo/narray/gen/tmpl/poly.c

@@ -17,10 +17,10 @@ static void
 }
 
 /*
-  Polynomial.: a0 + a1*x + a2*x**2 + a3*x**3 + ... + an*x**n
-  @overload <%=name%> a0, a1, ...
-  @param [Numo::NArray,Numeric] a0
-  @param [Numo::NArray,Numeric] a1 , ...
+  Calculate polynomial.
+    `x.poly(a0,a1,a2,...,an) = a0 + a1*x + a2*x**2 + ... + an*x**n`
+  @overload <%=name%> a0, a1, ..., an
+  @param [Numo::NArray,Numeric] a0,a1,...,an
   @return [Numo::<%=class_name%>]
 */
 static VALUE

data/ext/numo/narray/gen/tmpl/qsort.c

@@ -1,6 +1,6 @@
 /*
   qsort.c
-  Numerical Array Extension for Ruby
+  Ruby/Numo::NArray - Numerical Array class for Ruby
     modified by Masahiro TANAKA
 */
 

data/ext/numo/narray/gen/tmpl/rand.c

@@ -113,14 +113,16 @@ static void
   @return [Numo::<%=class_name%>] self.
   @example
     Numo::DFloat.new(6).rand
-    => Numo::DFloat#shape=[6]
-       [0.0617545, 0.373067, 0.794815, 0.201042, 0.116041, 0.344032]
+    # => Numo::DFloat#shape=[6]
+    # [0.0617545, 0.373067, 0.794815, 0.201042, 0.116041, 0.344032]
+
     Numo::DComplex.new(6).rand(5+5i)
-    => Numo::DComplex#shape=[6]
-       [2.69974+3.68908i, 0.825443+0.254414i, 0.540323+0.34354i, 4.52061+2.39322i, ...]
+    # => Numo::DComplex#shape=[6]
+    # [2.69974+3.68908i, 0.825443+0.254414i, 0.540323+0.34354i, 4.52061+2.39322i, ...]
+
     Numo::Int32.new(6).rand(2,5)
-    => Numo::Int32#shape=[6]
-       [4, 3, 3, 2, 4, 2]
+    # => Numo::Int32#shape=[6]
+    # [4, 3, 3, 2, 4, 2]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *args, VALUE self)

data/ext/numo/narray/gen/tmpl/rand_norm.c

@@ -75,24 +75,26 @@ static void
   @return [Numo::<%=class_name%>] self.
   @example
     Numo::DFloat.new(5,5).rand_norm
-    => Numo::DFloat#shape=[5,5]
-       [[-0.581255, -0.168354, 0.586895, -0.595142, -0.802802],
-        [-0.326106, 0.282922, 1.68427, 0.918499, -0.0485384],
-        [-0.464453, -0.992194, 0.413794, -0.60717, -0.699695],
-        [-1.64168, 0.48676, -0.875871, -1.43275, 0.812172],
-        [-0.209975, -0.103612, -0.878617, -1.42495, 1.0968]]
+    # => Numo::DFloat#shape=[5,5]
+    # [[-0.581255, -0.168354, 0.586895, -0.595142, -0.802802],
+    #  [-0.326106, 0.282922, 1.68427, 0.918499, -0.0485384],
+    #  [-0.464453, -0.992194, 0.413794, -0.60717, -0.699695],
+    #  [-1.64168, 0.48676, -0.875871, -1.43275, 0.812172],
+    #  [-0.209975, -0.103612, -0.878617, -1.42495, 1.0968]]
+
     Numo::DFloat.new(5,5).rand_norm(10,0.1)
-    => Numo::DFloat#shape=[5,5]
-       [[9.9019, 9.90339, 10.0826, 9.98384, 9.72861],
-        [9.81507, 10.0272, 9.91445, 10.0568, 9.88923],
-        [10.0234, 9.97874, 9.96011, 9.9006, 9.99964],
-        [10.0186, 9.94598, 9.92236, 9.99811, 9.97003],
-        [9.79266, 9.95044, 9.95212, 9.93692, 10.2027]]
+    # => Numo::DFloat#shape=[5,5]
+    # [[9.9019, 9.90339, 10.0826, 9.98384, 9.72861],
+    #  [9.81507, 10.0272, 9.91445, 10.0568, 9.88923],
+    #  [10.0234, 9.97874, 9.96011, 9.9006, 9.99964],
+    #  [10.0186, 9.94598, 9.92236, 9.99811, 9.97003],
+    #  [9.79266, 9.95044, 9.95212, 9.93692, 10.2027]]
+
     Numo::DComplex.new(3,3).rand_norm(5+5i)
-    => Numo::DComplex#shape=[3,3]
-       [[5.84303+4.40052i, 4.00984+6.08982i, 5.10979+5.13215i],
-        [4.26477+3.99655i, 4.90052+5.00763i, 4.46607+2.3444i],
-        [4.5528+7.11003i, 5.62117+6.69094i, 5.05443+5.35133i]]
+    # => Numo::DComplex#shape=[3,3]
+    # [[5.84303+4.40052i, 4.00984+6.08982i, 5.10979+5.13215i],
+    #  [4.26477+3.99655i, 4.90052+5.00763i, 4.46607+2.3444i],
+    #  [4.5528+7.11003i, 5.62117+6.69094i, 5.05443+5.35133i]]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *args, VALUE self)

data/ext/numo/narray/gen/tmpl/seq.c

@@ -60,11 +60,12 @@ static void
   @return [Numo::<%=class_name%>] self.
   @example
     Numo::DFloat.new(6).seq(1,-0.2)
-    => Numo::DFloat#shape=[6]
-       [1, 0.8, 0.6, 0.4, 0.2, 0]
+    # => Numo::DFloat#shape=[6]
+    # [1, 0.8, 0.6, 0.4, 0.2, 0]
+
     Numo::DComplex.new(6).seq(1,-0.2+0.2i)
-    => Numo::DComplex#shape=[6]
-       [1+0i, 0.8+0.2i, 0.6+0.4i, 0.4+0.6i, 0.2+0.8i, 0+1i]
+    # => Numo::DComplex#shape=[6]
+    # [1+0i, 0.8+0.2i, 0.6+0.4i, 0.4+0.6i, 0.2+0.8i, 0+1i]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *args, VALUE self)

data/ext/numo/narray/gen/tmpl/sort.c

@@ -20,17 +20,17 @@ static void
 <% else %>
   @overload <%=name%>(axis:nil)
 <% end %>
-  @param [Numeric,Array,Range] axis  Affected dimensions.
+  @param [Numeric,Array,Range] axis  Performs <%=name%> along the axis.
   @return [Numo::<%=class_name%>] returns result of <%=name%>.
   @example
-      Numo::DFloat[3,4,1,2].sort => Numo::DFloat[1,2,3,4]
+      Numo::DFloat[3,4,1,2].sort #=> Numo::DFloat[1,2,3,4]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *argv, VALUE self)
 {
     VALUE reduce;
     ndfunc_arg_in_t ain[2] = {{OVERWRITE,0},{sym_reduce,0}};
-    ndfunc_t ndf = {0, STRIDE_LOOP|NDF_FLAT_REDUCE, 2,0, ain,0};
+    ndfunc_t ndf = {0, NDF_HAS_LOOP|NDF_FLAT_REDUCE, 2,0, ain,0};
 
     if (!TEST_INPLACE(self)) {
         self = na_copy(self);

data/ext/numo/narray/gen/tmpl/sort_index.c

@@ -52,10 +52,10 @@ static void
 <% else %>
   @overload <%=name%>(axis:nil)
 <% end %>
-  @param [Numeric,Array,Range] axis  Affected dimensions.
+  @param [Numeric,Array,Range] axis  Performs <%=name%> along the axis.
   @return [Integer,Numo::Int] returns result index of <%=name%>.
   @example
-      Numo::NArray[3,4,1,2].sort_index => Numo::Int32[2,3,0,1]
+      Numo::NArray[3,4,1,2].sort_index #=> Numo::Int32[2,3,0,1]
 */
 static VALUE
 <%=c_func(-1)%>(int argc, VALUE *argv, VALUE self)

data/ext/numo/narray/gen/tmpl/store_array.c

@@ -47,7 +47,13 @@ static void
     if (idx1) {
         for (i=i1=0; i1<n1 && i<n; i++,i1++) {
             x = ptr[i1];
-            if (rb_obj_is_kind_of(x, rb_cRange) || rb_obj_is_kind_of(x, na_cStep)) {
+            if (rb_obj_is_kind_of(x, rb_cRange)
+#ifdef HAVE_RB_ARITHMETIC_SEQUENCE_EXTRACT
+                || rb_obj_is_kind_of(x, rb_cArithSeq)
+#else
+                || rb_obj_is_kind_of(x, rb_cEnumerator)
+#endif
+                ) {
                 nary_step_sequence(x,&len,&beg,&step);
                 for (c=0; c<len && i<n; c++,i++) {
                     y = beg + step * c;
@@ -63,7 +69,13 @@ static void
     } else {
         for (i=i1=0; i1<n1 && i<n; i++,i1++) {
             x = ptr[i1];
-            if (rb_obj_is_kind_of(x, rb_cRange) || rb_obj_is_kind_of(x, na_cStep)) {
+            if (rb_obj_is_kind_of(x, rb_cRange)
+#ifdef HAVE_RB_ARITHMETIC_SEQUENCE_EXTRACT
+                || rb_obj_is_kind_of(x, rb_cArithSeq)
+#else
+                || rb_obj_is_kind_of(x, rb_cEnumerator)
+#endif
+                ) {
                 nary_step_sequence(x,&len,&beg,&step);
                 for (c=0; c<len && i<n; c++,i++) {
                     y = beg + step * c;