carray 1.3.6 → 1.3.7

data/rdoc_ext.rb

@@ -1,1115 +0,0 @@
-
-class CArray
-end
-class CScalar
-end
-module CA
-end
-  class CABitField < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def bitfield (range, type)
-    end
-  end
-
-  class CAShift < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def shifted
-    end
-  end
-
-     class CArray::DataTypeError # :nodoc:
-     end
-
-    class CArray
-      VERSION = nil         # :nodoc:
-      VERSION_CODE = nil    # :nodoc:
-      VERSION_MAJOR = nil   # :nodoc:
-      VERSION_MINOR = nil   # :nodoc:
-      VERSION_TEENY = nil   # :nodoc:
-      VERSION_DATE = nil    # :nodoc:
-    end
-
-  class CAIterator
-    def rank
-    end
-  end
-
-  class CAIterator
-    def dim
-    end
-  end
-
-  class CAIterator
-    def elements
-    end
-  end
-
-  class CAIterator
-    def reference
-    end
-  end
-
-  class CAIterator
-    def kernel_at_addr
-    end
-  end
-
-  class CAIterator
-    def kernel_at_index
-    end
-  end
-
-  class CAIterator
-    def kernel_move_to_addr
-    end
-  end
-
-  class CAIterator
-    def kernel_move_to_index
-    end
-  end
-
-  class CAIterator
-    def prepare_output
-    end
-  end
-
-  class CAIterator
-    def calculate
-    end
-  end
-
-  class CAIterator
-    def filter
-    end
-  end
-
-  class CAIterator
-    def evaluate
-    end
-  end
-
-  class CArray
-    def fill
-    end
-    def fill_copy
-    end
-  end
-
-  def CArray.guess_array_shape (arg)
-  end
-
-  class CArray
-    def [] (*spec)
-    end
-  end
-
-  class CArray
-    def []= (*spec)
-    end
-  end
-
-  def CArray.scan_index(dim, idx)
-  end
-
-  class CArray
-    def normalize_index (idx)
-    end
-  end
-
-  class CArray
-    # converts addr to index
-    def addr2index (addr)
-    end
-  end
-
-  class CArray
-    def index2addr (*index)
-    end
-  end
-
-  class CAGrid < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def grid
-    end
-  end
-
-  class CASelect < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    # call-seq:
-    #     ca.boolean
-    #     ca.int8     
-    #     ca.uint8    
-    #     ca.int16    
-    #     ca.uint16   
-    #     ca.int32    
-    #     ca.uint32   
-    #     ca.int64    
-    #     ca.uint64   
-    #     ca.float32  
-    #     ca.float64  
-    #     ca.float128 
-    #     ca.cmplx64  
-    #     ca.cmplx128 
-    #     ca.cmplx256 
-    #     ca.object   
-    #     ca.fixlen
-    #     ca.byte
-    #     ca.short
-    #     ca.int
-    #     ca.float
-    #     ca.double
-    #     ca.complex
-    #     ca.dcomplex
-    #
-    # Convert to given data_type with copying values
-    def to_type
-    end
-  end
-
-  class CArray
-    # call-seq:
-    #     ca.as_int8     
-    #     ca.as_uint8    
-    #     ca.as_int16    
-    #     ca.as_uint16   
-    #     ca.as_int32    
-    #     ca.as_uint32   
-    #     ca.as_int64    
-    #     ca.as_uint64   
-    #     ca.as_float32  
-    #     ca.as_float64  
-    #     ca.as_float128 
-    #     ca.as_cmplx64  
-    #     ca.as_cmplx128 
-    #     ca.as_cmplx256 
-    #     ca.as_object   
-    #     ca.as_byte
-    #     ca.as_short
-    #     ca.as_int
-    #     ca.as_float
-    #     ca.as_double
-    #     ca.as_complex
-    #     ca.as_dcomplex
-    #
-    # Fakes data_type
-    def as_type
-    end
-  end
-
-  def CArray.wrap_writable
-  end
-
-  def CArray.wrap_readonly
-  end
-
-  class CABlock < CAVirtual # :nodoc:
-  end
-
-  class CABlock
-    def size0
-    end
-    def start
-    end
-    def step 
-    end
-    def count
-    end
-    def offset
-    end
-  end
-
-  class CABlock
-    def idx2addr0 (idx)
-    end
-  end
-
-  class CABlock
-    def addr2addr0 (addr)
-    end
-  end
-
-  class CABlock
-    def move (*index)
-    end
-  end
-
-  #  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
-
-  class CArray
-    #
-    def each # :yields: v
-    end
-  end
-
-  class CArray
-    #
-    def each_with_addr # :yields: v, addr
-    end
-  end
-
-  class CArray
-    #
-    def each_addr() # :yields: addr
-    end
-  end
-
-  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
-
-  class CArray
-    #
-    def map! # :yields: v
-    end
-  end
-
-  class CArray
-    # 
-    def each_with_index # :yields: v, idx 
-    end
-  end
-
-  class CArray
-    #
-    def map_with_index! # :yields: v, idx
-    end
-  end
-
-  class CArray
-    #
-    def map_index! # :yields: i0, i1, ...
-    end
-  end
-
-  class CArray
-    #
-    def map_with_addr! # :yields: v, addr
-    end
-  end
-
-  class CArray
-    #
-    def map_addr! # :yields: addr
-    end
-  end
-
-  class CArray
-    # returns the number of elements
-    def elements
-    end
-
-    # alias of `CArray#elements`
-    alias length elements
-
-    # alias of `CArray#elements`
-    alias size elements
-  end
-
-  class CArray
-    # use CArray#shape instead of this method after carray-1.3.0
-    # returns the Array object contains the dimensional shape of array
-    # (e.g. [2,3] for 2D 2x3 array, ...).
-    def dim
-    end
-
-    # returns the Array object contains the dimensional shape of array
-    # (e.g. [2,3] for 2D 2x3 array, ...).
-    def shape
-    end
-
-    # short-hand for dim[0]
-    def dim0
-    end
-    
-    # short-hand for dim[1]
-    def dim1
-    end
-    
-    # short-hand for dim[2]
-    def dim2
-    end
-    
-    # short-hand for dim[3]
-    def dim3
-    end
-  end
-
-   class CArray
-     # returns the string representaion of the data_type (e.g. "int32", "fixlen")
-     def data_type_name
-     end
-   end
-
-   class CArray
-     # returns true if `self` is a CScalar object
-     def scalar?
-     end
-   end
-
-  class CArray
-    # returns true if `self` is an entity array (not a virtual array).
-    def entity?
-    end
-
-    # returns true if `self` is a virtural array (not an entity array).
-    def virtual?
-    end
-  end
-
-  def CArray.guess_type_and_bytes (type, bytes=0)
-  end
-
-  class CAFake < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def fake (data_type, options={:bytes=>0})
-    end
-  end
-
-  class CArray
-  end
-  class CAWrap < CArray   # :nodoc:
-  end
-  class CScalar < CArray
-  end
-  class CAVirtual < CArray # :nodoc:
-  end
-
-  # returns the threshold of incremented memory (MB) used by carray object 
-  # until start GC.
-  def CArray.gc_interval ()
-  end
-  # set the threshold of incremented memory (MB) used by carray object
-  # until start GC.
-  def CArray.gc_interval= (val)
-  end
-  # reset the counter for the GC start when the incremented memory 
-  # get larger than `CArray.gc_interval`.
-  def CArray.reset_gc_interval ()
-  end
-
-  #  call-seq:
-  #     CArray.new(data_type, dim, bytes=0) { ... }
-  #
-  #  Constructs a new CArray object of <i>data_type</i>, which has the
-  #  rank and the dimensions specified by an <code>Array</code> of
-  #  <code>Integer</code> or an argument list of <code>Integer</code>.
-  #  The byte size of each element for the fixed length data type
-  #  (<code>data_type == CA_FIXLEN</code>) is specified optional argument
-  #  <i>bytes</i>. Otherwise, this optional argument has no
-  #  effect. If the block is given, the new CArray
-  #  object will be initialized by the value returned from the block.
-  def CArray.new(data_type, dim, bytes=0)
-  end
-
-   def CArray.wrap (data_type, dim, bytes=0) # { wrapped_object }
-   end
-
-  #  call-seq:
-  #     CScalar.new(data_type, bytes=0) { ... }
-  #
-  #  Constructs a new CScalar object of <i>data_type</i>.
-  #  The byte size of each element for the fixed length data type
-  #  (<code>data_type == CA_FIXLEN</code>) is specified optional argument
-  #  <i>bytes</i>. Otherwise, this optional argument has no
-  #  effect. If the block is given, the new CScalar
-  #  object will be initialized by the value returned from the block.
-  def CScalar.new(data_type,bytes=0)
-  end
-
-  # call-seq:
-  #    CArray.boolean(...) { init_value }
-  #    CArray.int8(...) { init_value }
-  #    CArray.uint8(...) { init_value }
-  #    CArray.int16(...) { init_value }
-  #    CArray.uint16(...) { init_value }
-  #    CArray.int32(...) { init_value }
-  #    CArray.uint32(...) { init_value }
-  #    CArray.int64(...) { init_value }
-  #    CArray.uint64(...) { init_value }
-  #    CArray.float32(...) { init_value }
-  #    CArray.float64(...) { init_value }
-  #    CArray.float128(...) { init_value }
-  #    CArray.cmplx64(...) { init_value }
-  #    CArray.cmplx128(...) { init_value }
-  #    CArray.cmplx256(...) { init_value }
-  #    CArray.fixlen(...) { init_value }
-  #    CArray.object(...) { init_value }
-  #    CArray.byte(...) { init_value }
-  #    CArray.short(...) { init_value }
-  #    CArray.int(...) { init_value }
-  #    CArray.float(...) { init_value }
-  #    CArray.double(...) { init_value }
-  #    CArray.complex(...) { init_value }
-  #    CArray.dcomplex(...) { init_value }
-  #
-  def CArray.type
-  end
-
-  # call-seq:
-  #    CScalar.boolean { init_value }
-  #    CScalar.int8 { init_value }
-  #    CScalar.uint8 { init_value }
-  #    CScalar.int16 { init_value }
-  #    CScalar.uint16 { init_value }
-  #    CScalar.int32 { init_value }
-  #    CScalar.uint32 { init_value }
-  #    CScalar.int64 { init_value }
-  #    CScalar.uint64 { init_value }
-  #    CScalar.float32 { init_value }
-  #    CScalar.float64 { init_value }
-  #    CScalar.float128 { init_value }
-  #    CScalar.cmplx64 { init_value }
-  #    CScalar.cmplx128 { init_value }
-  #    CScalar.cmplx256 { init_value }
-  #    CScalar.fixlen { init_value }
-  #    CScalar.object { init_value }
-  #    CScalar.byte { init_value }
-  #    CScalar.short { init_value }
-  #    CScalar.int { init_value }
-  #    CScalar.float { init_value }
-  #    CScalar.double { init_value }
-  #    CScalar.complex { init_value }
-  #    CScalar.dcomplex { init_value }
-  #
-  def CScalar.type
-  end
-
-  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
-
-  class CArray
-    # Returns the 1d index array for non-zero elements of self
-    def where
-    end
-  end
-
-  class CArray
-    # 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.
-    #
-    def seq (init_val=0, step=1)
-    end
-    # 
-    def seq! (init_val=0, step=1)
-    end
-  end
-
-  class CArray
-    # Swaps the byte order of each element.
-    def swap_bytes
-    end
-    # 
-    def swap_bytes!
-    end
-  end
-
-  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
-
-  # returns index table for index sort
-  #
-  #   idx = CA.sort_addr(a, b, c)  ### priority a > b > c
-  #   a[idx]
-  #   b[idx]
-  #   c[idx]
-
-  def CA.sort_addr (*args)
-  end
-
-  class CArray
-    # returns index table for index sort
-    # This method same as,
-    #
-    #   idx = CA.sort_addr(self, *args) 
-    def sort_addr (*args)
-    end
-  end
-
-  class CAWindowIterator < CAIterator # :nodoc:
-  end
-
-  class CAUnboundRepeat < CArray 
-  end
-
-  class CAUnboundRepeat
-    def bind_with(other)
-    end
-  end
-
-  class CAUnboundRepeat
-    def bind(*index)
-    end
-  end
-
-  class CAObject < CAVirtual # :nodoc:
-  end
-
-  class CAObjectMask < CAVirtual # :nodoc:
-  end
-
-  class CATranspose < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def transposed
-    end
-  end
-
-  class CArray
-    def random! (max=1.0)
-    end
-  end
-
-  class CArray
-    # create CArray object from `self` with same contents includes mask state.
-    def to_ca
-    end
-  end
-
-  class CArray
-    # returns CArray object with same dimension with `self`
-    # The data type of the new carray object can be specified by `data_type`.
-    # For fixlen data type, the option `:bytes` is used to specified the
-    # data length.
-    def template(data_type=self.data_type, options={:bytes=>0})
-    end
-  end
-
-  class CArray
-    # pastes `ary` to `self` at the index `idx`.
-    # `idx` should be Array object with the length same as `self.rank`.
-    # `ary` should have same shape with `self`.
-    def paste (idx, ary)
-    end
-  end
-
-  class CArray
-    # clips the data at `idx` from `self` to `ary`.
-    def clip (idx, ary)
-    end
-  end
-
-  class CABlockIterator < CAIterator # :nodoc: 
-  end
-
-  class CArray
-    # Create block iterator.
-    def blocks (*args)
-    end
-  end
-
-  class CAReduce < CAVirtual # :nodoc:
-  end
-
-  class CAFArray < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    # create the virtual transposed array which dimension order is reversed.
-    def t
-    end
-  end
-
-  class CArray 
-    # Returns true if self has the mask array.
-    def has_mask?() 
-    end 
-  end
-
-  class CArray
-    # Returns true if self has at least one masked element.
-    def any_masked?
-    end
-  end
-
-  class CArray
-    # Returns true if all elements of self are masked.
-    def all_masked?
-    end
-  end
-
-  class CArray
-    private
-    def create_mask
-    end
-  end
-
-  class CArray
-    private
-    def update_mask
-    end
-  end
-
-  class CArray
-    # Returns new array which refers the data of <code>self</code>.
-    # The data of masked elements of <code>self</code> can be accessed
-    # via the returned array. The value array can't be set mask.
-    def value ()
-    end
-  end
-
-  class CArray
-    # Returns new array which refers the mask state of <code>self</code>.
-    # The mask array can't be set mask.
-    def mask ()
-    end
-  end
-
-  class CArray
-    # Asigns <code>new_mask</code> to the mask array of <code>self</code>.
-    # If <code>self</code> doesn't have a mask array, it will be created
-    # before asignment.
-    def mask= (new_mask)
-    end
-  end
-
-  class CArray
-    # Returns new boolean type array of same shape with <code>self</code>.
-    # The returned array has 1 for the masked elements and
-    # 0 for not-masked elements.
-    def is_masked ()
-    end
-  end
-
-  class CArray
-    # Returns new boolean type array of same shape with <code>self</code>.
-    # The returned array has 0 for the masked elements and
-    # 1 for not-masked elements.
-    def is_not_masked ()
-    end
-  end
-
-  class CArray
-    # Returns the number of masked elements.
-    def count_masked ()
-    end
-  end
-
-  class CArray
-    # Returns the number of not-masked elements.
-    def count_not_masked ()
-    end
-  end
-
-  class CArray  
-    # Returns new unmasked array.
-    # If the optional argument <code>fill_value</code> is given,
-    # the masked elements are filled by <code>fill_value</code>.
-    # The returned array doesn't have the mask array.
-    def unmask_copy (fill_value=nil)
-    end
-  end
-
-  class CArray
-    # Sets the mask array of <code>self</code> by the logical sum of
-    # the mask states of <code>self</code> and arrays given in arguments.
-    def inherit_mask (*argv)
-    end
-  end
-
-  class CArray
-    # Sets the mask array of <code>self</code> by the logical sum of
-    # the mask states of arrays given in arguments.
-    def inherit_mask_replace (*argv)
-    end
-  end
-
-  # returns the machine endianness.
-  #     CArray.endian #=> 0 (CA_LITTLE_ENDIAN)
-  #     CArray.endian #=> 1 (CA_BIG_ENDIAN)
-
-  def CArray.endian 
-  end
-
-  # returns true if the byte order of the architecture is
-  # big endian.
-
-  def CArray.big_endian?
-  end
-
-  # returns true if the byte order of the architecture is
-  # little endian.
-
-  def CArray.little_endian?
-  end
-
-  #  Returns the byte length of an element of the given data type.
-  #  Retruns <code>0</code> if data_type is equal to CA_FIXLEN.
-  #     CArray.sizeof(CA_INT32)  #=> 4
-  #     CArray.sizeof(CA_DOUBLE) #=> 8
-  #     CArray.sizeof(CA_FIXLEN)   #=> 0
-
-  def CArray.sizeof (data_type)
-  end
-
-  #  Returns true if the given data_type indicate the valid data_type.
-
-  def CArray.data_type?(data_type)
-  end
-
-  #  Returns string representaion of the data_type specifier.
-
-  def CArray.data_type_name(data_type)
-  end
-
-  class CArray
-    def coerce (other)
-    end
-  end
-
-  def CArray.attach(*argv) # :nodoc:
-    yield
-  end
-
-  def CArray.attach!(*argv) # :nodoc:
-    yield
-  end
-
-  class CArray
-    def attach () # :nodoc:
-      yield
-    end
-  end
-
-  class CArray
-    def attach! () # :nodoc:
-      yield
-    end
-  end
-
-  class CArray
-    # Returns data class member names
-    def members
-    end
-  end
-
-  class CArray
-    # Returns an array of data class members (fields)
-    def fields
-    end
-  end
-
-  class CArray
-    # Returns an array of data class members (fields) with names specified 
-    def fields_at (*names)
-    end
-  end
-
-  class CArray
-    def project (idx,lval=nil,uval=nil)
-    end
-  end
-
-  class CArray
-    # Reverses the elements of +ca+ in place.
-    def reverse!
-    end
-  end
-
-  class CArray
-    # Returns a new CArray object containing <i>ca</i>'s elements in
-    # reverse order.
-    def reverse
-    end
-  end
-
-  class CArray
-    # Sorts <i>ca</i>'s elements in place.
-    def sort!
-    end
-  end
-
-  class CArray
-    # Returns a new CArray object containing <i>ca</i>'s elements sorted.
-    def sort
-    end
-  end
-
-  class CArray
-    # shuffles the elements.
-    # If `self` has mask, the masked elements are also moved by shuffling.
-    def shuffle!
-    end
-  end
-
-  class CArray
-    def shuffle
-    end
-  end
-
-  class CArray
-    def bsearch
-    end
-  end
-
-  class CArray
-    def bsearch_index
-    end
-  end
-
-  class CArray
-    def search
-    end
-  end
-
-  class CArray
-    def search_index
-    end
-  end
-
-  class CArray
-    def search_nearest
-    end
-  end
-
-  class CAWindow < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def window (*argv)
-    end
-  end
-
-  class CAWindow
-    def index2addr0 (idx)
-    end
-  end
-
-  class CAWindow
-    def addr2addr0 (addr)
-    end
-  end
-
-  class CAWindow
-    def fill_value
-    end
-    def fill_value= (val)
-    end
-  end
-
-  class CAWindow
-    def size0
-    end
-    def start
-    end
-    def step 
-    end
-    def count
-    end
-    def offset
-    end
-  end
-
-  class CAMapping < CAVirtual # :nodoc: 
-  end
-
-  class CADimensionIterator < CAIterator # :nodoc:
-  end
-
-  class CADimensionIterator
-    def sym2dim (sym)
-    end
-  end
-
-  class CARepeat < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def valid_index? (*index)
-    end
-  end
-
-  class CArray
-    def valid_addr? (addr)
-    end
-  end
-
-  class CArray
-    def has_same_shape? (other)
-    end
-  end
-
-  class CArray
-    def == (other)
-    end
-    alias eql? ==
-  end
-
-  class CArray
-    def hash
-    end
-  end
-
-  class CAField < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    # call-seq:
-    #    CArray#field(offset, data_type[, :bytes=>bytes]) 
-    #    CArray#field(offset, data_class) 
-    #    CArray#field(offset, template)
-    #
-    def field (offset, data_type)
-    end
-  end
-
-  class CArray
-    def elem_swap
-    end
-  end
-
-  class CArray
-    def elem_copy
-    end
-  end
-
-  class CArray
-    def elem_store
-    end
-  end
-
-  class CArray
-    def elem_fetch
-    end
-  end
-
-  class CArray
-    def elem_incr
-    end
-  end
-
-  class CArray
-    def elem_decr
-    end
-  end
-
-  class CArray
-    def elem_masked?
-    end
-  end
-
-  class CArray
-    # used in CAHistogram.
-    def incr_addr
-    end
-  end
-
-  class CABitArray < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    def bits
-    end
-    alias bitarray bits
-  end
-
-  class CArray
-    # Converts the array to Ruby's array. For higher dimension, 
-    # the array is nested rank-1 times.
-    def to_a
-    end
-  end
-
-  class CArray
-    # Convert the 
-    def convert (data_type=nil, dim=nil)
-      yield
-    end
-  end
-
-  class CArray
-    # dumps the value array to the given IO stream
-    def dump_binary(io)
-    end
-  end
-
-  class CArray
-    # dumps the value array to a string.
-    def to_s
-    end
-  end
-
-  class CArray
-    # loads the value array from the given IO stream
-    def load_binary (io)
-    end
-  end
-
-  class CArray
-    # Convert the 
-    def convert (data_type=nil, dim=nil)
-      yield
-    end
-  end
-
-  class CARefer < CAVirtual # :nodoc:
-  end
-
-  class CArray
-    # call-seq: 
-    #    CArray.refer()
-    #    CArray.refer(data_type, dim[, :bytes=>bytes, :offset=>offset])
-    #    CArray.refer(data_class, dim)
-    #
-    # Returns CARefer object which refers self.
-    # In second form, `data_type` can be different data_type of self,
-    # as long as the total byte length of new array is smaller than 
-    # that of self. 
-    def refer (*argv)
-    end
-  end
-