carray 1.5.1 → 1.5.2

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

data/ext/carray_stat_proc.rb

@@ -286,12 +286,10 @@ header = <
   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
 
 ---------------------------------------------------------------------------- */
 

data/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 
 
@@ -220,11 +218,10 @@ rb_obj_is_data_class (VALUE rtype)
 
 /* ------------------------------------------------------------- */
 
-/* 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
@@ -253,11 +250,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
@@ -279,11 +275,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
@@ -453,12 +448,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 +538,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
@@ -578,6 +570,12 @@ rb_ca_modify (VALUE self)
   */
 }
 
+/* @overload freeze
+
+Freeze the object.
+
+*/
+
 VALUE
 rb_ca_freeze (VALUE self)
 {
@@ -598,6 +596,6 @@ 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);
 }

data/ext/carray_undef.c

@@ -3,10 +3,8 @@
   carray_undef.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
 
 ---------------------------------------------------------------------------- */
 

data/ext/carray_utils.c

@@ -3,10 +3,8 @@
   carray_utils.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
 
 ---------------------------------------------------------------------------- */
 
@@ -422,6 +420,11 @@ ca_bounds_normalize_index (int8_t bounds, ca_size_t size0, ca_size_t k)
   }
 }
 
+/* @private
+@overload scan_float (str, fill_value=nil)
+
+*/
+
 static VALUE
 rb_ca_s_scan_float (int argc, VALUE *argv, VALUE self)
 {
@@ -447,6 +450,11 @@ rb_ca_s_scan_float (int argc, VALUE *argv, VALUE self)
   }
 }
 
+/* @private
+@overload scan_int (str, fill_value=nil)
+
+*/
+
 static VALUE
 rb_ca_s_scan_int (int argc, VALUE *argv, VALUE self)
 {
@@ -564,7 +572,7 @@ rb_ca_guess_type_and_bytes (VALUE rtype, VALUE rbytes,
   }
 }
 
-/* rdoc:
+/* @private
   def CArray.guess_type_and_bytes (type, bytes=0)
   end
 */

data/ext/extconf.rb

@@ -219,7 +219,7 @@ carray_stat_proc.c: carray_stat_proc.rb
 carray_math.c: carray_math.rb
 	${RUBY} carray_math.rb
 
-rdoc:
+yard:
 	sh utils/create_rdoc.sh
 
 clean-generated:

data/ext/mkmath.rb

@@ -305,7 +305,7 @@ static VALUE rb_ca_#{name}_bang (VALUE self, VALUE other)
 }
   end
   METHODS     << %{
-  rb_define_method(rb_cCArray, "#{op}!", rb_ca_#{name}_bang, 1);
+  rb_define_method(rb_cCArray, "#{name}!", rb_ca_#{name}_bang, 1);
 }
 
 end

data/ext/ruby_carray.c

@@ -3,10 +3,8 @@
   ruby_carray.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
 
 ---------------------------------------------------------------------------- */
 
@@ -97,7 +95,7 @@ Init_carray_ext ()
   rb_eCADataTypeError =
     rb_define_class_under(rb_cCArray, "DataTypeError", rb_eStandardError);
 
-  /* rdoc:
+  /* yard:
      class CArray::DataTypeError # :nodoc:
      end
   */
@@ -111,7 +109,7 @@ Init_carray_ext ()
 
   /* -- version -- */
 
-  /* rdoc: 
+  /* yard: 
     class CArray
       VERSION = nil         # :nodoc:
       VERSION_CODE = nil    # :nodoc:
@@ -122,11 +120,17 @@ Init_carray_ext ()
     end
   */
   
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION", rb_str_new2(CA_VERSION));
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION_CODE", INT2NUM(CA_VERSION_CODE));
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION_MAJOR", INT2NUM(CA_VERSION_MAJOR));
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION_MINOR", INT2NUM(CA_VERSION_MINOR));
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION_TEENY", INT2NUM(CA_VERSION_TEENY));
+  /* @private */
   rb_define_const(rb_cCArray, "VERSION_DATE", rb_str_new2(CA_VERSION_DATE));
 
   /* -- system -- */
@@ -135,8 +139,10 @@ Init_carray_ext ()
   rb_define_const(rb_cObject, "CA_NIL", CA_NIL);
 
 #ifdef HAVE_COMPLEX_H
+  /* @private */
   rb_define_const(rb_cCArray, "HAVE_COMPLEX", Qtrue);
 #else
+  /* @private */
   rb_define_const(rb_cCArray, "HAVE_COMPLEX", Qfalse);
 #endif
 
@@ -169,7 +175,6 @@ Init_carray_ext ()
   rb_define_const(rb_cObject, "CA_DCOMPLEX",    INT2NUM(CA_DCOMPLEX));
   rb_define_const(rb_cObject, "CA_SIZE",        INT2NUM(CA_SIZE));
 
-
   rb_define_const(rb_cObject, "CA_ALIGN_VOIDP",    INT2NUM(CA_ALIGN_VOIDP));
   rb_define_const(rb_cObject, "CA_ALIGN_FIXLEN",   INT2NUM(CA_ALIGN_INT8));
   rb_define_const(rb_cObject, "CA_ALIGN_BOOLEAN",  INT2NUM(CA_ALIGN_INT8));

data/ext/ruby_ccomplex.c

@@ -3,10 +3,8 @@
   ruby_ccomplex.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
 
 ---------------------------------------------------------------------------- */
 

data/ext/ruby_float_func.c

@@ -3,10 +3,8 @@
   ruby_numeric.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
 
 ---------------------------------------------------------------------------- */
 

data/ext/version.h

@@ -3,16 +3,14 @@
   version.h
 
   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
 
 ---------------------------------------------------------------------------- */
 
-#define CA_VERSION "1.5.1"
-#define CA_VERSION_CODE 151
+#define CA_VERSION "1.5.2"
+#define CA_VERSION_CODE 152
 #define CA_VERSION_MAJOR 1
 #define CA_VERSION_MINOR 5
-#define CA_VERSION_TEENY 1
-#define CA_VERSION_DATE "2020/07/01"
+#define CA_VERSION_TEENY 2
+#define CA_VERSION_DATE "2020/07/22"

data/lib/carray.rb

@@ -32,6 +32,7 @@ require 'carray/transform'
 require 'carray/convert'
 require 'carray/testing'
 require 'carray/ordering'
+require 'carray/broadcast'
 
 require 'carray/math'
 require 'carray/iterator'
@@ -46,6 +47,7 @@ require 'carray/obsolete'
 # autoload
 
 unless $CARRAY_NO_AUTOLOAD 
+  
   require 'carray/autoload'
   require 'carray/autoload/autoload_base'
   require 'carray/autoload/autoload_io_imagemagick'

data/lib/carray/autoload/autoload_gem_numo_narray.rb

@@ -1,15 +1,15 @@
 class CArray
-  autoload_method :to_numo, "carray-numo-narray"
-  autoload_method :numo, "carray-numo-narray"
-  autoload_method "self.as_numo", "carray-numo-narray"
+  autoload_method :to_numo,        "carray-numo-narray"
+  autoload_method :numo,           "carray-numo-narray"
+  autoload_method "self.as_numo",  "carray-numo-narray"
   autoload_method "self.as_numo!", "carray-numo-narray"
-  autoload_method :as_numo, "carray-numo-narray"
-  autoload_method :as_numo!, "carray-numo-narray"
+  autoload_method :as_numo,        "carray-numo-narray"
+  autoload_method :as_numo!,       "carray-numo-narray"
 end
 
 module Numo
   class NArray
     autoload_method :to_ca, "carray-numo-narray"
-    autoload_method :ca, "carray-numo-narray"
+    autoload_method :ca,    "carray-numo-narray"
   end
 end

data/lib/carray/broadcast.rb

@@ -0,0 +1,45 @@
+
+class CArray
+  def broadcast_to (*new_dim)
+    if new_dim.size < ndim
+      raise "can't broadcast to #{new_dim.inspect} because of mismatch in rank"
+    end
+    flag_unbound_repeat = false
+    sdim = []
+    ([1]*(new_dim.size-ndim) + dim).each_with_index do |d, k|
+      if new_dim[k] == 1
+        sdim << 1
+      elsif d == 1
+        flag_unbound_repeat = true
+        sdim << :*
+      elsif d != new_dim[k]
+        raise "can't broadcast to #{new_dim.inspect} because of mismatch in #{d} for #{new_dim[k]} in #{k}th dim"
+      else
+        sdim << nil
+      end
+    end
+    return self[*sdim].bind(*new_dim) if flag_unbound_repeat
+    return self
+  end
+end
+
+class CScalar
+  def broadcast_to (*new_dim)
+    return self
+  end
+end
+
+class CAUnboundRepeat
+  alias broadcast_to bind
+end
+
+def CArray.broadcast (*argv)
+  sel = argv.select {|arg| arg.is_a?(CArray) }
+  return argv if sel.empty?
+  dim = []
+  ndim = sel.map(&:ndim).max
+  ndim.times do |k|
+    dim[k] = sel.map{|arg| arg.dim[k] || 1 }.max
+  end
+  return argv.map{|arg| arg.is_a?(CArray) ? arg.broadcast_to(*dim) : arg }
+end