org.ojalgo.array
Class ComplexArray

java.lang.Object
  org.ojalgo.array.ComplexArray

All Implemented Interfaces:

Serializable, Access1D<ComplexNumber>

Direct Known Subclasses:

ComplexDenseStore

public class ComplexArray
extends Object

A one- and/or arbitrary-dimensional array of ComplexNumber.

Author:

apete

See Also:

PrimitiveArray, Serialized Form

Field Summary

static boolean	DEBUG
int	length

Method Summary

Array1D<N>	asArray1D() A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array.
Array2D<N>	asArray2D(int aRowDim, int aColDim) A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array.
ArrayAnyD<N>	asArrayAnyD(int[] aStructure) A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array.
double	doubleValue(int anInd)
boolean	equals(Object anObj)
void	exchange(int aFirstA, int aFirstB, int aStep, int aCount)
void	fill(int aFirst, int aLimit, ComplexArray aLeftArg, BinaryFunction<ComplexNumber> aFunc, ComplexArray aRightArg)
void	fill(int aFirst, int aLimit, ComplexArray aLeftArg, BinaryFunction<ComplexNumber> aFunc, ComplexNumber aRightArg)
void	fill(int aFirst, int aLimit, ComplexNumber aLeftArg, BinaryFunction<ComplexNumber> aFunc, ComplexArray aRightArg)
void	fill(int aFirst, int aLimit, int aStep, ComplexNumber aNmbr)
ComplexNumber	get(int anInd)
int	getIndexOfLargest(int aFirst, int aLimit, int aStep)
int	hashCode()
boolean	isAbsolute(int anInd)
boolean	isReal(int anInd)
boolean	isZero(int anInd)
void	modify(int aFirst, int aLimit, int aStep, BinaryFunction<ComplexNumber> aFunc, ComplexArray aRightArg)
void	modify(int aFirst, int aLimit, int aStep, BinaryFunction<ComplexNumber> aFunc, ComplexNumber aRightArg)
void	modify(int aFirst, int aLimit, int aStep, ComplexArray aLeftArg, BinaryFunction<ComplexNumber> aFunc)
void	modify(int aFirst, int aLimit, int aStep, ComplexNumber aLeftArg, BinaryFunction<ComplexNumber> aFunc)
void	modify(int aFirst, int aLimit, int aStep, ParameterFunction<ComplexNumber> aFunc, int aParam)
void	modify(int aFirst, int aLimit, int aStep, UnaryFunction<ComplexNumber> aFunc)
int	searchAscending(ComplexNumber aNmbr)
void	set(int anInd, ComplexNumber aNmbr)
void	set(int anInd, double aNmbr)
int	size()
void	sortAscending()
ComplexNumber	toScalar(int anInd)
String	toString()
void	visit(int aFirst, int aLimit, int aStep, AggregatorFunction<ComplexNumber> aVisitor)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEBUG

public static boolean DEBUG

length

public final int length

Method Detail

doubleValue

public final double doubleValue(int anInd)

equals

public boolean equals(Object anObj)

Overrides:

equals in class Object

exchange

public final void exchange(int aFirstA,
                           int aFirstB,
                           int aStep,
                           int aCount)

fill

public final void fill(int aFirst,
                       int aLimit,
                       ComplexArray aLeftArg,
                       BinaryFunction<ComplexNumber> aFunc,
                       ComplexArray aRightArg)

fill

public final void fill(int aFirst,
                       int aLimit,
                       ComplexArray aLeftArg,
                       BinaryFunction<ComplexNumber> aFunc,
                       ComplexNumber aRightArg)

fill

public final void fill(int aFirst,
                       int aLimit,
                       ComplexNumber aLeftArg,
                       BinaryFunction<ComplexNumber> aFunc,
                       ComplexArray aRightArg)

fill

public final void fill(int aFirst,
                       int aLimit,
                       int aStep,
                       ComplexNumber aNmbr)

get

public final ComplexNumber get(int anInd)

getIndexOfLargest

public int getIndexOfLargest(int aFirst,
                             int aLimit,
                             int aStep)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAbsolute

public final boolean isAbsolute(int anInd)

See Also:

Scalar.isAbsolute()

isReal

public final boolean isReal(int anInd)

See Also:

Scalar.isReal()

isZero

public final boolean isZero(int anInd)

See Also:

Scalar.isZero()

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         BinaryFunction<ComplexNumber> aFunc,
                         ComplexArray aRightArg)

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         BinaryFunction<ComplexNumber> aFunc,
                         ComplexNumber aRightArg)

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         ComplexArray aLeftArg,
                         BinaryFunction<ComplexNumber> aFunc)

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         ComplexNumber aLeftArg,
                         BinaryFunction<ComplexNumber> aFunc)

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         ParameterFunction<ComplexNumber> aFunc,
                         int aParam)

modify

public final void modify(int aFirst,
                         int aLimit,
                         int aStep,
                         UnaryFunction<ComplexNumber> aFunc)

searchAscending

public final int searchAscending(ComplexNumber aNmbr)

See Also:

BasicArray.searchAscending(java.lang.Number)

set

public final void set(int anInd,
                      ComplexNumber aNmbr)

set

public final void set(int anInd,
                      double aNmbr)

sortAscending

public final void sortAscending()

See Also:

Arrays.sort(Object[]), searchAscending(Number)

toScalar

public final ComplexNumber toScalar(int anInd)

visit

public final void visit(int aFirst,
                        int aLimit,
                        int aStep,
                        AggregatorFunction<ComplexNumber> aVisitor)

asArray1D

public final Array1D<N> asArray1D()

A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array. Note that you will modify the actual array by accessing it through this facade.

Disregards the array structure, and simply treats it as one-domensional.

asArray2D

public final Array2D<N> asArray2D(int aRowDim,
                                  int aColDim)

A utility facade that conveniently/consistently presents the BasicArray as a two-dimensional array. Note that you will modify the actual array by accessing it through this facade.

If "this" has more than two dimensions then only the first plane of the first cube of the first... is used/accessed. If this only has one dimension then everything is assumed to be in the first column of the first plane of the first cube...

asArrayAnyD

public final ArrayAnyD<N> asArrayAnyD(int[] aStructure)

A utility facade that conveniently/consistently presents the BasicArray as a multi-dimensional array. Note that you will modify the actual array by accessing it through this facade.

size

public final int size()

Returns:

The total number of elements contained in this structure

toString

public String toString()

Overrides:

toString in class Object