carray 1.3.6 → 1.5.3

data/lib/carray/{base/struct.rb → struct.rb}

@@ -1,28 +1,26 @@
 # ----------------------------------------------------------------------------
 #
-#  carray/base/struct.rb
+#  carray/struct.rb
 #
 #  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
 #
 # ----------------------------------------------------------------------------
 #
 # The data class for fixed length carray are required to satisfy only
-# four conditions.
+# five conditions.
 #
 #   * constant data_class::DATA_SIZE    -> integer
-#   * constant data_class::MEMBERS      -> array of string
 #   * constant data_class::MEMBER_TABLE -> hash
+#   * constant data_class::MEMBERS      -> array (MEMBER_TABLE.keys as usual)
 #   * method   data_class.decode(data)  -> new data_class object
 #   * method   data_class#encode()      -> string 
 #
 # The implementation of other properties (cf. initialization, instance,
 # methods ...) are left free.
 #
-# CA::Struct and CA::Union are examples of such data class.
+# CAStruct and CAUnion are examples of such data class.
 #
 # option = {
 #   :pack => 1,   # nil for alignment, int for pack(n)
@@ -90,7 +88,7 @@ class CArray
 
 end
 
-class CA::Struct
+class CAStruct
 
   include Enumerable
 
@@ -264,7 +262,7 @@ class CA::Struct
 
 end
 
-class CA::Union < CA::Struct
+class CAUnion < CAStruct
   class << self
     def inspect
       return name.nil? ? "AnonUnion" : name
@@ -275,11 +273,11 @@ end
 module CA
 
   def self.struct (opt={}, &block)
-    return Struct::Builder.new(:struct, opt).define(&block)
+    return CAStruct::Builder.new(:struct, opt).define(&block)
   end
 
   def self.union (opt={}, &block)
-    return Struct::Builder.new(:union, opt).define(&block)
+    return CAStruct::Builder.new(:union, opt).define(&block)
   end
 
 end
@@ -290,7 +288,7 @@ end
 #
 # ---------------------------------------------------------------------
 
-class CA::Struct::Builder  # :nodoc:
+class CAStruct::Builder  # :nodoc:
 
   class Member # :nodoc:
 
@@ -358,9 +356,9 @@ class CA::Struct::Builder  # :nodoc:
     # ---
     case @type
     when :struct
-      klass = Class.new(CA::Struct)
+      klass = Class.new(CAStruct)
     when :union
-      klass = Class.new(CA::Union)
+      klass = Class.new(CAUnion)
     end
     # ---
     if @align.nil?
@@ -477,7 +475,7 @@ class CA::Struct::Builder  # :nodoc:
     if block
       opt = {:pack => @align}.update(opt)
       st = self.class.new(:struct, opt).define(&block)
-    elsif opt[:type] and opt[:type] <= CA::Struct
+    elsif opt[:type] and opt[:type] <= CAStruct
       st = opt[:type]
     else
       raise "type is not given for struct member of struct"
@@ -494,7 +492,7 @@ class CA::Struct::Builder  # :nodoc:
     if block
       opt = {:pack => @align}.update(opt)
       st = self.class.new(:union, opt).define(&block)
-    elsif opt[:type] and opt[:type] <= CA::Struct
+    elsif opt[:type] and opt[:type] <= CAStruct
       st = opt[:type]
     else
       raise "type is not given for union member of struct"
@@ -556,14 +554,14 @@ end
 
 
 
-class CA::Struct
+class CAStruct
 
   def self.spec
     output = ""
     table  = self::MEMBER_TABLE
     stlist = []
     if self.name.nil?
-      if self <= CA::Union
+      if self <= CAUnion
         prefix = "union"
       else
         prefix = "struct"
@@ -573,7 +571,7 @@ class CA::Struct
     else
       output << sprintf("%s = ", self.name)
     end
-    if self < CA::Union
+    if self < CAUnion
       output << sprintf("CA.union(:size=>%i) {\n", self::DATA_SIZE)
     else
       output << sprintf("CA.struct(:size=>%i) {\n", self::DATA_SIZE)
@@ -582,10 +580,10 @@ class CA::Struct
       offset, type, option = *table[member]
       case type
       when Class
-        if type < CA::Struct
+        if type < CAStruct
           stlist << type
           if type.name.nil?
-            if type <= CA::Union
+            if type <= CAUnion
               prefix = "union"
             else
               prefix = "struct"

data/lib/carray/{io/table.rb → table.rb}

@@ -1,5 +1,5 @@
 
-module CA
+class CArray
   
   module TableMethods
 
@@ -67,11 +67,3 @@ module CA
   
 end
 
-class CArray
-  
-  def extend_as_table (column_names)
-    self.extend CA::TableMethods
-    self.column_names = column_names
-  end
-    
-end

data/lib/carray/testing.rb

@@ -0,0 +1,51 @@
+# ----------------------------------------------------------------------------
+#
+#  carray/test.rb
+#
+#  This file is part of Ruby/CArray extension library.
+#
+#  Copyright (C) 2005-2020 Hiroki Motoyoshi
+#
+# ----------------------------------------------------------------------------
+
+class CArray
+
+  def test (&block)
+    return convert(:boolean) {|v| yield(v) ? true : false }
+  end
+
+  def contains (*list)
+    result = self.false()
+    list.each do |item|
+      result = result | self.eq(item)
+    end
+    return result 
+  end
+
+  def between (a, b)
+    return (self >= a) & (self <= b)
+  end
+
+  def where_range
+    w = where
+    x = (w - w.shifted(1){-2}).sub!(1).where
+    y = (w - w.shifted(-1){-2}).add!(1).where
+    list = []
+    x.each_addr do |i|
+      list.push(w[x[i]]..w[y[i]])
+    end
+    return list
+  end
+  
+  # Returns the array eliminated all the duplicated elements.
+  def uniq
+    ary = flatten.to_a.uniq
+    if has_mask?
+      ary.delete(UNDEF)
+    end
+    out = CArray.new(data_type, [ary.length], :bytes=>bytes) { ary }
+    out.data_class = data_class if has_data_class?
+    return out
+  end
+
+end

data/lib/carray/time.rb

@@ -0,0 +1,76 @@
+# ----------------------------------------------------------------------------
+#
+#  carray/time.rb
+#
+#  This file is part of Ruby/CArray extension library.
+#
+#  Copyright (C) 2005-2020 Hiroki Motoyoshi
+#
+# ----------------------------------------------------------------------------
+
+require "date"
+
+class CArray
+    
+  def str_to_datetime (template = nil)
+    if template
+      return convert() {|v| DateTime.strptime(v, template) }
+    else
+      return convert() {|v| DateTime.parse(v) }
+    end
+  end
+
+  def str_to_time (template = nil)
+    if template
+      return str_strptime(template)
+    else
+      return convert() {|v| Time.parse(v) }
+    end
+  end
+
+  def time_format (template = nil)
+    if template
+      return str_strftime(template)
+    else
+      return convert(&:to_s)
+    end    
+  end
+
+  def time_year
+    return convert(:int, &:year)
+  end
+
+  def time_month
+    return convert(:int, &:month)
+  end
+
+  def time_day
+    return convert(:int, &:day)
+  end
+
+  def time_hour 
+    return convert(:int, &:hour)
+  end
+
+  def time_minute
+    return convert(:int, &:minute)
+  end
+
+  def time_second
+    return convert(:double) {|d| d.second + d.second_fraction }
+  end
+
+  def time_jd
+    return convert(:int, &:jd)
+  end
+
+  def time_ajd
+    return convert(:double, &:ajd)
+  end
+
+  def time_is_leap
+    return test(&:leap?)
+  end
+
+end
+

data/lib/carray/transform.rb

@@ -0,0 +1,98 @@
+# ----------------------------------------------------------------------------
+#
+#  carray/composition.rb
+#
+#  This file is part of Ruby/CArray extension library.
+#
+#  Copyright (C) 2005-2020 Hiroki Motoyoshi
+#
+# ----------------------------------------------------------------------------
+
+class CArray
+  
+  # reshape
+
+  def reshape (*newdim)
+    ifalse = nil
+    i = 0
+    0.upto(newdim.size-1) do |i|
+      if newdim[i].nil?
+        newdim[i] = dim[i]
+      elsif newdim[i] == false 
+        ifalse = i
+        break
+      end
+    end
+    k = 0
+    (newdim.size-1).downto(i+1) do |j|
+      if newdim[j].nil?
+        newdim[j] = dim[ndim-1-k]
+      end
+      k += 1
+    end
+    if ifalse
+      newdim[ifalse] = 
+          elements/newdim.select{|x| x!=false}.inject(1){|s,x| s*x}
+    end
+    return refer(data_type, newdim, :bytes=>bytes)
+  end
+
+  # flatten
+
+  def flattened
+    return reshape(elements)
+  end
+
+  def flatten
+    return reshape(elements).to_ca
+  end
+
+  def transpose! (*argv)
+    self[] = self.transposed(*argv)
+    return self
+  end
+
+  def transpose (*argv)
+    return self.transposed(*argv).to_ca
+  end
+
+  # Reutrns the reference which ndim is reduced 
+  # by eliminating the dimensions which size == 1 
+  def compacted
+    if ndim == 1
+      return self[]
+    else
+      newdim = dim.reject{|x| x == 1 }
+      return ( ndim != newdim.size ) ? reshape(*newdim) : self[]
+    end
+  end
+
+  # Returns the array which ndim is reduced 
+  # by eliminating the dimensions which size == 1 
+  def compact
+    if ndim == 1
+      return self.to_ca
+    else
+      newdim = dim.reject{|x| x == 1 }
+      return ( ndim != newdim.size ) ? reshape(*newdim).to_ca : self.to_ca
+    end
+  end
+
+  # Returns (1,n) array from 1-dimensional array 
+  def to_row 
+    if ndim != 1
+      raise "ndim should be 1"
+    end
+    return self[1,:%]
+  end
+  
+  # Returns (n,1) array from 1-dimensional array 
+  def to_column
+    if ndim != 1
+      raise "ndim should be 1"
+    end
+    return self[:%,1]
+  end
+
+  
+end

data/misc/Methods.ja.md

@@ -0,0 +1,182 @@
+メソッドドキュメント
+===================
+
+多次元配列クラスのRuby用ライブラリ
+
+特徴
+---
+
+* 一様なデータを格納するための多次元配列
+* データ要素への多様なアクセス方法
+* 欠測値を扱うための要素別のマスク
+* 要素毎の演算や数学関数
+* 要素に対する統計関数
+* 真の参照配列
+* ユーザー定義配列
+* 他オブジェクトとのメモリ共有（Experimental）
+
+マスクに関するメソッド
+-------------------
+
+* 一度生成されたマスク配列を取り除く方法は提供されていない。
+
+== メソッド
+
+=== --- CArray#has_mask?
+マスク配列が付加されている場合にtrueを返す。
+全要素がマスクされていなくても、マスク配列が付加されていればtrueを返す。
+
+    a = CA_INT(0..2);
+    a.has_mask?
+    a[1] = UNDEF;
+    a.has_mask?
+
+=== --- CArray#any_masked?
+マスクされた要素が１つ以上ある場合にtrueを返す。
+どの要素もマスクされていない場合やマスク配列自体を持っていない場合にfalseを返す。
+
+    a = CA_INT(0..2);
+    a.mask = 0;
+    a.any_masked?
+    a[1] = UNDEF;
+    a.any_masked?
+    a.unmask;
+    a.any_masked?
+
+=== --- CArray#value
+データ配列を参照する配列を返す。
+マスクされているいないに関わらず、要素の値を参照したり、
+値を変更することができる。
+この配列（もしくはこの配列を参照する配列）に対し、
+マスクを付加しようとすると例外が発生する。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a
+    a.value
+
+=== --- CArray#mask
+マスク配列を参照するboolean型配列を返す。
+この配列を変更すると、元の配列のマスク状態を変更することができる。
+この配列（もしくはこの配列を参照する配列）に対し、
+マスクを付加しようとすると例外が発生する。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a.mask
+    a
+    a.mask[] ^= 1;
+    a
+
+=== --- CArray#mask=(new_mask)
+new_maskをマスク配列に代入する。
+new_maskは、<TBD>でなければならない。
+配列がマスク配列を持っていない場合は、代入前にマスク配列が生成される。
+
+    a = CA_INT(0..2);
+    a.mask
+    a.mask = 0;
+    a.mask
+    a.mask = [0,1,0];
+    a.mask
+    a.mask ^= 1;
+    a.mask
+
+=== --- CArray#is_masked
+マスク状態を表すboolean型配列を返す。
+この配列はマスクされた要素が1で、マスクされていない要素が0となる。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a.is_masked
+
+=== --- CArray#is_not_masked
+マスク状態を表すboolean型配列を返す。
+この配列はマスクされた要素が0で、マスクされていない要素が1となる。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a.is_not_masked
+
+=== --- CArray#count_masked (*axis)
+マスクされた要素の数を返す。
+axisで与えられた次元で集計し、残りの次元の配列を返す。
+axisが与えられない場合は、整数を返す。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a.count_masked
+
+=== --- CArray#count_not_masked
+マスクされていない要素の数を返す。
+axisで与えられた次元で集計し、残りの次元の配列を返す。
+axisが与えられない場合は、整数を返す。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a.count_not_masked
+
+=== --- CArray#unmask([fill_value])
+すべての要素のマスクを解除する。
+fill_valueが与えられている場合は、マスクされた要素をすべてfill_valueで置き換える。
+このメソッドでは、マスク配列自体を取り除かれることはない。
+
+    a = CA_INT(0..2);
+    # example for fill_value not to be given
+    a[1] = UNDEF;
+    a
+    a.unmask();
+    a
+  
+    # example for fill_value to be given
+    b = CA_INT(0..2);
+    b[1] = UNDEF;
+    b.unmask(-9999);
+    b
+
+=== --- CArray#unmask_copy([fill_value])
+すべての要素のマスクが解除された複製を返す。
+fill_valueが与えられている場合は、マスクされた要素をすべてfill_valueで置き換える。
+返り値の配列はマスク配列を持たない状態で生成される。
+
+    a = CA_INT(0..2);
+    a[1] = UNDEF;
+    a
+
+    b = a.unmask_copy(-9999)
+    b.has_mask?
+
+=== --- CArray#inherit_mask(a1, a2, ...)
+オブジェクトと引数で与えられた配列の集合で(self,a1,a2,...)でマスク状態の論理和をとり、
+新しいマスク状態として置き換える。
+
+    a = CA_INT(0..2);
+    b = CA_INT(0..2);
+    c = CA_INT(0..2);
+    a[0] = UNDEF;
+    b[1] = UNDEF;
+    c[2] = UNDEF;
+    a                 ### => [_,1,2]
+    b                 ### => [0,_,2]
+    c                 ### => [0,1,_]
+    a.inherit_mask(b,c);
+    a                 ### => [_,_,_]
+
+=== --- CArray#inherit_mask_replace(a1, a2, ...)
+引数で与えられた配列 a1、a2、… のマスク状態の論理和をとり、
+新しいマスク状態として設定する。
+オブジェクト自身のマスク値は上記の論理和に含まれない点に注意する。
+
+    a = CA_INT(0..2);
+    b = CA_INT(0..2);
+    c = CA_INT(0..2);
+    a[0] = UNDEF;
+    b[1] = UNDEF;
+    c[2] = UNDEF;
+    a                 ### => [_,1,2]
+    b                 ### => [0,_,2]
+    c                 ### => [0,1,_]
+    a.inherit_mask_replace(b,c);
+    a                 ### => [0,_,_]
+
+