carray 1.5.1 → 1.5.2

data/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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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

data/ext/carray_generate.c

@@ -3,10 +3,8 @@
   carray_generate.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,17 +13,11 @@
 
 /* ----------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    # Sets true at the given index for the boolean array and returns self.
-    # It accept the arguments same as for CArray#[].
-    def set (*argv)
-    end
-    # Sets false at the given index for the boolean array and returns self.
-    # It accept the arguments same as for CArray#[].
-    def unset (*argv)
-    end
-  end
+/* @overload set (*idx)
+
+(Boolean, Modification)
+Sets true at the given index for the boolean array and returns self.
+It accept the arguments same as for CArray#[].
 */
 
 static VALUE
@@ -40,6 +32,13 @@ rb_ca_boolean_set (int argc, VALUE *argv, VALUE self)
   return self;
 }
 
+/* @overload unset (*idx)
+
+(Boolean, Modification)
+Sets false at the given index for the boolean array and returns self.
+It accept the arguments same as for CArray#[].
+*/
+
 static VALUE
 rb_ca_boolean_unset (int argc, VALUE *argv, VALUE self)
 {
@@ -54,12 +53,10 @@ rb_ca_boolean_unset (int argc, VALUE *argv, VALUE self)
 
 /* ----------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    # Returns the 1d index array for non-zero elements of self
-    def where
-    end
-  end
+/* @overload where
+
+(Conversion)
+Returns the 1d index array for non-zero elements of self
 */
 
 VALUE
@@ -245,8 +242,13 @@ rb_ca_seq_bang_object (int argc, VALUE *argv, VALUE self)
   return self;
 }
 
-/* rdoc:
-  class CArray
+/* @overload seq! (init_val=0, step=1) {|elem| ... }
+
+(Conversion, Destructive)
+Generates sequential data with initial value `init_val` 
+and step value `step`. For object array, if the second argument
+is Symbol object, it will be interpreted as stepping method and 
+it is called for the last element in each step.
     # call-seq:
     #   seq (init_val=0, step=1)
     #   seq (init_val=0, step=1) {|x| ... }
@@ -258,12 +260,6 @@ rb_ca_seq_bang_object (int argc, VALUE *argv, VALUE self)
     # is Symbol object, it will be interpreted as stepping method and 
     # it is called for the last element in each step.
     #
-    def seq (init_val=0, step=1)
-    end
-    # 
-    def seq! (init_val=0, step=1)
-    end
-  end
 */
 
 static VALUE
@@ -339,6 +335,26 @@ rb_ca_seq_bang_method (int argc, VALUE *argv, VALUE self)
   return self;
 }
 
+/* @overload seq (init_val=0, step=1) {|elem| ... }
+
+(Conversion)
+Generates sequential data with initial value `init_val` 
+and step value `step`. For object array, if the second argument
+is Symbol object, it will be interpreted as stepping method and 
+it is called for the last element in each step.
+    # call-seq:
+    #   seq (init_val=0, step=1)
+    #   seq (init_val=0, step=1) {|x| ... }
+    #   seq (init_val=0, step=A_symbol)            ### for object array
+    #   seq (init_val=0, step=A_symbol) {|x| ...}  ### for object array
+    #
+    # Generates sequential data with initial value `init_val` 
+    # and step value `step`. For object array, if the second argument
+    # is Symbol object, it will be interpreted as stepping method and 
+    # it is called for the last element in each step.
+    #
+*/
+
 static VALUE
 rb_ca_seq_method (int argc, VALUE *argv, VALUE self)
 {
@@ -456,15 +472,10 @@ ca_swap_bytes (char *ptr, ca_size_t bytes, ca_size_t elements)
 
 }
 
-/* rdoc:
-  class CArray
-    # Swaps the byte order of each element.
-    def swap_bytes
-    end
-    # 
-    def swap_bytes!
-    end
-  end
+/* @overload swap_bytes!
+
+(Conversion, Destructive)
+Swaps the byte order of each element.
 */
 
 VALUE
@@ -553,6 +564,12 @@ rb_ca_swap_bytes_bang (VALUE self)
   return self;
 }
 
+/* @overload swap_bytes
+
+(Conversion)
+Swaps the byte order of each element.
+*/
+
 VALUE
 rb_ca_swap_bytes (VALUE self)
 {
@@ -664,20 +681,17 @@ rb_ca_swap_bytes (VALUE self)
           }                                                          \
         }                                                            \
       }                                                              \
-    }                                                              \    
+    }                                                                \
   }
 
-/* rdoc:
-  class CArray
-    # trims the data into the range between min and max. If `fill_value`
-    # is given, the element out of the range between min and max is filled
-    # by `fill_value`
-    def trim (min, max, fill_value=nil)
-    end
-    #
-    def trim! (min, max, fill_value=nil)
-    end
-  end
+
+
+/* @overload trim! (min, max, fill_value=nil)
+
+(Conversion)
+Trims the data into the range between min and max. If `fill_value`
+is given, the element out of the range between min and max is filled
+by `fill_value`
 */
 
 static VALUE
@@ -720,6 +734,14 @@ rb_ca_trim_bang (int argc, VALUE *argv, VALUE self)
   return self;
 }
 
+/* @overload trim (min, max, fill_value=nil)
+
+(Conversion)
+Trims the data into the range between min and max. If `fill_value`
+is given, the element out of the range between min and max is filled
+by `fill_value`
+*/
+
 static VALUE
 rb_ca_trim (int argc, VALUE *argv, VALUE self)
 {
@@ -727,7 +749,6 @@ rb_ca_trim (int argc, VALUE *argv, VALUE self)
   return rb_ca_trim_bang(argc, argv, out);
 }
 
-
 void
 Init_carray_generate ()
 {

data/ext/carray_iterator.c

@@ -3,10 +3,8 @@
   carray_iterator.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
 
 ---------------------------------------------------------------------------- */
 
@@ -209,7 +207,7 @@ ca_iter_prepare_output (VALUE self, VALUE rtype, VALUE rbytes)
 
 /* -------------------------------------------------------------------- */
 
-/* rdoc:
+/* yard:
   class CAIterator
     def ndim
     end
@@ -223,7 +221,7 @@ rb_ca_iter_ndim (VALUE self)
   return LONG2NUM(ca_iter_ndim(self));
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def dim
     end
@@ -245,7 +243,7 @@ rb_ca_iter_dim (VALUE self)
   return rdim;
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def elements
     end
@@ -258,7 +256,7 @@ rb_ca_iter_elements (VALUE self)
   return SIZE2NUM(ca_iter_elements(self));
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def reference
     end
@@ -271,7 +269,7 @@ rb_ca_iter_reference (VALUE self)
   return ca_iter_reference(self);
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def kernel_at_addr
     end
@@ -289,7 +287,7 @@ rb_ca_iter_kernel_at_addr (int argc, VALUE *argv, VALUE self)
   return ca_iter_kernel_at_addr(self, NUM2SIZE(raddr), rcarray);
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def kernel_at_index
     end
@@ -317,7 +315,7 @@ rb_ca_iter_kernel_at_index (int argc, VALUE *argv, VALUE self)
   return ca_iter_kernel_at_index(self, idx, rcarray);
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def kernel_move_to_addr
     end
@@ -330,7 +328,7 @@ rb_ca_iter_kernel_move_to_addr (VALUE self, VALUE raddr, VALUE rker)
   return ca_iter_kernel_move_to_addr(self, NUM2SIZE(raddr), rker);
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def kernel_move_to_index
     end
@@ -351,7 +349,7 @@ rb_ca_iter_kernel_move_to_index (VALUE self, VALUE rindex, VALUE rker)
   return ca_iter_kernel_move_to_index(self, idx, rker);
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def prepare_output
     end
@@ -371,7 +369,7 @@ rb_ca_iter_prepare_output (int argc, VALUE *argv, VALUE self)
 
 /* -------------------------------------------------------------------- */
 
-/* rdoc:
+/* yard:
   class CAIterator
     def calculate
     end
@@ -470,7 +468,7 @@ rb_ca_iter_calculate (int argc, VALUE *argv, VALUE self)
   return routput;
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def filter
     end
@@ -547,7 +545,7 @@ rb_ca_iter_filter (int argc, VALUE *argv, VALUE self)
   return routput;
 }
 
-/* rdoc:
+/* yard:
   class CAIterator
     def evaluate
     end

data/ext/carray_loop.c

@@ -3,10 +3,8 @@
   carray_loop.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
 
 ---------------------------------------------------------------------------- */
 
@@ -43,18 +41,14 @@ rb_ca_s_each_index_internal (int ndim, VALUE *dim, uint8_t indim, VALUE ridx)
   return ret;
 }
 
-/* rdoc:
-  #  Iterates with the multi-dimensional indeces for the given
-  #  dimension numbers.
-  #
-  #     CArray.each_index(3,2){|i,j| print "(#{i} #{j}) " }
-  #
-  #  produces:
-  #
-  #     (0 0) (0 1) (1 0) (1 1) (2 0) (2 1) (3 0) (3 1)
-  #
-  def CArray.each_index(*argv) # :yields: i0, i1, ...
-  end
+/* @overload each_index (*shape)
+
+(Iterator) Iterates with the multi-dimensional indeces for the given
+dimension numbers.
+
+      CArray.each_index(3,2){|i,j| print "(#{i} #{j}) " }
+      produces:
+      (0 0) (0 1) (1 0) (1 1) (2 0) (2 1) (3 0) (3 1)
 */
 
 static VALUE
@@ -69,12 +63,10 @@ rb_ca_s_each_index (int ndim, VALUE *dim, VALUE self)
 
 /* ------------------------------------------------------------------- */
 
-/* rdoc:
-  class CArray
-    #
-    def each # :yields: v
-    end
-  end
+/* @overload each () {|elem| ... }
+
+(Iterator) Iterates all the elements of the object.
+
 */
 
 static VALUE
@@ -92,12 +84,10 @@ rb_ca_each (VALUE self)
   return ret;
 }
 
-/* rdoc:
-  class CArray
-    #
-    def each_with_addr # :yields: v, addr
-    end
-  end
+/* @overload each_with_addr () {|elem, addr| ... }
+
+(Iterator) Iterates all the elements of the object.
+
 */
 
 static VALUE
@@ -115,12 +105,9 @@ rb_ca_each_with_addr (VALUE self)
   return ret;
 }
 
-/* rdoc:
-  class CArray
-    #
-    def each_addr() # :yields: addr
-    end
-  end
+/* @overload each_addr () {|addr| ... }
+
+(Iterator) Iterates all address of the object.
 */
 
 static VALUE
@@ -160,19 +147,16 @@ rb_ca_each_index_internal (VALUE self, int8_t level, VALUE ridx)
   return ret;
 }
 
-/* rdoc:
-  class CArray
-    # Iterates with the multi-dimensional indeces for the dimension of <i>ca</i>.
-    #
-    #    CArray.int(3,2).each_index(){|i,j| print "(#{i} #{j}) " }
-    #
-    #  <em>produces:</em>
-    #
-    #     (0 0) (0 1) (1 0) (1 1) (2 0) (2 1) (3 0) (3 1)
-    #
-    def each_index # :yields: i0, i1, ...
-    end
-  end
+/* @overload each_index () {|idx| ... }
+
+(Iterator) Iterates all index of the object.
+    
+        CArray.int(3,2).each_index(){|i,j| print "(#{i} #{j}) " }
+    
+      <em>produces:</em>
+    
+         (0 0) (0 1) (1 0) (1 1) (2 0) (2 1) (3 0) (3 1)
+    
 */
 
 static VALUE
@@ -187,12 +171,9 @@ rb_ca_each_index (VALUE self)
   return rb_ca_each_index_internal(self, 0, ridx);
 }
 
-/* rdoc:
-  class CArray
-    #
-    def map! # :yields: v
-    end
-  end
+/* @overload map! () {|elem| ... }
+
+(Iterator, Destructive) Iterates all elements of the object and stores the return from the block to the element.
 */
 
 static VALUE
@@ -243,12 +224,10 @@ rb_ca_each_with_index_internal (VALUE self,
   return ret;
 }
 
-/* rdoc:
-  class CArray
-    # 
-    def each_with_index # :yields: v, idx 
-    end
-  end
+/* @overload each_with_index () {|elem, idx| ... }
+
+[TBD]
+
 */
 
 static VALUE
@@ -293,12 +272,10 @@ rb_ca_map_with_index_bang_internal (VALUE self,
   }
 }
 
-/* rdoc:
-  class CArray
-    #
-    def map_with_index! # :yields: v, idx
-    end
-  end
+/* @overload map_with_index () {|elem, idx| ... }
+
+[TBD]
+
 */
 
 static VALUE
@@ -347,12 +324,10 @@ rb_ca_map_index_bang_internal (VALUE self,
   }
 }
 
-/* rdoc:
-  class CArray
-    #
-    def map_index! # :yields: i0, i1, ...
-    end
-  end
+/* @overload map_index! () {|idx| ... }
+
+[TBD]
+
 */
 
 static VALUE
@@ -375,12 +350,10 @@ rb_ca_map_index_bang (VALUE self)
   return self;
 }
 
-/* rdoc:
-  class CArray
-    #
-    def map_with_addr! # :yields: v, addr
-    end
-  end
+/* @overload map_with_addr! () {|elem, addr| ... }
+
+[TBD]
+
 */
 
 static VALUE
@@ -406,12 +379,10 @@ rb_ca_map_with_addr_bang (VALUE self)
 }
 
 
-/* rdoc:
-  class CArray
-    #
-    def map_addr! # :yields: addr
-    end
-  end
+/* @overload map_addr! () {|addr| ... }
+
+[TBD]
+
 */
 
 static VALUE