carray 1.4.0 → 1.5.5

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

@@ -3,10 +3,8 @@
   carray_core.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
 
 ---------------------------------------------------------------------------- */
 
@@ -382,7 +380,7 @@ ca_addr2index (void *ap, ca_size_t addr, ca_size_t *idx)
   CArray *ca = (CArray *) ap;
   ca_size_t *dim = ca->dim;
   int8_t i;
-  for (i=ca->rank-1; i>=0; i--) {
+  for (i=ca->ndim-1; i>=0; i--) {
     idx[i] = addr % dim[i];
     addr  /= dim[i];
   }
@@ -398,7 +396,7 @@ ca_index2addr (void *ap, ca_size_t *idx)
   int8_t   i;
   ca_size_t  n;
   n = idx[0];
-  for (i=1; i<ca->rank; i++) {
+  for (i=1; i<ca->ndim; i++) {
     n = dim[i]*n+idx[i];
   }
   return n;
@@ -998,10 +996,13 @@ rb_ca_s_ensure_detach (VALUE list)
   return Qnil;
 }
 
-/* rdoc:
-  def CArray.attach(*argv) # :nodoc:
-    yield
-  end
+/* @overload attach (*arrays)
+
+(Internal) Guarantees that the reference memory block is attached.
+The memory block is detached at the end of the block evaluation.
+It is not ensured the syncing the memory block at the end of the block evaluation.
+
+@yield
 */
 
 static VALUE
@@ -1035,10 +1036,13 @@ rb_ca_s_ensure_sync_detach (VALUE list)
   return Qnil;
 }
 
-/* rdoc:
-  def CArray.attach!(*argv) # :nodoc:
-    yield
-  end
+/* @overload attach! (*arrays)
+
+(Internal) Guarantees that the reference memory block is attached.
+The memory block is detached at the end of the block evaluation.
+It is ensured the syncing the memory block at the end of the block evaluation.
+
+@yield
 */
 
 static VALUE
@@ -1065,12 +1069,13 @@ rb_ca_ensure_detach (VALUE self)
   return Qnil;
 }
 
-/* rdoc:
-  class CArray
-    def attach () # :nodoc:
-      yield
-    end
-  end
+/* @overload attach 
+
+(Internal) Guarantees that the reference memory block is attached.
+The memory block is detached at the end of the block evaluation.
+It is ensured the syncing the memory block at the end of the block evaluation.
+
+@yield
 */
 
 static VALUE
@@ -1088,12 +1093,13 @@ rb_ca_ensure_sync_detach (VALUE self)
   return Qnil;
 }
 
-/* rdoc:
-  class CArray
-    def attach! () # :nodoc:
-      yield
-    end
-  end
+/* @overload attach! 
+
+(Internal) Guarantees that the reference memory block is attached.
+The memory block is detached at the end of the block evaluation.
+It is ensured the syncing the memory block at the end of the block evaluation.
+
+@yield
 */
 
 static VALUE
@@ -1104,7 +1110,11 @@ rb_ca_attach_bang (VALUE self)
   return rb_ensure(rb_yield, self, rb_ca_ensure_sync_detach, self);
 }
 
-/* CArray#__attach__ */
+/* @overload __attach__ 
+
+(Internal, DevelopperOnly) Attaches the reference memory block.
+User must call "CArray#__detach__" appropreate timing.
+*/
 
 static VALUE
 rb_ca__attach__ (VALUE self)
@@ -1113,7 +1123,10 @@ rb_ca__attach__ (VALUE self)
   return self;
 }
 
-/* CArray#__sync__ */
+/* @overload __detach__ 
+
+(Internal, DevelopperOnly) Syncs the reference memory block to the parent array.
+*/
 
 static VALUE
 rb_ca__sync__ (VALUE self)
@@ -1123,7 +1136,10 @@ rb_ca__sync__ (VALUE self)
   return self;
 }
 
-/* CArray#__detach__ */
+/* @overload __detach__ 
+
+(Internal, DevelopperOnly) Detaches the reference memory block.
+*/
 
 static VALUE
 rb_ca__detach__ (VALUE self)
@@ -1162,18 +1178,15 @@ rb_ca_data_class_encode (VALUE self, VALUE obj)
 
 /* ------------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    # Returns data class member names
-    def members
-    end
-  end
+/* @overload members
+
+(Inquiry) Returns data class member names
 */
 
 VALUE
 rb_ca_members (VALUE self)
 {
-  VALUE data_class = rb_ca_data_class(self);
+  volatile VALUE data_class = rb_ca_data_class(self);
   if ( NIL_P(data_class) ) {
     rb_raise(rb_eRuntimeError, "carray doesn't have data class");
   }
@@ -1185,9 +1198,9 @@ rb_ca_members (VALUE self)
 VALUE
 rb_ca_field_as_member (VALUE self, VALUE sym)
 {
-  VALUE data_class = rb_ca_data_class(self);
-  VALUE member;
-  VALUE obj;
+  volatile VALUE data_class = rb_ca_data_class(self);
+  volatile VALUE member;
+  volatile VALUE obj;
 
   if ( NIL_P(data_class) ) {
     rb_raise(rb_eRuntimeError, "carray doesn't have data class");
@@ -1201,23 +1214,29 @@ rb_ca_field_as_member (VALUE self, VALUE sym)
              "for data_class array");
   }
 
-  if ( TYPE(sym) == T_SYMBOL ) {
-    sym = rb_funcall(sym, rb_intern("to_s"), 0);
-  }
-  else if ( rb_obj_is_kind_of(sym, rb_cInteger) ) {
-    VALUE member_names = rb_const_get(data_class, rb_intern("MEMBERS"));
-    sym = rb_ary_entry(member_names, NUM2SIZE(sym));
+  if ( rb_obj_is_kind_of(sym, rb_cInteger) ) {
+      volatile VALUE member_names = rb_const_get(data_class, rb_intern("MEMBERS"));
+      sym = rb_ary_entry(member_names, NUM2SIZE(sym));
+      obj = rb_hash_aref(member, sym);
+    }
+  else {
+    obj = rb_hash_aref(member, sym);
+    if ( NIL_P(obj) ) {
+      sym = rb_funcall(sym, rb_intern("to_s"), 0);
+      obj = rb_hash_aref(member, sym);      
+    }
   }
 
-  obj = rb_hash_aref(member, sym);
-
   if ( rb_obj_is_carray(obj) ) {
     return obj;
   }
   else {
-    VALUE MEMBER_TABLE = rb_const_get(data_class, rb_intern("MEMBER_TABLE"));
-    VALUE info = rb_hash_aref(MEMBER_TABLE, sym);
+    volatile VALUE MEMBER_TABLE = rb_const_get(data_class, rb_intern("MEMBER_TABLE"));
+    volatile VALUE info = rb_hash_aref(MEMBER_TABLE, sym);
     if ( NIL_P(info) ) {
+      if ( TYPE(sym) != T_STRING ) {
+        sym = rb_funcall(sym, rb_intern("to_s"), 0);
+      }
       rb_raise(rb_eRuntimeError,
                "can't find data_member named <%s>", StringValuePtr(sym));
     }
@@ -1228,18 +1247,15 @@ rb_ca_field_as_member (VALUE self, VALUE sym)
   }
 }
 
-/* rdoc:
-  class CArray
-    # Returns an array of data class members (fields)
-    def fields
-    end
-  end
+/* @overload fields
+
+(Reference) Returns an array of data class members (fields)
 */
 
 VALUE
 rb_ca_fields (VALUE self)
 {
-  VALUE data_class = rb_ca_data_class(self);
+  volatile VALUE data_class = rb_ca_data_class(self);
   volatile VALUE member_names, list;
   int i;
   if ( NIL_P(data_class) ) {
@@ -1254,18 +1270,15 @@ rb_ca_fields (VALUE self)
   return list;
 }
 
-/* rdoc:
-  class CArray
-    # Returns an array of data class members (fields) with names specified 
-    def fields_at (*names)
-    end
-  end
+/* @overload fields_at (*names)
+
+Returns an array of data class members (fields) with names specified 
 */
 
 VALUE
 rb_ca_fields_at (int argc, VALUE *argv, VALUE self)
 {
-  VALUE data_class = rb_ca_data_class(self);
+  volatile VALUE data_class = rb_ca_data_class(self);
   volatile VALUE member_names, list;
   int i;
   if ( NIL_P(data_class) ) {

data/ext/carray_data_type.c

@@ -0,0 +1,66 @@
+#include "carray.h"
+
+VALUE rb_cCArrayBoolean;
+VALUE rb_cCArrayUInt8;
+VALUE rb_cCArrayUInt16;
+VALUE rb_cCArrayUInt32;
+VALUE rb_cCArrayUInt64;
+VALUE rb_cCArrayInt8;
+VALUE rb_cCArrayInt16;
+VALUE rb_cCArrayInt32;
+VALUE rb_cCArrayInt64;
+VALUE rb_cCArrayFloat32;
+VALUE rb_cCArrayFloat64;
+VALUE rb_cCArrayFloat128;
+VALUE rb_cCArrayCmplx64;
+VALUE rb_cCArrayCmplx128;
+VALUE rb_cCArrayCmplx256;
+VALUE rb_cCArrayObject;
+VALUE rb_cCArrayFixlen;
+
+VALUE
+ca_data_type_class (int8_t data_type)
+{
+  switch ( data_type ) {
+  case CA_BOOLEAN:  return rb_cCArrayBoolean; break;
+  case CA_INT8:     return rb_cCArrayInt8;  break;
+  case CA_UINT8:    return rb_cCArrayUInt8; break;
+  case CA_INT16:    return rb_cCArrayInt16;  break;
+  case CA_UINT16:   return rb_cCArrayUInt16; break;
+  case CA_INT32:    return rb_cCArrayInt32;  break;
+  case CA_UINT32:   return rb_cCArrayUInt32; break;
+  case CA_INT64:    return rb_cCArrayInt64;  break;
+  case CA_UINT64:   return rb_cCArrayUInt64; break;
+  case CA_FLOAT32:  return rb_cCArrayFloat32;  break;
+  case CA_FLOAT64:  return rb_cCArrayFloat64;  break;
+  case CA_FLOAT128: return rb_cCArrayFloat128;  break;
+  case CA_CMPLX64:  return rb_cCArrayCmplx64;  break;
+  case CA_CMPLX128: return rb_cCArrayCmplx128;  break;
+  case CA_CMPLX256: return rb_cCArrayCmplx256;  break;
+  case CA_OBJECT:   return rb_cCArrayObject;  break;
+  default: rb_raise(rb_eRuntimeError, "invalid data type");
+  }
+
+}
+
+void
+Init_carray_data_type ()
+{
+  rb_cCArrayBoolean  = rb_define_class_under(rb_cCArray, "Boolean", rb_cObject);
+  rb_cCArrayUInt8  = rb_define_class_under(rb_cCArray, "UInt8", rb_cObject);
+  rb_cCArrayUInt16 = rb_define_class_under(rb_cCArray, "UInt16", rb_cObject);
+  rb_cCArrayUInt32 = rb_define_class_under(rb_cCArray, "UInt32", rb_cObject);
+  rb_cCArrayUInt64 = rb_define_class_under(rb_cCArray, "UInt64", rb_cObject);
+  rb_cCArrayInt8  = rb_define_class_under(rb_cCArray, "Int8", rb_cObject);
+  rb_cCArrayInt16 = rb_define_class_under(rb_cCArray, "Int16", rb_cObject);
+  rb_cCArrayInt32 = rb_define_class_under(rb_cCArray, "Int32", rb_cObject);
+  rb_cCArrayInt64 = rb_define_class_under(rb_cCArray, "Int64", rb_cObject);
+  rb_cCArrayFloat32 = rb_define_class_under(rb_cCArray, "Float32", rb_cObject);
+  rb_cCArrayFloat64 = rb_define_class_under(rb_cCArray, "Float64", rb_cObject);
+  rb_cCArrayFloat128 = rb_define_class_under(rb_cCArray, "Float128", rb_cObject);
+  rb_cCArrayCmplx64 = rb_define_class_under(rb_cCArray, "Cmplx64", rb_cObject);
+  rb_cCArrayCmplx128 = rb_define_class_under(rb_cCArray, "Cmplx128", rb_cObject);
+  rb_cCArrayCmplx256 = rb_define_class_under(rb_cCArray, "Cmplx256", rb_cObject);
+  rb_cCArrayObject = rb_define_class_under(rb_cCArray, "Object", rb_cObject);
+  rb_cCArrayFixlen = rb_define_class_under(rb_cCArray, "Fixlen", rb_cObject);
+}

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

@@ -3,10 +3,8 @@
   carray_element.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
 
 ---------------------------------------------------------------------------- */
 
@@ -15,11 +13,9 @@
 
 /* ------------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    def elem_swap
-    end
-  end
+/* @overload elem_swap (idx1, idx2)
+
+(Element) Swaps the values at the elements which are specified by arguments.
 */
 
 VALUE
@@ -48,7 +44,7 @@ rb_ca_elem_swap (VALUE self, VALUE ridx1, VALUE ridx2)
   }
 
   if ( TYPE(ridx1) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx1, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx1[i] = k;
@@ -71,7 +67,7 @@ rb_ca_elem_swap (VALUE self, VALUE ridx1, VALUE ridx2)
   }
 
   if ( TYPE(ridx2) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx2, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx2[i] = k;
@@ -127,11 +123,9 @@ rb_ca_elem_swap (VALUE self, VALUE ridx1, VALUE ridx2)
   return self;
 }
 
-/* rdoc:
-  class CArray
-    def elem_copy
-    end
-  end
+/* @overload elem_copy (idx1, idx2)
+
+(Element) Copies the value of the element of idx1 to the element of idx2
 */
 
 VALUE
@@ -159,7 +153,7 @@ rb_ca_elem_copy (VALUE self, VALUE ridx1, VALUE ridx2)
   }
 
   if ( TYPE(ridx1) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx1, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx1[i] = k;
@@ -180,7 +174,7 @@ rb_ca_elem_copy (VALUE self, VALUE ridx1, VALUE ridx2)
   }
 
   if ( TYPE(ridx2) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx2, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx2[i] = k;
@@ -207,11 +201,9 @@ rb_ca_elem_copy (VALUE self, VALUE ridx1, VALUE ridx2)
   return self;
 }
 
-/* rdoc:
-  class CArray
-    def elem_store
-    end
-  end
+/* @overload elem_store (idx, obj)
+
+(Element) Stores the object value in the element of idx.
 */
 
 VALUE
@@ -228,7 +220,7 @@ rb_ca_elem_store (VALUE self, VALUE ridx, VALUE obj)
   Data_Get_Struct(self, CArray, ca);
 
   if ( TYPE(ridx) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx[i] = k;
@@ -245,11 +237,9 @@ rb_ca_elem_store (VALUE self, VALUE ridx, VALUE obj)
   return obj;
 }
 
-/* rdoc:
-  class CArray
-    def elem_fetch
-    end
-  end
+/* @overload elem_fetch (idx)
+
+(Element) Fetches the object value at the element of idx.
 */
 
 VALUE
@@ -264,7 +254,7 @@ rb_ca_elem_fetch (VALUE self, VALUE ridx)
   Data_Get_Struct(self, CArray, ca);
 
   if ( TYPE(ridx) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx[i] = k;
@@ -279,11 +269,9 @@ rb_ca_elem_fetch (VALUE self, VALUE ridx)
   }
 }
 
-/* rdoc:
-  class CArray
-    def elem_incr
-    end
-  end
+/* @overload elem_incr (idx)
+
+(Element) Increments the value by 1 at the element of idx.
 */
 
 VALUE
@@ -314,7 +302,7 @@ rb_ca_elem_incr (VALUE self, VALUE ridx1)
   has_mask = ( ca->mask ) ? 1 : 0;
 
   if ( TYPE(ridx1) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx1, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx1[i] = k;
@@ -366,11 +354,9 @@ rb_ca_elem_incr (VALUE self, VALUE ridx1)
   return out;
 }
 
-/* rdoc:
-  class CArray
-    def elem_decr
-    end
-  end
+/* @overload elem_decr (idx)
+
+(Element) Decrements the value by 1 at the element of idx.
 */
 
 VALUE
@@ -401,7 +387,7 @@ rb_ca_elem_decr (VALUE self, VALUE ridx1)
   has_mask = ( ca->mask ) ? 1 : 0;
 
   if ( TYPE(ridx1) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx1, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx1[i] = k;
@@ -453,11 +439,9 @@ rb_ca_elem_decr (VALUE self, VALUE ridx1)
   return out;
 }
 
-/* rdoc:
-  class CArray
-    def elem_masked?
-    end
-  end
+/* @overload elem_masked? (idx)
+
+(Masking, Element) Returns true if the element at given idx is masked.
 */
 
 VALUE
@@ -475,7 +459,7 @@ rb_ca_elem_test_masked (VALUE self, VALUE ridx1)
   ca_update_mask(ca);
 
   if ( TYPE(ridx1) == T_ARRAY ) {
-    for (i=0; i<ca->rank; i++) {
+    for (i=0; i<ca->ndim; i++) {
       k = NUM2SIZE(rb_ary_entry(ridx1, i));
       CA_CHECK_INDEX(k, ca->dim[i]);
       idx1[i] = k;
@@ -498,12 +482,9 @@ rb_ca_elem_test_masked (VALUE self, VALUE ridx1)
 
 /* ----------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    # used in CAHistogram.
-    def incr_addr
-    end
-  end
+/* @overload incr_addr (addr)
+
+(Element) Increment the value at the element of addr.
 */
 
 static VALUE