carray 1.4.0 → 1.5.5

data/{carray_sort_addr.c → ext/carray_sort_addr.c}

@@ -3,10 +3,8 @@
   carray_sort_addr.c
 
   This file is part of Ruby/CArray extension library.
-  You can redistribute it and/or modify it under the terms of
-  the Ruby Licence.
 
-  Copyright (C) 2005 Hiroki Motoyoshi
+  Copyright (C) 2005-2020 Hiroki Motoyoshi
 
 ---------------------------------------------------------------------------- */
 
@@ -151,16 +149,14 @@ qcmp_func (struct cmp_data *a, struct cmp_data *b)
   return ( ia > ib ) ? 1 : -1; /* for stable sort */
 }
 
-/* rdoc:
-  # returns index table for index sort
-  #
-  #   idx = CA.sort_addr(a, b, c)  ### priority a > b > c
-  #   a[idx]
-  #   b[idx]
-  #   c[idx]
+/* @overload sort_addr (*args)
 
-  def CA.sort_addr (*args)
-  end
+(Sort) Returns index table for index sort
+
+     idx = CA.sort_addr(a, b, c)  ### priority a > b > c
+     a[idx]
+     b[idx]
+     c[idx]
 */
 
 static VALUE
@@ -234,15 +230,12 @@ rb_ca_s_sort_addr (int argc, VALUE *argv, VALUE self)
   return out;
 }
 
-/* rdoc:
-  class CArray
-    # returns index table for index sort
-    # This method same as,
-    #
-    #   idx = CA.sort_addr(self, *args) 
-    def sort_addr (*args)
-    end
-  end
+/* @overload sort_addr (*args)
+
+(Sort) Returns index table for index sort
+ This method same as,
+
+     idx = CA.sort_addr(self, *args) 
 */
 
 static VALUE

data/{carray_stat.c → ext/carray_stat.c}

@@ -3,10 +3,8 @@
   carray_stat.c
 
   This file is part of Ruby/CArray extension library.
-  You can redistribute it and/or modify it under the terms of
-  the Ruby Licence.
 
-  Copyright (C) 2005 Hiroki Motoyoshi
+  Copyright (C) 2005-2020 Hiroki Motoyoshi
 
 ---------------------------------------------------------------------------- */
 
@@ -293,10 +291,10 @@ rb_ca_cumprod (int argc, VALUE *argv, VALUE self)
   Data_Get_Struct(self, CArray, ca);
 
   if ( ca_is_complex_type(ca) ) {
-    co = carray_new(CA_CMPLX128, ca->rank, ca->dim, 0, NULL);
+    co = carray_new(CA_CMPLX128, ca->ndim, ca->dim, 0, NULL);
   }
   else {
-    co = carray_new(CA_FLOAT64, ca->rank, ca->dim, 0, NULL);
+    co = carray_new(CA_FLOAT64, ca->ndim, ca->dim, 0, NULL);
   }
 
   min_count = ( NIL_P(rmin_count) || ! ca_has_mask(ca) ) ?
@@ -504,10 +502,10 @@ rb_ca_cumwsum (int argc, VALUE *argv, VALUE self)
   }
 
   if ( ca_is_complex_type(ca) ) {
-    co = carray_new(CA_CMPLX128, ca->rank, ca->dim, 0, NULL);
+    co = carray_new(CA_CMPLX128, ca->ndim, ca->dim, 0, NULL);
   }
   else {
-    co = carray_new(CA_FLOAT64, ca->rank, ca->dim, 0, NULL);
+    co = carray_new(CA_FLOAT64, ca->ndim, ca->dim, 0, NULL);
   }
 
   min_count = ( NIL_P(rmin_count) || ( ! ca_has_mask(ca) ) ) ?
@@ -2029,7 +2027,7 @@ rb_ca_grade (int argc, VALUE *argv, VALUE self)
     rb_raise(rb_eArgError, "bin number must be larger than 1");
   }
 
-  out = rb_carray_new_safe(CA_SIZE, ca->rank, ca->dim, 0, NULL);
+  out = rb_carray_new_safe(CA_SIZE, ca->ndim, ca->dim, 0, NULL);
   Data_Get_Struct(out, CArray, sa);
 
   ca_attach(ca);

data/{carray_stat_proc.rb → ext/carray_stat_proc.rb}

@@ -286,12 +286,10 @@ header = <<HERE_END
   carray_stat_proc.c
 
   This file is part of Ruby/CArray extension library.
-  You can redistribute it and/or modify it under the terms of
-  the Ruby Licence.
 
-  This file is automatically generated from carray_stat_proc.rb
 
-  Copyright (C) 2005 Hiroki Motoyoshi
+  This file is automatically generated from carray_stat_proc.rb
+  Copyright (C) 2005-2020 Hiroki Motoyoshi
 
 ---------------------------------------------------------------------------- */
 
@@ -1383,7 +1381,7 @@ ca_stat_nd_contig_loop (CArray *ca, CArray *co, ca_size_t mc,
   void *p;
   boolean8_t *m;
   ca_size_t i, n;
-  if ( level == co->rank ) {
+  if ( level == co->ndim ) {
     CAStatIterator it;
     n = ca->elements/co->elements;
     idx[level] = 0;
@@ -1421,8 +1419,8 @@ rb_ca_stat_nd_contig (VALUE self, VALUE vaxis, VALUE rmc, VALUE vfval,
              ca_type_name[ca->data_type]);
   }
 
-  ndim = ca->rank - RARRAY_LEN(vaxis);
-  if ( ndim <= 0 || ndim > ca->rank ) {
+  ndim = ca->ndim - RARRAY_LEN(vaxis);
+  if ( ndim <= 0 || ndim > ca->ndim ) {
     rb_raise(rb_eRuntimeError, "invalid dimension specified");
   }
 
@@ -1449,7 +1447,7 @@ rb_ca_stat_nd_contig (VALUE self, VALUE vaxis, VALUE rmc, VALUE vfval,
     char *op;
     boolean8_t *om;
     int8_t i;
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       idx[i] = 0;
     }
     ca_attach_n(2, ca, co);
@@ -1474,7 +1472,7 @@ ca_stat_get_offset_loop (CArray *ca, ca_size_t *dm,
                         CArray *offset)
 {
   ca_size_t i;
-  if ( level == ca->rank - 1 ) {
+  if ( level == ca->ndim - 1 ) {
     if ( dm[level] == 0 ) {
       idx[level] = 0;
       *(ca_size_t *)ca_ptr_at_index(offset, idx1) = ca_index2addr(ca, idx);
@@ -1513,13 +1511,13 @@ rb_ca_stat_nd_discrete (VALUE self, VALUE vaxis, VALUE rmc, VALUE vfval,
   ca_size_t loop_dim[CA_RANK_MAX];
   ca_size_t dm[CA_RANK_MAX], dn[CA_RANK_MAX];
   CArray *ca, *co, *first, *offset;
-  ca_size_t out_rank, loop_rank;
+  ca_size_t out_ndim, loop_ndim;
   ca_size_t mc;
   ca_size_t i, k;
 
   Data_Get_Struct(self, CArray, ca);
 
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     dm[i] = 0;
     dn[i] = 1;
   }
@@ -1530,26 +1528,26 @@ rb_ca_stat_nd_discrete (VALUE self, VALUE vaxis, VALUE rmc, VALUE vfval,
     dn[k] = 0;
   }
 
-  out_rank  = 0;
-  loop_rank = 0;
-  for (i=0; i<ca->rank; i++) {
+  out_ndim  = 0;
+  loop_ndim = 0;
+  for (i=0; i<ca->ndim; i++) {
     if ( dm[i] ) {
-      loop_dim[loop_rank] = ca->dim[i];
-      loop_rank += 1;
+      loop_dim[loop_ndim] = ca->dim[i];
+      loop_ndim += 1;
     }
     else {
-      out_dim[out_rank] = ca->dim[i];
-      out_rank += 1;
+      out_dim[out_ndim] = ca->dim[i];
+      out_ndim += 1;
     }
   }
 
-  out    = rb_carray_new(data_type, out_rank, out_dim, 0, NULL);
+  out    = rb_carray_new(data_type, out_ndim, out_dim, 0, NULL);
   Data_Get_Struct(out, CArray, co);
   
-  first  = carray_new(CA_SIZE, out_rank, out_dim, 0, NULL);
+  first  = carray_new(CA_SIZE, out_ndim, out_dim, 0, NULL);
   first->ptr = realloc(first->ptr, first->bytes*(first->elements+1));
 
-  offset = carray_new(CA_SIZE, loop_rank, loop_dim, 0, NULL);
+  offset = carray_new(CA_SIZE, loop_ndim, loop_dim, 0, NULL);
   offset->ptr = realloc(offset->ptr, offset->bytes*(offset->elements+1));
 
   ca_stat_get_offset_loop(ca, dn, 0, idx, 0, idx1, first);
@@ -1673,14 +1671,14 @@ rb_ca_stat_general (int argc, VALUE *argv, VALUE self,
 
     for (i=0; i<RARRAY_LEN(vaxis); i++) {
       k = NUM2SIZE(rb_ary_entry(vaxis, RARRAY_LEN(vaxis)-1-i));
-      CA_CHECK_INDEX(k, ca->rank);
-      if ( k != ca->rank-1-i ) {
+      CA_CHECK_INDEX(k, ca->ndim);
+      if ( k != ca->ndim-1-i ) {
         is_contig = 0;
       }
     }
 
     if ( is_contig ) {
-      if ( RARRAY_LEN(vaxis) == ca->rank ) {
+      if ( RARRAY_LEN(vaxis) == ca->ndim ) {
         return rb_ca_stat_1d(self, rmc, vfval, ca_proc);
       }
       else {
@@ -1841,7 +1839,7 @@ ca_dimstat_type2_loop (CArray *ca, CArray *co, ca_size_t mc,
   void *p;
   boolean8_t *m;
   ca_size_t i, n;
-  if ( level == co->rank ) {
+  if ( level == co->ndim ) {
     CAStatIterator it;
     n = ca->elements/co->elements;
     idx[level] = 0;
@@ -1871,7 +1869,7 @@ ca_dimstat_type2 (CArray *ca, CArray *co, ca_size_t mc, ca_stat_proc_t *ca_proc)
   char *op;
   boolean8_t *om;
   int8_t i;
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     idx[i] = 0;
   }
   ca_attach_n(2, ca, co);
@@ -1904,7 +1902,7 @@ rb_ca_dimstat_type2 (int argc, VALUE *argv, VALUE self,
   }
 
   ndim = NUM2SIZE(rndim);
-  if ( ndim <= 0 || ndim > ca->rank ) {
+  if ( ndim <= 0 || ndim > ca->ndim ) {
     rb_raise(rb_eRuntimeError, "invalid dimension specified");
   }
 

data/{carray_test.c → ext/carray_test.c}

@@ -3,10 +3,8 @@
   carray_test.c
 
   This file is part of Ruby/CArray extension library.
-  You can redistribute it and/or modify it under the terms of
-  the Ruby Licence.
 
-  Copyright (C) 2005 Hiroki Motoyoshi
+  Copyright (C) 2005-2020 Hiroki Motoyoshi
 
   This file includes the modified routine (ca_mem_hash) from 
 
@@ -34,26 +32,26 @@ ca_check_type (void *ap, int8_t data_type)
 }
 
 void
-ca_check_rank (void *ap, int rank)
+ca_check_ndim (void *ap, int ndim)
 {
   CArray *ca = (CArray *) ap;
   if ( ! ca_is_scalar(ca) ) {
-    if ( ca->rank != rank ) {
-      rb_raise(rb_eRuntimeError, "rank mismatch");
+    if ( ca->ndim != ndim ) {
+      rb_raise(rb_eRuntimeError, "ndim mismatch");
     }
   }
 }
 
 void
-ca_check_shape (void *ap, int rank, ca_size_t *dim)
+ca_check_shape (void *ap, int ndim, ca_size_t *dim)
 {
   CArray *ca = (CArray *) ap;
   int i;
   if ( ! ca_is_scalar(ca) ) {
-    if ( ca->rank != rank ) {
+    if ( ca->ndim != ndim ) {
       rb_raise(rb_eRuntimeError, "shape mismatch");
     }
-    for (i=0; i<rank; i++) {
+    for (i=0; i<ndim; i++) {
       if ( ca->dim[i] != dim[i] ) {
         rb_raise(rb_eRuntimeError, "shape mismatch");
       }
@@ -72,12 +70,12 @@ ca_check_same_data_type (void *ap1, void *ap2)
 }
 
 void
-ca_check_same_rank (void *ap1, void *ap2)
+ca_check_same_ndim (void *ap1, void *ap2)
 {
   CArray *ca1 = (CArray *) ap1;
   CArray *ca2 = (CArray *) ap2;
-  if ( ca1->rank != ca2->rank ) {
-    rb_raise(rb_eRuntimeError, "rank mismatch");
+  if ( ca1->ndim != ca2->ndim ) {
+    rb_raise(rb_eRuntimeError, "ndim mismatch");
   }
 }
 
@@ -98,10 +96,10 @@ ca_check_same_shape (void *ap1, void *ap2)
   CArray *ca2 = (CArray *) ap2;
   int i;
   if ( ( ! ca_is_scalar(ca1) ) && ( ! ca_is_scalar(ca2) ) ) {
-    if ( ca1->rank != ca2->rank ) {
+    if ( ca1->ndim != ca2->ndim ) {
       rb_raise(rb_eRuntimeError, "shape mismatch");
     }
-    for (i=0; i<ca1->rank; i++) {
+    for (i=0; i<ca1->ndim; i++) {
       if ( ca1->dim[i] != ca2->dim[i] ) {
         rb_raise(rb_eRuntimeError, "shape mismatch");
       }
@@ -114,7 +112,7 @@ ca_check_index (void *ap, ca_size_t *idx)
 {
   CArray *ca = (CArray *) ap;
   int i;
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     if ( idx[i] < 0 || idx[i] >= ca->dim[i] ) {
       rb_raise(rb_eRuntimeError, "invalid index");
     }
@@ -140,11 +138,11 @@ ca_has_same_shape (void *ap1, void *ap2)
   if ( ca_is_scalar(ca1) || ca_is_scalar(ca2) ) {
     return 1;
   }
-  else if ( ca1->rank != ca2->rank ) {
+  else if ( ca1->ndim != ca2->ndim ) {
     return 0;
   }
   else {
-    for (i=0; i<ca1->rank; i++) {
+    for (i=0; i<ca1->ndim; i++) {
       if ( ca1->dim[i] != ca2->dim[i] ) {
         return 0;
       }
@@ -158,7 +156,7 @@ ca_is_valid_index (void *ap, ca_size_t *idx)
 {
   CArray *ca = (CArray *) ap;
   int8_t i;
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     if ( idx[i] < 0 || idx[i] >= ca->dim[i] ) {
       return 0;
     }
@@ -218,13 +216,18 @@ rb_obj_is_data_class (VALUE rtype)
   return Qfalse;
 }
 
+static VALUE
+rb_ca_s_is_data_class (VALUE self, VALUE rklass)
+{
+  return rb_obj_is_data_class(rklass);
+}
+
 /* ------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    def valid_index? (*index)
-    end
-  end
+/* @overload valid_index? (*idx)
+
+(Inquiry) 
+Returns true if the given number list is valid as array index for the object
 */
 
 static VALUE
@@ -236,15 +239,17 @@ rb_ca_is_valid_index (int argc, VALUE *argv, VALUE self)
 
   Data_Get_Struct(self, CArray, ca);
 
-  if ( argc != ca->rank ) {
+  if ( argc != ca->ndim ) {
     rb_raise(rb_eArgError,
-             "invalid # of arguments (%i for %i)", argc, ca->rank);
+             "invalid # of arguments (%i for %i)", argc, ca->ndim);
   }
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     idx = NUM2SIZE(argv[i]);
+		/*
     if ( idx < 0 ) {
       idx += ca->dim[i];
     }
+		*/
     if ( idx < 0 || idx >= ca->dim[i] ) {
       return Qfalse;
     }
@@ -253,11 +258,10 @@ rb_ca_is_valid_index (int argc, VALUE *argv, VALUE self)
   return Qtrue;
 }
 
-/* rdoc:
-  class CArray
-    def valid_addr? (addr)
-    end
-  end
+/* @overload valid_addr? (*addr)
+
+(Inquiry) 
+Returns true if the given number is valid as array address for the object
 */
 
 static VALUE
@@ -268,9 +272,11 @@ rb_ca_is_valid_addr (VALUE self, VALUE raddr)
 
   Data_Get_Struct(self, CArray, ca);
   addr = NUM2SIZE(raddr);
+	/*
   if ( addr < 0 ) {
     addr += ca->elements;
   }
+	*/
   if ( addr < 0 || addr >= ca->elements ) {
     return Qfalse;
   }
@@ -279,11 +285,10 @@ rb_ca_is_valid_addr (VALUE self, VALUE raddr)
   }
 }
 
-/* rdoc:
-  class CArray
-    def has_same_shape? (other)
-    end
-  end
+/* @overload has_same_shape?
+
+(Inquiry) 
+Returns true if the object has the same shape with the given array.
 */
 
 static VALUE
@@ -381,7 +386,7 @@ ca_equal (void *ap, void *bp)
     return 0;
   }
 
-  if ( ca->rank != cb->rank )  {          /* rank comparison */
+  if ( ca->ndim != cb->ndim )  {          /* ndim comparison */
     return 0;
   }
 
@@ -389,7 +394,7 @@ ca_equal (void *ap, void *bp)
     return 0;
   }
 
-  for (i=0; i<ca->rank; i++) {
+  for (i=0; i<ca->ndim; i++) {
     if ( ca->dim[i] != cb->dim[i] ) {     /* dimensional shape comparison */
       return 0;
     }
@@ -453,12 +458,10 @@ ca_equal (void *ap, void *bp)
   return flag;
 }
 
-/* rdoc:
-  class CArray
-    def == (other)
-    end
-    alias eql? ==
-  end
+/* @overload == (other)
+
+(Inquiry) 
+Returns true if the object equals the given array.
 */
 
 static VALUE
@@ -545,11 +548,10 @@ ca_hash (CArray *ca)
   return hash;
 }
 
-/* rdoc:
-  class CArray
-    def hash
-    end
-  end
+/* @overload hash
+
+(Inquiry) 
+Returns the hash value of the object.
 */
 
 VALUE
@@ -571,11 +573,19 @@ rb_ca_modify (VALUE self)
   if ( OBJ_FROZEN(self) ) {
     rb_error_frozen("CArray object");
   }
+  /*
   if ( ( ! OBJ_TAINTED(self) ) && rb_safe_level() >= 4 ) {
     rb_raise(rb_eSecurityError, "Insecure: can't modify carray");
   }
+  */
 }
 
+/* @overload freeze
+
+Freeze the object.
+
+*/
+
 VALUE
 rb_ca_freeze (VALUE self)
 {
@@ -585,7 +595,6 @@ rb_ca_freeze (VALUE self)
   return rb_obj_freeze(self);
 }
 
-
 void
 Init_carray_test ()
 {
@@ -597,6 +606,9 @@ Init_carray_test ()
   rb_define_method(rb_cCArray, "freeze",  rb_ca_freeze, 0);
 
   rb_define_method(rb_cCArray, "==", rb_ca_equal, 1);
-  rb_define_method(rb_cCArray, "eql?", rb_ca_equal, 1);
+  rb_define_alias(rb_cCArray, "eql?", "==");
   rb_define_method(rb_cCArray, "hash", rb_ca_hash, 0);
+
+  rb_define_singleton_method(rb_cCArray, "data_class?", rb_ca_s_is_data_class, 1);
+
 }