All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.math.array.ComplexArray

java.lang.Object
   |
   +----com.ibm.math.array.Array
           |
           +----com.ibm.math.array.ComplexArray

public abstract class ComplexArray
extends Array
ComplexArray = abstract class for arrays of Complexs

The ComplexArray abstract class is the parent class of all concrete arrays of Complexs. It implements the Array.getAsObject and Array.setToObject methods of interface Array. It also declares the methods get and set, that must be implemented by all ComplexArray<rank> classes.

The following <rank>s are valid:

0D (for 0-dimensional arrays), 1D (for 1-dimensional arrays), 2D, 3D.


Constructor Index

 o ComplexArray()
Default constructor.

Method Index

 o get(int[])
Return the value of an element of the array.
 o getAsObject(int[])
Return a Object object which has the same value as the specified element of the array.
 o set(int[], Complex)
Set the value of an element of the array.
 o setToObject(int[], Object)
Sets the specified element of the array to a particular value.

Constructors

 o ComplexArray
 public ComplexArray()
Default constructor.

Methods

 o get
 public abstract Complex get(int index[]) throws InvalidArrayIndexException, ArrayIndexOutOfBoundsException
Return the value of an element of the array.

Parameters:
index - index[i] = index along i-th axis, 0 <= index[i] < size(i)
Throws: InvalidArrayIndexException
index[] must be of length equal to rank
 o getAsObject
 public Object getAsObject(int index[]) throws InvalidArrayIndexException, ArrayIndexOutOfBoundsException
Return a Object object which has the same value as the specified element of the array.

Parameters:
index - index[i] = index along i-th axis, 0 <= index[i] < size(i)
Throws: InvalidArrayIndexException
index[] must be of length equal to rank
Overrides:
getAsObject in class Array
 o set
 public abstract void set(int index[],
                          Complex d) throws InvalidArrayIndexException, ArrayIndexOutOfBoundsException
Set the value of an element of the array.

Parameters:
index - index[i] = index along i-th axis, 0 <= index[i] < size(i)
d - value to which element is set
Throws: InvalidArrayIndexException
index[] must be of length equal to rank
 o setToObject
 public void setToObject(int index[],
                         Object obj) throws InvalidArrayIndexException, ArrayIndexOutOfBoundsException, NullPointerException
Sets the specified element of the array to a particular value.

Parameters:
index - index[i] = index along i-th axis, 0 <= index[i] < size(i)
obj - the array element is set to the value of this Object
Throws: InvalidArrayIndexException
index[] must be of length equal to rank
Overrides:
setToObject in class Array

All Packages  Class Hierarchy  This Package  Previous  Next  Index