carray 2.0.0 → 3.0.0

data/misc/Methods.ja.md

@@ -1,182 +0,0 @@
-メソッドドキュメント
-===================
-
-多次元配列クラスの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,_,_]
-
-

data/misc/NOTE

@@ -1,51 +0,0 @@
-Note for developper
-===================
-
-Utility scripts
----------------
-
-### check version.h
-
-    ruby version.rb
-
-### check installed ruby-carray environment
-
-    ruby -v -e "require 'carray/info'"
-    
-Check Points for Debug 
-----------------------
-
-  * 'elements' should be checked with double float number
-
-  * One of the following methods should be called before ca->mask refered
-    + ca_attach
-    + ca_has_mask 
-    + ca_update_mask
-    + ca_create_mask
-
-  * Avoid the exposition of raw VALUE data in object array
-
-    + CArray#refer, CArray#member, CArray#bitarray, CArray#bitfield
-    + CArray#transform, CArray#load, CArray#dump
-    + CArray#swap_bytes!, CArray#swap_bytes
-
-  * inherit data_class when copy
-
-    + rb_ca_copy, rb_ca_template
-    + rb_ca_unmask_copy
-
-OpenMP
-------
-
-  * '--with-cc="gcc -fopenmp"' ... and so on.
-
-Range
------
-
- int rb_arithmetic_sequence_extract(VALUE, VALUE *, VALUE *, VALUE *, int *);
-
- /* range.c */
- #define RANGE_BEG(r) (RSTRUCT(r)->as.ary[0])
- #define RANGE_END(r) (RSTRUCT(r)->as.ary[1])
- #define RANGE_EXCL(r) (RSTRUCT(r)->as.ary[2])
- 

data/spec/Classes/CABitfield_spec.rb

@@ -1,58 +0,0 @@
-
-require 'carray'
-require "rspec-power_assert"
-
-describe "TestCArrayCABitfield " do
-
-  example "virtual_array" do
-    a = CArray.int(3,3) { 1 }
-    b = a.bitfield(0)
-    r = b.parent
-    is_asserted_by { b.class == CABitfield }
-    is_asserted_by { true == b.virtual? }
-    is_asserted_by { a == r }
-  end
-
-  example "basic_features" do
-    # ---
-    a = CArray.int(3,3)
-    b = a.bitfield(0)
-    b[] = 1
-    is_asserted_by { a.template { 1 } == a }
-    is_asserted_by { b.template { 1 } == b }
-    b[] = 0
-    is_asserted_by { a.template { 0 } == a }
-    is_asserted_by { b.template { 0 } == b }
-    # ---
-    a = CArray.int(3,3)
-    b = a.bitfield(0..1)
-    b[] = 3
-    is_asserted_by { a.template { 3 } == a }
-    is_asserted_by { b.template { 3 } == b }
-    
-    # ---
-    a = CArray.int(3,3)
-    b = a.bitfield(5..6)
-    b[] = 3
-    is_asserted_by { a.template { 3 << 5 } == a }
-    is_asserted_by { b.template { 3 } == b }
-    
-    # ---
-    a = CArray.int(3,3)
-    b = a.bitfield(27..28)
-    b[] = 3
-    is_asserted_by { a.template { 3 << 27 } == a }
-    is_asserted_by { b.template { 3 } == b }
-  end
-  
-  example "out_of_index" do
-    # ---
-    a = CArray.int8(3)
-    expect { a.bitfield(-1..0) }.to raise_error(IndexError)
-    expect { a.bitfield(0..16) }.to raise_error(IndexError)
-    expect { a.bitfield([nil,2]) }.to raise_error(IndexError)
-    expect { a.bitfield([nil,1]) }.not_to raise_error()
-  end
-
-  
-end

data/spec/Classes/CABlockIterator_spec.rb

@@ -1,114 +0,0 @@
-require "carray"
-require "rspec-power_assert"
-
-describe CABlockIterator do
-
-  describe "each method" do
-
-    before do
-      @original = CArray.object(4,4).seq!
-      @it = @original.blocks(0..1, 0..1)
-    end
-
-    example "should call 4-times its block" do
-      count = 0
-      @it.each do |blk|
-        count += 1
-      end
-      is_asserted_by { count == 4 }
-    end
-
-    example "should have the block parameter of 2x2 CABlock object" do
-      @it.each do |blk|
-        is_asserted_by { blk.class == CABlock }
-        is_asserted_by { blk.data_type == CA_OBJECT }
-        is_asserted_by { blk.dim == [2,2] }
-      end
-    end
-
-  end
-
-  describe "reference method []" do
-
-    before do
-      @original = CArray.object(4,4).seq!
-      @it = @original.blocks(0..1, 0..1)
-    end
-
-    example "should return a 2x2 CABlock object" do
-      blk = @it[0]
-      is_asserted_by { blk.class == CABlock }
-      is_asserted_by { blk.data_type == CA_OBJECT }
-      is_asserted_by { blk == CA_OBJECT([[0,1],[4,5]]) }
-      blk = @it[1,0]
-      is_asserted_by { blk.class == CABlock }
-      is_asserted_by { blk.data_type == CA_OBJECT }
-      is_asserted_by { blk == CA_OBJECT([[8,9],[12,13]]) }
-    end
-
-    example "should return a 2x2 CABlock object" do
-      is_asserted_by { @it[0] == @it.kernel_at_addr(0, @it.reference) }
-      is_asserted_by { @it[1,0] == @it.kernel_at_index([1,0], @it.reference) }
-    end
-
-  end
-
-  describe "store method []=" do
-
-    before do
-      @original = CArray.object(4,4).seq!
-      @it = @original.blocks(0..1, 0..1)
-    end
-
-    example "should return a 2x2 CABlock object" do
-      @it[0] = 1
-      @it[1,0] = 2
-      is_asserted_by { @it.reference == CA_OBJECT( [ [ 1, 1, 2, 3 ],
-                                               [ 1, 1, 6, 7 ],
-                                               [ 2, 2, 10, 11 ],
-                                               [ 2, 2, 14, 15 ] ] ) }
-    end
-
-  end
-
-  describe "pick method" do
-
-    before do
-      @original = CArray.object(4,4).seq!
-      @it = @original.blocks(0..1, 0..1)
-    end
-
-    example "should return a 2x2 CABlock object" do
-      blk = @it.pick(0)
-      is_asserted_by { blk.class == CArray }
-      is_asserted_by { blk.data_type == CA_OBJECT }
-      is_asserted_by { blk == CA_OBJECT([[0,2],[8,10]]) }
-      blk = @it.pick(1,0)
-      is_asserted_by { blk.class == CArray }
-      is_asserted_by { blk.data_type == CA_OBJECT }
-      is_asserted_by { blk == CA_OBJECT([[4,6],[12,14]]) }
-    end
-
-  end
-
-  describe "put method" do
-
-    before do
-      @original = CArray.object(4,4).seq!
-      @it = @original.blocks(0..1, 0..1)
-    end
-
-    example "should store value via 2x2 CBlock object" do
-      @it.put(0,1)
-      @it.put(0,1,2)
-      is_asserted_by { @it.pick(0) == CA_OBJECT([[1,1],[1,1]]) }
-      is_asserted_by { @it.pick(0,1) == CA_OBJECT([[2,2],[2,2]]) }
-      is_asserted_by { @it.reference == CA_OBJECT([[ 1, 2, 1, 2 ],
-                                             [ 4, 5, 6, 7 ],
-                                             [ 1, 2, 1, 2 ],
-                                             [ 12, 13, 14, 15 ]]) }
-    end
-
-  end
-
-end

data/spec/Classes/CABlock_spec.rb

@@ -1,205 +0,0 @@
-
-require 'carray'
-require "rspec-power_assert"
-
-describe "TestCABlock " do
-
-  example "virtual_array" do
-    a = CArray.int(3,3)
-    b = a[0..1,0..1]
-    r = b.parent
-    t = b.root_array
-    is_asserted_by { b.class == CABlock }
-    is_asserted_by { r.class == CArray }
-    is_asserted_by { a == r }
-    is_asserted_by { a == t }
-  end
-
-  example "block" do
-    a = CArray.int32(3, 3) { 1 }
-    b = CArray.int32(3) { 1 }
-
-    is_asserted_by { a[nil, 1] == b }
-    is_asserted_by { a[1, nil] == b }
-
-    a[nil, 1].seq!
-    b.seq!
-    is_asserted_by { a[nil, 1] == b }
-
-    a[1, nil].seq!
-    b.seq!
-    is_asserted_by { a[1, nil] == b }
-  end
-
-  example "CABlock" do
-    a = CArray.int32(4, 4)
-
-    a.seq!
-    b = a[1..2, 1..2]
-
-    is_asserted_by { b.class == CABlock }
-    is_asserted_by { b.rank == a.rank }
-    is_asserted_by { b.dim == [2, 2] }
-    is_asserted_by { b.elements == 4 }
-
-    c = CArray.int32(2, 2){ [[5,6],[9,10]] }
-    is_asserted_by { b == c }
-
-    d = a.clone
-    d[1..2, 1..2] = 1
-    b[] = 1
-    is_asserted_by { a == d }
-
-    a.seq!
-    is_asserted_by { b == c }
-  end
-
-
-  example "s_new" do
-    a = CArray.int32(4, 4) { 1 }
-    b = a[0..2, 0..2]
-    is_asserted_by { b.data_type == CA_INT32 }
-    is_asserted_by { b.rank == 2 }
-    is_asserted_by { b.bytes == CArray.sizeof(CA_INT32) }
-    is_asserted_by { b.size0 == [4, 4] }
-    is_asserted_by { b.dim == [3, 3] }
-    is_asserted_by { b.start == [0, 0] }
-    is_asserted_by { b.step == [1, 1] }
-    is_asserted_by { b.count == [3, 3] }
-    is_asserted_by { b.elements == 9 }
-    is_asserted_by { b == CArray.int32(3, 3) { 1 } }
-  end
-
-  example "block_of_block" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[0..2, 0..2]
-    c = b[0..1, 0..1]
-
-    is_asserted_by { b == CArray.int32(3, 3) {
-       [
-         [0, 1, 2],
-         [4, 5, 6],
-         [8, 9, 10],
-       ]
-       } }
-
-    is_asserted_by { c == CArray.int32(2, 2) {
-       [
-         [0, 1],
-         [4, 5],
-       ]
-       } }
-  end
-
-  example "block_of_block_set_value" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[0..2, 0..2]
-    c = b[0..1, 0..1]
-
-    a[0..1, 0..1] = 1
-
-    is_asserted_by { b == CArray.int32(3, 3) {
-       [
-         [1, 1, 2],
-         [1, 1, 6],
-         [8, 9, 10],
-       ]
-       } }
-
-    is_asserted_by { c == CArray.int32(2, 2) {
-       [
-         [1, 1],
-         [1, 1],
-       ]
-       } }
-
-    c[] = 2
-
-    is_asserted_by { b == CArray.int32(3, 3) {
-       [
-         [2, 2, 2],
-         [2, 2, 6],
-         [8, 9, 10],
-       ]
-       } }
-
-    is_asserted_by { a[0..1, 0..1] == CArray.int32(2, 2) {
-       [
-         [2, 2],
-         [2, 2],
-       ]
-       } }
-  end
-
-  example "block_of_block_downrank" do
-    a = CArray.new(CA_INT32, [4, 4, 4]) { 0 }
-    b = a[0..2, 0..2, 1]
-    c = b[0..1, 1]
-
-    b.seq!
-
-    is_asserted_by { b == a[0..2, 0..2, 1] }
-    is_asserted_by { c == CArray.int32(2) { [1, 4] } }
-
-    c[] = 1
-
-    is_asserted_by { a[0..1, 1, 1] == CArray.int(2) { 1 } }
-  end
-
-  example "block_of_block_ref_address" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[0..2, 0..2]
-    c = b[1..0, 0..1]
-
-    is_asserted_by { c[2] == 0 }
-    is_asserted_by { c[[2]] == CArray.int32(1) { [0] } }
-    is_asserted_by { c[nil] == CArray.int32(4) { [4, 5, 0, 1] } }
-    is_asserted_by { c[1..2] == CArray.int32(2) { [5, 0] } }
-    is_asserted_by { c[[nil, 2]] == CArray.int32(2) { [4, 0] } }
-    is_asserted_by { c[[(1..-1), 2]] == CArray.int32(2) { [5, 1] } }
-
-    c[nil] = 1
-    is_asserted_by { a[0..1, 0..1] == CArray.int32(2, 2) { 1 } }
-  end
-
-  example "refer_of_block" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[nil, 0..2]
-    c = b.reshape(2, 6)
-#    is_asserted_by { b.to_a.flatten, c.to_a.flatten)
-
-    c[0, 0] = 3
-    is_asserted_by { b[0, 0] == 3 }
-    is_asserted_by { a[0, 0] == 3 }
-  end
-
-  example "refer_of_block_cast" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[nil, 0..2]
-    c = b.reshape(2, 6)
-    is_asserted_by { c.float32[0, 1] == 1.0 }
-    is_asserted_by { c.float64[0, 1] == 1.0 }
-  end
-
-  example "block_of_block_self_asign" do
-    a = CArray.new(CA_INT32, [4, 4]).seq!
-    b = a[0..2, 0..2]
-    b[0..1, 0..1] = a[0..1, 0..1]
-  end
-
-  example "block_move" do
-    a = CArray.int(10, 10).seq!
-    b = a[0..2, 0..2]
-
-    is_asserted_by { b == CArray.int(3, 3) { [[0, 1, 2], [10, 11, 12], [20, 21, 22]] } }
-
-    b.move(1,1)
-    is_asserted_by { b == CArray.int(3, 3) { [[11, 12, 13], [21, 22, 23], [31, 32, 33]] } }
-
-    b.move(7,7)
-    is_asserted_by { b == CArray.int(3, 3) { [[77, 78, 79], [87, 88, 89], [97, 98, 99]] } }
-
-    expect { b.move(8,8) }.to raise_error(ArgumentError) 
-  end
-  
-end

data/spec/Classes/CAField_spec.rb

@@ -1,39 +0,0 @@
-
-require 'carray'
-require "rspec-power_assert"
-
-describe "TestCArrayCAField " do
-
-  example "virtual_array" do
-    a = CArray.int(3,3)
-    b = a.field(0,CA_INT8)
-    r = b.parent
-    is_asserted_by { b.class == CAField }
-    is_asserted_by { true == b.virtual? }
-    is_asserted_by { a == r }
-  end
-
-  example "attributes" do
-    #
-    a = CArray.int16(3,3) { 0x1122 }
-    b = a.field(0, CA_INT8)
-    is_asserted_by { CA_INT8 == b.data_type }
-    is_asserted_by { [3, 3] == b.dim }
-  end
-
-  example "endian" do
-    #
-    a = CArray.int16(3,3) { 0x1122 }
-    b = CArray.int8(3,3) { 0x11 }
-    c = CArray.int8(3,3) { 0x22 }
-    if CArray.big_endian?
-      is_asserted_by { b == a.field(0, CA_INT8) }
-      is_asserted_by { c == a.field(1, CA_INT8) }
-    else
-      is_asserted_by { b == a.field(1, CA_INT8) }
-      is_asserted_by { c == a.field(0, CA_INT8) }
-    end
-  end
-
-
-end