All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.math.array.ComplexArray2D
java.lang.Object
|
+----com.ibm.math.array.Array
|
+----com.ibm.math.array.ComplexArray
|
+----com.ibm.math.array.ComplexArray2D
- public final class ComplexArray2D
- extends ComplexArray
ComplexArray2D = 2-dimensional array of Complexs
The ComplexArray2D concrete class implements 2-dimensional arrays
of Complexs. 2-dimensional arrays can either be instantiated directly
through constructors, or they can begenerated by extracting sections
from other 2- or higher-dimensional arrays.
-
ComplexArray2D(Complex[][])
- Create a 2-dimensional array, with shape and values defined by
a Java Complex[][].
-
ComplexArray2D(ComplexArray2D)
- Create a new 2-dimensional array as a copy of a given
ComplexArray2D
-
ComplexArray2D(int, int)
- Create a 2-dimensional array of a certain shape.
-
assign(Complex)
- Assign a scalar value to all elements of the array.
-
assign(ComplexArray2D)
- Assign the values from another 2-dimensional array to this array.
-
div(Complex)
- Each array element is divided by a scalar and the data
computed is returned in a new array
-
div(Complex, ComplexArray2D)
- Each array element is divided by a scalar and the data
computed is returned in the result array parameter
-
div(ComplexArray2D)
- Divides each array element by the corresponding array element and return the data
computed in a new array
-
div(ComplexArray2D, ComplexArray2D)
- Divides each array element by the corresponding array element and return the data
computed in the result array parameter
-
divAssign(Complex)
- div combined with assignment to this array
-
divAssign(ComplexArray2D)
- div combined with assignment to this array
-
equals(Complex)
- Computes, element by element, the result of the comparison:
element of this array equals to scalar
and return all the results in a new booleanArray2D of the
same shape as this array.
-
equals(Complex, booleanArray2D)
- Computes, element by element, the result of the comparison:
element of this array equals to scalar
and return all the results in the result array.
-
equals(ComplexArray2D)
- Computes, element by element, the result of the comparison:
element of this array equals to parameter array (arrayin) element
and return all the results in a new booleanArray2D of the
same shape as both arrays.
-
equals(ComplexArray2D, booleanArray2D)
- Computes, element by element, the result of the comparison:
element of this array equals to parameter array (arrayin) element
and return all the results in the result array.
-
get(Index, Index)
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
-
get(Index, Index, ComplexArray2D)
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
-
get(Index, int)
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
-
get(Index, int, ComplexArray1D)
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
-
get(Index, Range)
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
-
get(Index, Range, ComplexArray2D)
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
-
get(int, Index)
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
-
get(int, Index, ComplexArray1D)
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
-
get(int, int)
- Return the value of an element of the array.
-
get(int, Range)
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
-
get(int, Range, ComplexArray1D)
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
-
get(int[])
- Return the value of an element of the array.
-
get(Range, Index)
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
-
get(Range, Index, ComplexArray2D)
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
-
get(Range, int)
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
-
get(Range, int, ComplexArray1D)
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
-
get(Range, Range)
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
-
get(Range, Range, ComplexArray2D)
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
-
last(int)
- Return the index of the last element along its i-th axis.
-
minus(Complex)
- Subtracts a scalar from each array element and return the data
computed in a new array
-
minus(Complex, ComplexArray2D)
- Subtracts a scalar from each array element and return the data
computed in the result array parameter
-
minus(ComplexArray2D)
- Subtracts the corresponding array element from each array element and return the data
computed in a new array
-
minus(ComplexArray2D, ComplexArray2D)
- Subtracts the corresponding array element from each array element and return the data
computed in the result array parameter
-
minusAssign(Complex)
- minus combined with assignment to this array
-
minusAssign(ComplexArray2D)
- minus combined with assignment to this array
-
permuteAxes(int, int)
- Permute the axes of this array, thus creating a reference
to its (generic) transpose.
-
permuteAxes(int[])
- Permute the axes of this array, thus creating a reference
to its (generic) transpose.
-
plus(Complex)
- Adds a scalar to each array element and return the data
computed in a new array
-
plus(Complex, ComplexArray2D)
- Adds a scalar to each array element and return the data
computed in the result array parameter
-
plus(ComplexArray2D)
- Adds the corresponding array element to each array element and return the data
computed in a new array
-
plus(ComplexArray2D, ComplexArray2D)
- Adds the corresponding array element to each array element and return the data
computed in the result array parameter
-
plusAssign(Complex)
- plus combined with assignment to this array
-
plusAssign(ComplexArray2D)
- plus combined with assignment to this array
-
rank()
- Return the rank of the 2-dimensional array, 2.
-
reshape()
- This method reshapes this array into an array with
rank 0, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
-
reshape(int)
- This method reshapes this array into an array with
rank 1, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
-
reshape(int, int)
- This method reshapes this array into an array with
rank 2, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
-
reshape(int, int, int)
- This method reshapes this array into an array with
rank 3, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
-
reshape(int[])
- This method is the implementation of the Array interface
reshape that simply call the apropriate version of reshape
given the target rank.
-
section(int, int)
- Extract a 0-dimensional section from the array.
-
section(int, Range)
- Extract a 1-dimensional section from the array.
-
section(Range, int)
- Extract a 1-dimensional section from the array.
-
section(Range, Range)
- Extract a 2-dimensional section from the array.
-
set(Index, Index, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Index, Index, ComplexArray2D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
-
set(Index, int, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Index, int, ComplexArray1D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
-
set(Index, Range, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Index, Range, ComplexArray2D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
-
set(int, Index, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(int, Index, ComplexArray1D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
-
set(int, int, Complex)
- Set the value of an element of the array.
-
set(int, Range, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(int, Range, ComplexArray1D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
-
set(int[], Complex)
- Set the value of an element of the array.
-
set(Range, Index, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Range, Index, ComplexArray2D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
-
set(Range, int, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Range, int, ComplexArray1D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
-
set(Range, Range, Complex)
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
-
set(Range, Range, ComplexArray2D)
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
-
shape()
- Return the shape of the array as an int[] I of length 2.
-
size()
- Return the number of elements in the array.
-
size(int)
- Return the extent of the array along its i-th axis.
-
times(Complex)
- Each array element is multiplied by the scalar parameter and the data
computed is returned in a new array
-
times(Complex, ComplexArray2D)
- Each array element is multiplied by scalar and the data computed
is returned in result array parameter
-
times(ComplexArray2D)
- Multiplies each array element by its corresponding array element and return the data
computed in a new array
-
times(ComplexArray2D, ComplexArray2D)
- Multiplies each array element by its corresponding array element and return the data
computed in the result array parameter
-
timesAssign(Complex)
- times combined with assignment to this array
-
timesAssign(ComplexArray2D)
- times combined with assignment to this array
-
toJava()
- Transforms this ComplexArray2D to a Complex[][].
-
unequals(Complex)
- Computes, element by element, the result of the comparison:
element of this array not equals to scalar
and return all the results in a new booleanArray2D of the
same shape as this array.
-
unequals(Complex, booleanArray2D)
- Computes, element by element, the result of the comparison:
element of this array not equals to scalar
and return all the results in the result array.
-
unequals(ComplexArray2D)
- Computes, element by element, the result of the comparison:
element of this array not equals to parameter array (arrayin) element
and return all the results in a new booleanArray2D of the
same shape as both arrays.
-
unequals(ComplexArray2D, booleanArray2D)
- Computes, element by element, the result of the comparison:
element of this array not equals to parameter array (arrayin) element
and return all the results in the result array.
ComplexArray2D
public ComplexArray2D(int n0,
int n1) throws InvalidArrayShapeException
- Create a 2-dimensional array of a certain shape.
Elements are 0-valued
- Parameters:
- n0 - extent of the array along 0th axis
- n1 - extent of the array along 1th axis
- Throws: InvalidArrayShapeException
- all extents must be nonnegative
ComplexArray2D
public ComplexArray2D(ComplexArray2D arrayin)
- Create a new 2-dimensional array as a copy of a given
ComplexArray2D
- Parameters:
- arrayin - Array to copy
ComplexArray2D
public ComplexArray2D(Complex datain[][]) throws InvalidArrayShapeException
- Create a 2-dimensional array, with shape and values defined by
a Java Complex[][].
- Parameters:
- datain - Java Complex[][] defining shape and values of the array
- Throws: InvalidArrayShapeException
- The Java array must be rectangular
assign
public void assign(Complex value)
- Assign a scalar value to all elements of the array.
- Parameters:
- d - value to be assigned
assign
public void assign(ComplexArray2D arrayin) throws NonconformingArrayException
- Assign the values from another 2-dimensional array to this array.
- Parameters:
- a - array with source values
- Throws: NonconformingArrayException
- arrays must be of same shape
rank
public int rank()
- Return the rank of the 2-dimensional array, 2.
- Overrides:
- rank in class Array
shape
public int[] shape()
- Return the shape of the array as an int[] I of length 2.
ret[0] = size(0)
ret[1] = size(1)
- Overrides:
- shape in class Array
size
public int size()
- Return the number of elements in the array.
- Returns:
- the total number of elements
- Overrides:
- size in class Array
size
public int size(int i) throws InvalidArrayAxisException
- Return the extent of the array along its i-th axis.
- Parameters:
- i - array axis (0 <= i < rank())
- Returns:
- the number of elements along axis i
- Throws: InvalidArrayAxisException
- i must be between 0 and 1
- Overrides:
- size in class Array
last
public int last(int i) throws InvalidArrayAxisException
- Return the index of the last element along its i-th axis.
the value returned is simply size(i)-1, but is convenient
to have such a method because last(i) is more readable than
size(i)-1.
- Parameters:
- i - array axis (0 <= i < rank())
- Returns:
- the index of the last element along axis i
- Throws: InvalidArrayAxisException
- i must be between 0 and 1
- Overrides:
- last in class Array
permuteAxes
public Array permuteAxes(int permarray[]) throws InvalidArrayAxisException
- Permute the axes of this array, thus creating a reference
to its (generic) transpose.
- Parameters:
- array - an array indicating the permutation to be done.
ex: for a 2D array array2D.PermuteAxis({1,0});
would permute the array, but array2D.PermuteAxis({0,1});
returns the same array
- Throws: InvalidArrayAxisException
- 0 <= a0,a1 <= 1
- Overrides:
- permuteAxes in class Array
permuteAxes
public ComplexArray2D permuteAxes(int a0,
int a1) throws InvalidArrayAxisException
- Permute the axes of this array, thus creating a reference
to its (generic) transpose.
- Parameters:
- a0 - Axis to appear as 0 axis (0 to 1)
- a1 - Axis to appear as 0 axis (0 to 1)
- Throws: InvalidArrayAxisException
- Axes must be in valid range and all different
reshape
public Array reshape(int size[]) throws NonconformingArrayException
- This method is the implementation of the Array interface
reshape that simply call the apropriate version of reshape
given the target rank.
- Parameters:
- size - size[i] is the extent of the result array along the i axis.
- Throws: NonconformingArrayException
- The size of the resulting array
must be compatible with this array, and in the range of ranks supported
by this implementation.
- Overrides:
- reshape in class Array
reshape
public ComplexArray0D reshape() throws NonconformingArrayException
- This method reshapes this array into an array with
rank 0, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
- Throws: NonconformingArrayException
- the product of all parameters
must be equal to size of this array
reshape
public ComplexArray1D reshape(int size0) throws NonconformingArrayException
- This method reshapes this array into an array with
rank 1, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
- Parameters:
- size0: - extent of resulting array along axis #0
- Throws: NonconformingArrayException
- the product of all parameters
must be equal to size of this array
reshape
public ComplexArray2D reshape(int size0,
int size1) throws NonconformingArrayException
- This method reshapes this array into an array with
rank 2, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
- Parameters:
- size0: - extent of resulting array along axis #0
- size1: - extent of resulting array along axis #1
- Throws: NonconformingArrayException
- the product of all parameters
must be equal to size of this array
reshape
public ComplexArray3D reshape(int size0,
int size1,
int size2) throws NonconformingArrayException
- This method reshapes this array into an array with
rank 3, each parameter gives the size
in each array dimension, the array returned has a copy
of the data from this array, it does not share data
with this array
- Parameters:
- size0: - extent of resulting array along axis #0
- size1: - extent of resulting array along axis #1
- size2: - extent of resulting array along axis #2
- Throws: NonconformingArrayException
- the product of all parameters
must be equal to size of this array
section
public ComplexArray0D section(int idx0,
int idx1) throws ArrayIndexOutOfBoundsException
- Extract a 0-dimensional section from the array.
- Parameters:
- i0 - index along axis n# 0 defining the section
- i1 - index along axis n# 1 defining the section
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
section
public ComplexArray1D section(int idx0,
Range idx1) throws ArrayIndexOutOfBoundsException
- Extract a 1-dimensional section from the array.
- Parameters:
- i0 - index along axis n# 0 defining the section
- i1 - range of indices along axis n# 1 defining the section
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
section
public ComplexArray1D section(Range idx0,
int idx1) throws ArrayIndexOutOfBoundsException
- Extract a 1-dimensional section from the array.
- Parameters:
- i0 - range of indices along axis n# 0 defining the section
- i1 - index along axis n# 1 defining the section
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
section
public ComplexArray2D section(Range idx0,
Range idx1) throws ArrayIndexOutOfBoundsException
- Extract a 2-dimensional section from the array.
- Parameters:
- i0 - range of indices along axis n# 0 defining the section
- i1 - range of indices along axis n# 1 defining the section
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public 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 2
- Overrides:
- get in class ComplexArray
get
public Complex get(int idx0,
int idx1) throws ArrayIndexOutOfBoundsException
- Return the value of an element of the array.
- Parameters:
- idx0 - index along the axis n# 0 of the array.
- idx1 - index along the axis n# 1 of the array.
get
public ComplexArray1D get(int idx0,
Range idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(int idx0,
Range idx1,
ComplexArray1D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray1D get(int idx0,
Index idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(int idx0,
Index idx1,
ComplexArray1D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray1D get(Range idx0,
int idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Range idx0,
int idx1,
ComplexArray1D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray2D get(Range idx0,
Range idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Range idx0,
Range idx1,
ComplexArray2D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray2D get(Range idx0,
Index idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Range idx0,
Index idx1,
ComplexArray2D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray1D get(Index idx0,
int idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Index idx0,
int idx1,
ComplexArray1D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray2D get(Index idx0,
Range idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Index idx0,
Range idx1,
ComplexArray2D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public ComplexArray2D get(Index idx0,
Index idx1) throws ArrayIndexOutOfBoundsException
- Extract selected elements of this ComplexArray2D into a new ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
get
public void get(Index idx0,
Index idx1,
ComplexArray2D result) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Extract selected elements of this ComplexArray2D into a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- result - resulting array
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public 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 2
- Overrides:
- set in class ComplexArray
set
public void set(int idx0,
int idx1,
Complex val) throws ArrayIndexOutOfBoundsException
- Set the value of an element of the array.
- Parameters:
- idx0 - index along the axis n# 0 of the array
- idx1 - index along the axis n# 1 of the array
- val - value to which element is set
set
public void set(int idx0,
Range idx1,
ComplexArray1D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(int idx0,
Range idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(int idx0,
Index idx1,
ComplexArray1D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(int idx0,
Index idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
int idx1,
ComplexArray1D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
int idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
Range idx1,
ComplexArray2D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
Range idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
Index idx1,
ComplexArray2D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Range idx0,
Index idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
int idx1,
ComplexArray1D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray1D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
int idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
Range idx1,
ComplexArray2D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
Range idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
Index idx1,
ComplexArray2D arrayin) throws ArrayIndexOutOfBoundsException, NonconformingArrayException
- Update the value of the selected elements of this ComplexArray2D with the data in a ComplexArray2D.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- arrayin - array containing the input data
- Throws: NonconformingArrayException
- shapes must match
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
set
public void set(Index idx0,
Index idx1,
Complex datain) throws ArrayIndexOutOfBoundsException
- Update the value of the selected elements of this ComplexArray2D with the data in datain.
- Parameters:
- idx0 - indexes along the axis n# 0 of the array
- idx1 - indexes along the axis n# 1 of the array
- datain - set all elements with this value
- Throws: ArrayIndexOutOfBoundsException
- indices must be valid
plus
public void plus(Complex scalar,
ComplexArray2D result) throws NonconformingArrayException
- Adds a scalar to each array element and return the data
computed in the result array parameter
- Parameters:
- scalar - Complex to be added to each array element
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
plus
public ComplexArray2D plus(Complex scalar)
- Adds a scalar to each array element and return the data
computed in a new array
- Parameters:
- scalar - Complex to be added to each array element
plus
public void plus(ComplexArray2D arrayin,
ComplexArray2D result) throws NonconformingArrayException
- Adds the corresponding array element to each array element and return the data
computed in the result array parameter
- Parameters:
- arrayin - ComplexArray2D to be added element by element
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
plus
public ComplexArray2D plus(ComplexArray2D array) throws NonconformingArrayException
- Adds the corresponding array element to each array element and return the data
computed in a new array
- Parameters:
- array - ComplexArray2D to be added element by element
- Throws: NonconformingArrayException
- shapes must match
plusAssign
public ComplexArray2D plusAssign(Complex scalar)
- plus combined with assignment to this array
- Parameters:
- scalar - The second source operand
plusAssign
public ComplexArray2D plusAssign(ComplexArray2D array) throws NonconformingArrayException
- plus combined with assignment to this array
- Parameters:
- array - The second source operand
- Throws: NonconformingArrayException
- shapes must match
minus
public void minus(Complex scalar,
ComplexArray2D result) throws NonconformingArrayException
- Subtracts a scalar from each array element and return the data
computed in the result array parameter
@param scalar Complex to be subtracted from each array element
- Parameters:
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
minus
public ComplexArray2D minus(Complex scalar)
- Subtracts a scalar from each array element and return the data
computed in a new array
- Parameters:
- scalar - Complex to be subtracted from each array element
- Throws: NonconformingArrayException
- shapes must match
minus
public void minus(ComplexArray2D arrayin,
ComplexArray2D result) throws NonconformingArrayException
- Subtracts the corresponding array element from each array element and return the data
computed in the result array parameter
- Parameters:
- arrayin - ComplexArray2D to be subtracted element by element
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
minus
public ComplexArray2D minus(ComplexArray2D array) throws NonconformingArrayException
- Subtracts the corresponding array element from each array element and return the data
computed in a new array
- Parameters:
- array - ComplexArray2D to be added element by element
- Throws: NonconformingArrayException
- shapes must match
minusAssign
public ComplexArray2D minusAssign(Complex scalar)
- minus combined with assignment to this array
- Parameters:
- scalar - The second source operand
minusAssign
public ComplexArray2D minusAssign(ComplexArray2D array) throws NonconformingArrayException
- minus combined with assignment to this array
- Parameters:
- array - The second source operand
- Throws: NonconformingArrayException
- shapes must match
times
public void times(Complex scalar,
ComplexArray2D result) throws NonconformingArrayException
- Each array element is multiplied by scalar and the data computed
is returned in result array parameter
- Parameters:
- scalar - each array element is multiplied by this Complex value
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
times
public ComplexArray2D times(Complex scalar)
- Each array element is multiplied by the scalar parameter and the data
computed is returned in a new array
- Parameters:
- scalar - each array element is multiplied by this Complex value
times
public void times(ComplexArray2D arrayin,
ComplexArray2D result) throws NonconformingArrayException
- Multiplies each array element by its corresponding array element and return the data
computed in the result array parameter
- Parameters:
- arrayin - ComplexArray2D to be multiplied element by element
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
times
public ComplexArray2D times(ComplexArray2D array) throws NonconformingArrayException
- Multiplies each array element by its corresponding array element and return the data
computed in a new array
- Parameters:
- array - ComplexArray2D to be added element by element
- Throws: NonconformingArrayException
- shapes must match
timesAssign
public ComplexArray2D timesAssign(Complex scalar)
- times combined with assignment to this array
- Parameters:
- scalar - The second source operand
timesAssign
public ComplexArray2D timesAssign(ComplexArray2D array) throws NonconformingArrayException
- times combined with assignment to this array
- Parameters:
- array - The second source operand
- Throws: NonconformingArrayException
- shapes must match
div
public void div(Complex scalar,
ComplexArray2D result) throws NonconformingArrayException
- Each array element is divided by a scalar and the data
computed is returned in the result array parameter
- Parameters:
- scalar - Each array element is divided by this Complex
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
div
public ComplexArray2D div(Complex scalar)
- Each array element is divided by a scalar and the data
computed is returned in a new array
- Parameters:
- scalar - Each array element is divided by this Complex
- Throws: NonconformingArrayException
- shapes must match
div
public void div(ComplexArray2D arrayin,
ComplexArray2D result) throws NonconformingArrayException
- Divides each array element by the corresponding array element and return the data
computed in the result array parameter
- Parameters:
- arrayin - the ComplexArray2D containing the divisors
- result - ComplexArray2D Object that will store the result
- Throws: NonconformingArrayException
- shapes must match
div
public ComplexArray2D div(ComplexArray2D array) throws NonconformingArrayException
- Divides each array element by the corresponding array element and return the data
computed in a new array
- Parameters:
- array - the ComplexArray2D containing the divisors
- Throws: NonconformingArrayException
- shapes must match
divAssign
public ComplexArray2D divAssign(Complex scalar)
- div combined with assignment to this array
- Parameters:
- scalar - The second source operand
divAssign
public ComplexArray2D divAssign(ComplexArray2D array) throws NonconformingArrayException
- div combined with assignment to this array
- Parameters:
- array - The second source operand
- Throws: NonconformingArrayException
- shapes must match
equals
public booleanArray2D equals(Complex scalar)
- Computes, element by element, the result of the comparison:
element of this array equals to scalar
and return all the results in a new booleanArray2D of the
same shape as this array.
- Parameters:
- scalar - scalar to compare element by element with this array
equals
public void equals(Complex scalar,
booleanArray2D result) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array equals to scalar
and return all the results in the result array.
- Parameters:
- scalar - scalar to compare element by element with this array
- result - boolean array to store the result of the comparison
- Throws: NonconformingArrayException
- shapes must match.
equals
public booleanArray2D equals(ComplexArray2D arrayin) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array equals to parameter array (arrayin) element
and return all the results in a new booleanArray2D of the
same shape as both arrays.
- Parameters:
- arrayin - Array to compare element by element with this array
- Throws: NonconformingArrayException
- Shapes must match.
equals
public void equals(ComplexArray2D arrayin,
booleanArray2D result) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array equals to parameter array (arrayin) element
and return all the results in the result array.
- Parameters:
- arrayin - Array to compare element by element with this array
- result - Boolean array to store the result of the comparison
- Throws: NonconformingArrayException
- Shapes must match.
unequals
public booleanArray2D unequals(Complex scalar)
- Computes, element by element, the result of the comparison:
element of this array not equals to scalar
and return all the results in a new booleanArray2D of the
same shape as this array.
- Parameters:
- scalar - scalar to compare element by element with this array
unequals
public void unequals(Complex scalar,
booleanArray2D result) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array not equals to scalar
and return all the results in the result array.
- Parameters:
- scalar - scalar to compare element by element with this array
- result - boolean array to store the result of the comparison
- Throws: NonconformingArrayException
- shapes must match.
unequals
public booleanArray2D unequals(ComplexArray2D arrayin) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array not equals to parameter array (arrayin) element
and return all the results in a new booleanArray2D of the
same shape as both arrays.
- Parameters:
- arrayin - Array to compare element by element with this array
- Throws: NonconformingArrayException
- Shapes must match.
unequals
public void unequals(ComplexArray2D arrayin,
booleanArray2D result) throws NonconformingArrayException
- Computes, element by element, the result of the comparison:
element of this array not equals to parameter array (arrayin) element
and return all the results in the result array.
- Parameters:
- arrayin - Array to compare element by element with this array
- result - Boolean array to store the result of the comparison
- Throws: NonconformingArrayException
- Shapes must match.
toJava
public Complex[][] toJava()
- Transforms this ComplexArray2D to a Complex[][].
All Packages Class Hierarchy This Package Previous Next Index