numo-narray-alt 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a64ac3265fa7102eee1017c69d80a8e08a15085e0f117e108c4cf0affca905f
-  data.tar.gz: c2100ac54472937c494f24b9800e1b27d296ae66fbdd5582eeb7204385eca86d
+  metadata.gz: 819274f9f9bc411b8276d69966bcba8aa94bc6d61f73920f653411729e4ef247
+  data.tar.gz: c4ccb23dd013573cd80bd8ab73398fd1a67adf6018a8bd55eebff776a69df6d8
 SHA512:
-  metadata.gz: b91256a44b0f992e34299e11cdc85c5e754780cb1fc19540bb281060b19213cd687fc9084ad7538931b564d555299562c38c8ae3f87ae3484b05eea9dab705b6
-  data.tar.gz: 110e56f1fb83cf1896edd88de1f7d4e800758ae212e6c72b8a9b5ee9e62c79d27d60ae5b6c22084fa20213549c0bac31b6dc02cbfae846621b4b37c38b0e7da1
+  metadata.gz: 35056f83d76f4c565f45b97ee8c9c992e6e3f3d77bd63b4ad7102d26631e4fbd82caaec87cb188bd2b23baf9785068923c6e54c441a6c188492526c848e2d0c0
+  data.tar.gz: 78f1154e6e77b6d9848b5a8c1e8d5818b7daeb891f5f476950eff003d7045022f7f57b0518c51c192756bd9b140e5bef737236d168b9918fe2610365388ac2f4

data/Gemfile

@@ -5,15 +5,18 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in narray-devel.gemspec
 gemspec
 
+gem 'irb', '~> 1.15'
 gem 'minitest', '~> 5.25'
 gem 'rake', '~> 13.3'
 gem 'rake-compiler', '~> 1.3'
+gem 'rdoc', '~> 6.15'
 gem 'rubocop', '~> 1.80'
 gem 'rubocop-minitest', '~> 0.38.2'
 gem 'rubocop-performance', '~> 1.26'
 gem 'rubocop-rake', '~> 0.7.1'
 gem 'simplecov', '~> 0.22.0'
 gem 'test-unit', '~> 3.7'
+gem 'yard', '~> 0.9.37'
 
 group :memcheck, optional: true do
   gem 'ruby_memcheck', '~> 3.0' if RUBY_VERSION.split('.')[0].to_i >= 3

data/README.md

@@ -40,6 +40,19 @@ Numo::DFloat#shape=[2,2]
 irb(main):004>
 ```
 
+## Related Projects
+
+Numo::NArray Alternative is used in the following projects:
+
+- [numo-linalg-alt](https://github.com/yoshoku/numo-linalg-alt): Linear algebra library with BLAS/LAPACK.
+- [numo-optimize](https://github.com/yoshoku/numo-optimize): Optimization library for minimizing objective functions.
+- [numo-random](https://github.com/yoshoku/numo-random): Random number generation library with several distributions.
+- [numo-pocketfft](https://github.com/yoshoku/numo-pocketfft): Fourier transform library with pocketfft.
+- [numo-libsvm](https://github.com/yoshoku/numo-libsvm): LIBSVM bindings library for numo-narray-alt.
+- [numo-liblinear](https://github.com/yoshoku/numo-liblinear): LIBLINEAR bindings library for numo-narray-alt.
+- [numo-linalg-randsvd](https://github.com/yoshoku/numo-linalg-randsvd): Randomized SVD library for numo-linalg-alt.
+- [rumale](https://github.com/yoshoku/rumale): Machine learning library.
+
 ## Development
 
 preparation:

data/ext/numo/narray/SFMT-params19937.h

@@ -21,30 +21,30 @@
 #define ALTI_SR1 (vector unsigned int)(SR1, SR1, SR1, SR1)
 #define ALTI_MSK (vector unsigned int)(MSK1, MSK2, MSK3, MSK4)
 #define ALTI_MSK64 (vector unsigned int)(MSK2, MSK1, MSK4, MSK3)
-#define ALTI_SL2_PERM \
+#define ALTI_SL2_PERM                                                                          \
   (vector unsigned char)(1, 2, 3, 23, 5, 6, 7, 0, 9, 10, 11, 4, 13, 14, 15, 8)
-#define ALTI_SL2_PERM64 \
+#define ALTI_SL2_PERM64                                                                        \
   (vector unsigned char)(1, 2, 3, 4, 5, 6, 7, 31, 9, 10, 11, 12, 13, 14, 15, 0)
-#define ALTI_SR2_PERM \
+#define ALTI_SR2_PERM                                                                          \
   (vector unsigned char)(7, 0, 1, 2, 11, 4, 5, 6, 15, 8, 9, 10, 17, 12, 13, 14)
-#define ALTI_SR2_PERM64 \
+#define ALTI_SR2_PERM64                                                                        \
   (vector unsigned char)(15, 0, 1, 2, 3, 4, 5, 6, 17, 8, 9, 10, 11, 12, 13, 14)
 #else /* For OTHER OSs(Linux?) */
-#define ALTI_SL1 \
+#define ALTI_SL1                                                                               \
   { SL1, SL1, SL1, SL1 }
-#define ALTI_SR1 \
+#define ALTI_SR1                                                                               \
   { SR1, SR1, SR1, SR1 }
-#define ALTI_MSK \
+#define ALTI_MSK                                                                               \
   { MSK1, MSK2, MSK3, MSK4 }
-#define ALTI_MSK64 \
+#define ALTI_MSK64                                                                             \
   { MSK2, MSK1, MSK4, MSK3 }
-#define ALTI_SL2_PERM \
+#define ALTI_SL2_PERM                                                                          \
   { 1, 2, 3, 23, 5, 6, 7, 0, 9, 10, 11, 4, 13, 14, 15, 8 }
-#define ALTI_SL2_PERM64 \
+#define ALTI_SL2_PERM64                                                                        \
   { 1, 2, 3, 4, 5, 6, 7, 31, 9, 10, 11, 12, 13, 14, 15, 0 }
-#define ALTI_SR2_PERM \
+#define ALTI_SR2_PERM                                                                          \
   { 7, 0, 1, 2, 11, 4, 5, 6, 15, 8, 9, 10, 17, 12, 13, 14 }
-#define ALTI_SR2_PERM64 \
+#define ALTI_SR2_PERM64                                                                        \
   { 15, 0, 1, 2, 3, 4, 5, 6, 17, 8, 9, 10, 11, 12, 13, 14 }
 #endif /* For OSX */
 #define IDSTR "SFMT-19937:122-18-1-11-1:dfffffef-ddfecb7f-bffaffff-bffffff6"

data/ext/numo/narray/array.c

@@ -446,8 +446,8 @@ static VALUE na_s_array_type(VALUE mod, VALUE ary) {
 /*
   Generate NArray object. NArray datatype is automatically selected.
   @overload [](elements)
-  @param [Numeric,Array] elements
-  @return [NArray]
+    @param [Numeric,Array] elements
+    @return [NArray]
 */
 static VALUE nary_s_bracket(VALUE klass, VALUE ary) {
   VALUE dtype = Qnil;
@@ -557,7 +557,31 @@ na_ary_composition_for_struct(VALUE nstruct, VALUE ary)
 */
 
 void Init_nary_array(void) {
+  /**
+   * return shape of NArray which would be created from given Array.
+   * @overload array_shape(ary)
+   *   @param [Array] ary
+   *   @return [Array] shape
+   * @example
+   *   Numo::NArray.array_shape([[1, 2, 3],[4, 5, 6]])
+   *   # => [2,3]
+   *   Numo::NArray.array_shape(Numo::DFloat[[1, 2, 3], [4, 5, 6]])
+   *   # => []
+   */
   rb_define_singleton_method(cNArray, "array_shape", na_s_array_shape, 1);
+  /**
+   * return type of NArray which would be created from given Array.
+   * @overload array_type(ary)
+   *   @param [Array] ary
+   *   @return [Class] NArray class
+   * @example
+   *  Numo::NArray.array_type([1, 2, 3])
+   *  # => Numo::Int32
+   *  Numo::NArray.array_type([0, 1, 2i])
+   *  # => Numo::DComplex
+   *  Numo::NArray.array_type(Numo::DFloat[1, 2, 3])
+   *  # => Numo::DFloat
+   */
   rb_define_singleton_method(cNArray, "array_type", na_s_array_type, 1);
   rb_define_singleton_method(cNArray, "new_like", na_s_new_like, 1);
 

data/ext/numo/narray/data.c

@@ -14,44 +14,44 @@ static ID id_swap_byte;
 
 // ---------------------------------------------------------------------
 
-#define LOOP_UNARY_PTR(lp, proc)            \
-  {                                         \
-    size_t i;                               \
-    ssize_t s1, s2;                         \
-    char *p1, *p2;                          \
-    size_t *idx1, *idx2;                    \
-    INIT_COUNTER(lp, i);                    \
-    INIT_PTR_IDX(lp, 0, p1, s1, idx1);      \
-    INIT_PTR_IDX(lp, 1, p2, s2, idx2);      \
-    if (idx1) {                             \
-      if (idx2) {                           \
-        for (; i--;) {                      \
-          proc((p1 + *idx1), (p2 + *idx2)); \
-          idx1++;                           \
-          idx2++;                           \
-        }                                   \
-      } else {                              \
-        for (; i--;) {                      \
-          proc((p1 + *idx1), p2);           \
-          idx1++;                           \
-          p2 += s2;                         \
-        }                                   \
-      }                                     \
-    } else {                                \
-      if (idx2) {                           \
-        for (; i--;) {                      \
-          proc(p1, (p1 + *idx2));           \
-          p1 += s1;                         \
-          idx2++;                           \
-        }                                   \
-      } else {                              \
-        for (; i--;) {                      \
-          proc(p1, p2);                     \
-          p1 += s1;                         \
-          p2 += s2;                         \
-        }                                   \
-      }                                     \
-    }                                       \
+#define LOOP_UNARY_PTR(lp, proc)                                                               \
+  {                                                                                            \
+    size_t i;                                                                                  \
+    ssize_t s1, s2;                                                                            \
+    char *p1, *p2;                                                                             \
+    size_t *idx1, *idx2;                                                                       \
+    INIT_COUNTER(lp, i);                                                                       \
+    INIT_PTR_IDX(lp, 0, p1, s1, idx1);                                                         \
+    INIT_PTR_IDX(lp, 1, p2, s2, idx2);                                                         \
+    if (idx1) {                                                                                \
+      if (idx2) {                                                                              \
+        for (; i--;) {                                                                         \
+          proc((p1 + *idx1), (p2 + *idx2));                                                    \
+          idx1++;                                                                              \
+          idx2++;                                                                              \
+        }                                                                                      \
+      } else {                                                                                 \
+        for (; i--;) {                                                                         \
+          proc((p1 + *idx1), p2);                                                              \
+          idx1++;                                                                              \
+          p2 += s2;                                                                            \
+        }                                                                                      \
+      }                                                                                        \
+    } else {                                                                                   \
+      if (idx2) {                                                                              \
+        for (; i--;) {                                                                         \
+          proc(p1, (p1 + *idx2));                                                              \
+          p1 += s1;                                                                            \
+          idx2++;                                                                              \
+        }                                                                                      \
+      } else {                                                                                 \
+        for (; i--;) {                                                                         \
+          proc(p1, p2);                                                                        \
+          p1 += s1;                                                                            \
+          p2 += s2;                                                                            \
+        }                                                                                      \
+      }                                                                                        \
+    }                                                                                          \
   }
 
 #define m_memcpy(src, dst) memcpy(dst, src, e)
@@ -79,14 +79,14 @@ na_store(VALUE self, VALUE src) {
 
 // ---------------------------------------------------------------------
 
-#define m_swap_byte(q1, q2)   \
-  {                           \
-    size_t j;                 \
-    memcpy(b1, q1, e);        \
-    for (j = 0; j < e; j++) { \
-      b2[e - 1 - j] = b1[j];  \
-    }                         \
-    memcpy(q2, b2, e);        \
+#define m_swap_byte(q1, q2)                                                                    \
+  {                                                                                            \
+    size_t j;                                                                                  \
+    memcpy(b1, q1, e);                                                                         \
+    for (j = 0; j < e; j++) {                                                                  \
+      b2[e - 1 - j] = b1[j];                                                                   \
+    }                                                                                          \
+    memcpy(q2, b2, e);                                                                         \
   }
 
 static void iter_swap_byte(na_loop_t* const lp) {
@@ -156,9 +156,9 @@ static inline int check_axis(int axis, int ndim) {
 /*
   Interchange two axes.
   @overload  swapaxes(axis1,axis2)
-  @param [Integer] axis1
-  @param [Integer] axis2
-  @return [Numo::NArray]  view of NArray.
+    @param [Integer] axis1
+    @param [Integer] axis2
+    @return [Numo::NArray]  view of NArray.
   @example
     x = Numo::Int32[[1,2,3]]
 
@@ -231,11 +231,11 @@ static VALUE na_transpose_map(VALUE self, int* map) {
   return view;
 }
 
-#define SWAP(a, b, tmp) \
-  {                     \
-    tmp = a;            \
-    a = b;              \
-    b = tmp;            \
+#define SWAP(a, b, tmp)                                                                        \
+  {                                                                                            \
+    tmp = a;                                                                                   \
+    a = b;                                                                                     \
+    b = tmp;                                                                                   \
   }
 
 static VALUE na_transpose(int argc, VALUE* argv, VALUE self) {
@@ -355,9 +355,8 @@ static void na_check_reshape(int argc, VALUE* argv, VALUE self, size_t* shape) {
   Raise exception if self is non-contiguous.
 
   @overload  reshape!(size0,size1,...)
-  @param sizeN [Integer] new shape
-  @return [Numo::NArray] return self.
-  @example
+    @param sizeN [Integer] new shape
+    @return [Numo::NArray] return self.
 */
 static VALUE na_reshape_bang(int argc, VALUE* argv, VALUE self) {
   size_t* shape;
@@ -400,9 +399,8 @@ static VALUE na_reshape_bang(int argc, VALUE* argv, VALUE self) {
   Returns a copied NArray.
 
   @overload  reshape(size0,size1,...)
-  @param sizeN [Integer] new shape
-  @return [Numo::NArray] return self.
-  @example
+    @param sizeN [Integer] new shape
+    @return [Numo::NArray] return self.
 */
 static VALUE na_reshape(int argc, VALUE* argv, VALUE self) {
   size_t* shape;
@@ -545,13 +543,13 @@ na_flatten(VALUE self) {
 /*
   Returns a diagonal view of NArray
   @overload  diagonal([offset,axes])
-  @param [Integer] offset  Diagonal offset from the main diagonal.
-    The default is 0. k>0 for diagonals above the main diagonal,
-    and k<0 for diagonals below the main diagonal.
-  @param [Array] axes  Array of axes to be used as the 2-d sub-arrays
-    from which the diagonals should be taken. Defaults to last-two
-    axes ([-2,-1]).
-  @return [Numo::NArray]  diagonal view of NArray.
+    @param [Integer] offset  Diagonal offset from the main diagonal.
+      The default is 0. k>0 for diagonals above the main diagonal,
+      and k<0 for diagonals below the main diagonal.
+    @param [Array] axes  Array of axes to be used as the 2-d sub-arrays
+      from which the diagonals should be taken. Defaults to last-two
+      axes ([-2,-1]).
+    @return [Numo::NArray]  diagonal view of NArray.
   @example
     a = Numo::DFloat.new(4,5).seq
     # => Numo::DFloat#shape=[4,5]
@@ -781,11 +779,11 @@ static VALUE na_diagonal(int argc, VALUE* argv, VALUE self) {
 #ifdef SWAP
 #undef SWAP
 #endif
-#define SWAP(a, b, t) \
-  {                   \
-    t = a;            \
-    a = b;            \
-    b = t;            \
+#define SWAP(a, b, t)                                                                          \
+  {                                                                                            \
+    t = a;                                                                                     \
+    a = b;                                                                                     \
+    b = t;                                                                                     \
   }
 
 static VALUE

data/ext/numo/narray/extconf.rb

@@ -45,7 +45,6 @@ srcs = %w[
   t_scomplex
   t_dcomplex
   t_robject
-  t_mean
   math
   SFMT
   struct

data/ext/numo/narray/index.c

@@ -1045,8 +1045,8 @@ static VALUE na_slice(int argc, VALUE* argv, VALUE self) {
   Similar to numpy's tuple indexing, i.e., `a[[1,2,..],[3,4,..]]`
   Same as Numo::NArray#[] for one-dimensional NArray.
   @overload at(dim0,...,dimL)
-  @param [Range,Array,Numo::Int32,Numo::Int64] dim0,...,dimL  multi-dimensional index arrays.
-  @return [Numo::NArray] one-dimensional NArray view.
+    @param [Range,Array,Numo::Int32,Numo::Int64] dim0,...,dimL  multi-dimensional index arrays.
+    @return [Numo::NArray] one-dimensional NArray view.
   @see #[]
 
   @example

data/ext/numo/narray/kwargs.c

@@ -15,10 +15,10 @@ struct RBasicRaw {
   VALUE klass;
 };
 
-#define RBASIC_SET_CLASS(obj, cls)                                  \
-  do {                                                              \
-    VALUE _obj_ = (obj);                                            \
-    RB_OBJ_WRITE(_obj_, &((struct RBasicRaw*)(_obj_))->klass, cls); \
+#define RBASIC_SET_CLASS(obj, cls)                                                             \
+  do {                                                                                         \
+    VALUE _obj_ = (obj);                                                                       \
+    RB_OBJ_WRITE(_obj_, &((struct RBasicRaw*)(_obj_))->klass, cls);                            \
   } while (0)
 
 /* from class.c */
@@ -92,8 +92,8 @@ int rb_get_kwargs(
   VALUE missing = Qnil;
   st_data_t key;
 
-#define extract_kwarg(keyword, val)                                                           \
-  (key = (st_data_t)(keyword), values ? st_delete(rb_hash_tbl_raw(keyword_hash), &key, (val)) \
+#define extract_kwarg(keyword, val)                                                            \
+  (key = (st_data_t)(keyword), values ? st_delete(rb_hash_tbl_raw(keyword_hash), &key, (val))  \
                                       : st_lookup(rb_hash_tbl_raw(keyword_hash), key, (val)))
 
   if (NIL_P(keyword_hash)) keyword_hash = 0;

data/ext/numo/narray/math.c

@@ -72,9 +72,9 @@ static VALUE nary_mathcast(int argc, VALUE* argv) {
   Dispatches method to Math module of upcasted type,
   eg, Numo::DFloat::Math.
   @overload method_missing(name,x,...)
-  @param [Symbol] name  method name.
-  @param [NArray,Numeric] x  input array.
-  @return [NArray] result.
+    @param [Symbol] name  method name.
+    @param [NArray,Numeric] x  input array.
+    @return [NArray] result.
 */
 static VALUE nary_math_method_missing(int argc, VALUE* argv, VALUE mod) {
   VALUE type, ans, typemod, hash;
@@ -101,11 +101,15 @@ static VALUE nary_math_method_missing(int argc, VALUE* argv, VALUE mod) {
 void Init_nary_math(void) {
   VALUE hCast;
 
+  /**
+   * Document-module: Numo::NMath
+   *
+   * This module provides mathematical functions for NArray.
+   */
   numo_mNMath = rb_define_module_under(mNumo, "NMath");
   rb_define_singleton_method(numo_mNMath, "method_missing", nary_math_method_missing, -1);
 
   hCast = rb_hash_new();
-  rb_define_const(numo_mNMath, "DISPATCH", hCast);
   rb_hash_aset(hCast, numo_cInt64, numo_mDFloatMath);
   rb_hash_aset(hCast, numo_cInt32, numo_mDFloatMath);
   rb_hash_aset(hCast, numo_cInt16, numo_mDFloatMath);
@@ -127,6 +131,8 @@ void Init_nary_math(void) {
 #endif
   rb_hash_aset(hCast, rb_cFloat, rb_mMath);
   rb_hash_aset(hCast, rb_cComplex, numo_mDComplexMath);
+  /* Dispatch table representing the corresponding Math module. */
+  rb_define_const(numo_mNMath, "DISPATCH", hCast);
 
   id_send = rb_intern("send");
   id_UPCAST = rb_intern("UPCAST");