org.ojalgo.matrix.store
Class ComplexDenseStore

java.lang.Object
  org.ojalgo.array.ComplexArray
      org.ojalgo.matrix.store.ComplexDenseStore

All Implemented Interfaces:

Serializable, Access1D<ComplexNumber>, Access2D<ComplexNumber>, DecompositionStore<ComplexNumber>, MatrixStore<ComplexNumber>, PhysicalStore<ComplexNumber>

public final class ComplexDenseStore
extends ComplexArray
implements PhysicalStore<ComplexNumber>, DecompositionStore<ComplexNumber>

A ComplexNumber implementation of PhysicalStore.

Author:

apete

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.PhysicalStore

PhysicalStore.Factory<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.store.MatrixStore

MatrixStore.Builder<N extends Number>

Field Summary

static boolean	DEBUG
static PhysicalStore.Factory<ComplexNumber>	FACTORY
int	length

Method Summary

ComplexNumber	aggregateAll(ChainableAggregator aVisitor)
ComplexNumber	aggregateAll(CollectableAggregator aVisitor)
Array1D<N>	asArray1D() A utility facade that conveniently/consistently presents the BasicArray as a one-dimensional array.
Array2D<ComplexNumber>	asArray2D()
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.
Array1D<ComplexNumber>	asList()
MatrixStore.Builder<ComplexNumber>	builder()
void	caxpy(ComplexNumber aSclrA, int aColX, int aColY, int aFirstRow) column a * x plus y
void	computeInPlaceBidiagonal(boolean newNormalAspectRatio)
boolean	computeInPlaceCholesky(boolean checkForSPD)
void	computeInPlaceHessenberg(boolean upper)
LUDecomposition.Pivot	computeInPlaceLU(boolean assumeNoPivotingRequired)
void	computeInPlaceQR()
void	computeInPlaceTridiagonal()
PhysicalStore<ComplexNumber>	computeInPlaceTridiagonal(boolean someCollectTransformations)
ComplexDenseStore	conjugate() Each call must produce a new instance.
ComplexDenseStore	copy() Each call must produce a new instance.
double	doubleValue(int aRow, int aCol) Extracts one element of this matrix as a double.
boolean	equals(MatrixStore<ComplexNumber> aStore, NumberContext aCntxt)
boolean	equals(Object anObj)
void	exchangeColumns(int aColA, int aColB)
void	exchangeRows(int aRowA, int aRowB)
void	fillAll(ComplexNumber aNmbr)
void	fillByMultiplying(MatrixStore<ComplexNumber> aLeftArg, MatrixStore<ComplexNumber> aRightArg)
void	fillColumn(int aRow, int aCol, ComplexNumber aNmbr)
void	fillDiagonal(int aRow, int aCol, ComplexNumber aNmbr)
void	fillMatching(Access2D<ComplexNumber> aSource2D)
void	fillMatching(ComplexNumber aLeftArg, BinaryFunction<ComplexNumber> aFunc, MatrixStore<ComplexNumber> aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillMatching(MatrixStore<ComplexNumber> aLeftArg, BinaryFunction<ComplexNumber> aFunc, ComplexNumber aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillMatching(MatrixStore<ComplexNumber> aLeftArg, BinaryFunction<ComplexNumber> aFunc, MatrixStore<ComplexNumber> aRightArg) Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:
void	fillRow(int aRow, int aCol, ComplexNumber aNmbr)
Householder<ComplexNumber>	generateHouseholderColumn(int newI, int newIj)
Householder<ComplexNumber>	generateHouseholderRow(int newIj, int newI)
ComplexNumber	get(int aRow, int aCol)
int	getColDim() The size of this structure in the column-direction/dimension
PhysicalStore.Factory<ComplexNumber>	getFactory()
int	getIndexOfLargestInColumn(int aRow, int aCol)
int	getIndexOfLargestInRow(int aRow, int aCol)
int	getMinDim()
int	getRowDim() The size of this structure in the row-direction/dimension
int	hashCode()
boolean	isAbsolute(int aRow, int aCol)
boolean	isReal(int aRow, int aCol)
boolean	isZero(int aRow, int aCol)
void	maxpy(ComplexNumber aSclrA, MatrixStore<ComplexNumber> aMtrxX) matrix a * x plus y
void	modifyAll(UnaryFunction<ComplexNumber> aFunc)
void	modifyColumn(int aRow, int aCol, UnaryFunction<ComplexNumber> aFunc)
void	modifyDiagonal(int aRow, int aCol, UnaryFunction<ComplexNumber> aFunc)
void	modifyRow(int aRow, int aCol, UnaryFunction<ComplexNumber> aFunc)
MatrixStore<ComplexNumber>	multiplyLeft(MatrixStore<ComplexNumber> aStore)
MatrixStore<ComplexNumber>	multiplyRight(MatrixStore<ComplexNumber> aStore)
void	raxpy(ComplexNumber aSclrA, int aRowX, int aRowY, int aFirstCol) row a * x plus y
void	set(int aRow, int aCol, ComplexNumber aNmbr)
void	set(int aRow, int aCol, double aNmbr)
int	size()
int	size()
void	substituteBackwards(Access2D<ComplexNumber> aBody, boolean transposed) Will solve the equation system [A][X]=[B] where: [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution). [A] is upper/right triangular
void	substituteForwards(Access2D<ComplexNumber> aBody, boolean onesOnDiagonal, Access2D<ComplexNumber> aRHS, boolean zerosAboveDiagonal) Will solve the equation system [A][X]=[B] where: [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution). [A] is lower/left triangular
Scalar<ComplexNumber>	toScalar(int aRow, int aCol)
String	toString()
void	transformLeft(Householder.Reference<ComplexNumber> aTransf, int aFirstCol)
void	transformLeft(Householder<ComplexNumber> aTransf, int aFirstCol)
void	transformLeft(Rotation<ComplexNumber> aTransf) As in MatrixStore.multiplyLeft(MatrixStore) where the left/parameter matrix is a plane rotation.
void	transformRight(Householder.Reference<ComplexNumber> aTransf, int aFirstRow)
void	transformRight(Householder<ComplexNumber> aTransf, int aFirstRow)
void	transformRight(Rotation<ComplexNumber> aTransf) As in MatrixStore.multiplyRight(MatrixStore) where the right/parameter matrix is a plane rotation.
ComplexDenseStore	transpose() Each call must produce a new instance.
void	visitAll(AggregatorFunction<ComplexNumber> aVisitor)
void	visitColumn(int aRow, int aCol, AggregatorFunction<ComplexNumber> aVisitor)
void	visitDiagonal(int aRow, int aCol, AggregatorFunction<ComplexNumber> aVisitor)
void	visitRow(int aRow, int aCol, AggregatorFunction<ComplexNumber> aVisitor)

Methods inherited from class org.ojalgo.array.ComplexArray

doubleValue, exchange, fill, fill, fill, fill, get, getIndexOfLargest, isAbsolute, isReal, isZero, modify, modify, modify, modify, modify, modify, searchAscending, set, set, sortAscending, toScalar, visit

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FACTORY

public static final PhysicalStore.Factory<ComplexNumber> FACTORY

DEBUG

public static boolean DEBUG

length

public final int length

Method Detail

aggregateAll

public ComplexNumber aggregateAll(ChainableAggregator aVisitor)

Specified by:

aggregateAll in interface MatrixStore<ComplexNumber>

aggregateAll

public ComplexNumber aggregateAll(CollectableAggregator aVisitor)

Specified by:

aggregateAll in interface MatrixStore<ComplexNumber>

asArray2D

public Array2D<ComplexNumber> asArray2D()

Specified by:

asArray2D in interface DecompositionStore<ComplexNumber>

asList

public Array1D<ComplexNumber> asList()

Specified by:

asList in interface PhysicalStore<ComplexNumber>

Returns:

The elements of the physical store as a fixed size (1 dimensional) list. The elements may be accessed either row or colomn major.

builder

public final MatrixStore.Builder<ComplexNumber> builder()

Specified by:

builder in interface MatrixStore<ComplexNumber>

caxpy

public void caxpy(ComplexNumber aSclrA,
                  int aColX,
                  int aColY,
                  int aFirstRow)

Description copied from interface: PhysicalStore

column a * x plus y

[this(*,aColY)] = aSclrA [this(*,aColX)] + [this(*,aColY)]

Specified by:

caxpy in interface PhysicalStore<ComplexNumber>

computeInPlaceBidiagonal

public void computeInPlaceBidiagonal(boolean newNormalAspectRatio)

Specified by:

computeInPlaceBidiagonal in interface DecompositionStore<ComplexNumber>

computeInPlaceCholesky

public boolean computeInPlaceCholesky(boolean checkForSPD)

Specified by:

computeInPlaceCholesky in interface DecompositionStore<ComplexNumber>

computeInPlaceHessenberg

public void computeInPlaceHessenberg(boolean upper)

Specified by:

computeInPlaceHessenberg in interface DecompositionStore<ComplexNumber>

computeInPlaceLU

public LUDecomposition.Pivot computeInPlaceLU(boolean assumeNoPivotingRequired)

Specified by:

computeInPlaceLU in interface DecompositionStore<ComplexNumber>

computeInPlaceQR

public void computeInPlaceQR()

Specified by:

computeInPlaceQR in interface DecompositionStore<ComplexNumber>

computeInPlaceTridiagonal

public void computeInPlaceTridiagonal()

Specified by:

computeInPlaceTridiagonal in interface DecompositionStore<ComplexNumber>

computeInPlaceTridiagonal

public PhysicalStore<ComplexNumber> computeInPlaceTridiagonal(boolean someCollectTransformations)

conjugate

public ComplexDenseStore conjugate()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

conjugate in interface MatrixStore<ComplexNumber>

Returns:

A new conjugated PhysicalStore copy.

copy

public ComplexDenseStore copy()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

copy in interface MatrixStore<ComplexNumber>

Returns:

A new PhysicalStore copy.

doubleValue

public double doubleValue(int aRow,
                          int aCol)

Extracts one element of this matrix as a double.

Parameters:

aRow - A row index.

aCol - A column index.

Returns:

One matrix element

equals

public boolean equals(MatrixStore<ComplexNumber> aStore,
                      NumberContext aCntxt)

Specified by:

equals in interface MatrixStore<ComplexNumber>

equals

public boolean equals(Object anObj)

Overrides:

equals in class ComplexArray

exchangeColumns

public void exchangeColumns(int aColA,
                            int aColB)

Specified by:

exchangeColumns in interface PhysicalStore<ComplexNumber>

exchangeRows

public void exchangeRows(int aRowA,
                         int aRowB)

Specified by:

exchangeRows in interface PhysicalStore<ComplexNumber>

fillAll

public void fillAll(ComplexNumber aNmbr)

Specified by:

fillAll in interface PhysicalStore<ComplexNumber>

fillByMultiplying

public void fillByMultiplying(MatrixStore<ComplexNumber> aLeftArg,
                              MatrixStore<ComplexNumber> aRightArg)

Specified by:

fillByMultiplying in interface PhysicalStore<ComplexNumber>

fillColumn

public void fillColumn(int aRow,
                       int aCol,
                       ComplexNumber aNmbr)

Specified by:

fillColumn in interface PhysicalStore<ComplexNumber>

fillDiagonal

public void fillDiagonal(int aRow,
                         int aCol,
                         ComplexNumber aNmbr)

Specified by:

fillDiagonal in interface PhysicalStore<ComplexNumber>

fillMatching

public void fillMatching(Access2D<ComplexNumber> aSource2D)

Specified by:

fillMatching in interface PhysicalStore<ComplexNumber>

fillMatching

public void fillMatching(ComplexNumber aLeftArg,
                         BinaryFunction<ComplexNumber> aFunc,
                         MatrixStore<ComplexNumber> aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg,aRightArg(i,j))

Specified by:

fillMatching in interface PhysicalStore<ComplexNumber>

fillMatching

public void fillMatching(MatrixStore<ComplexNumber> aLeftArg,
                         BinaryFunction<ComplexNumber> aFunc,
                         ComplexNumber aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg(i,j),aRightArg))

Specified by:

fillMatching in interface PhysicalStore<ComplexNumber>

fillMatching

public void fillMatching(MatrixStore<ComplexNumber> aLeftArg,
                         BinaryFunction<ComplexNumber> aFunc,
                         MatrixStore<ComplexNumber> aRightArg)

Description copied from interface: PhysicalStore

Will replace the elements of [this] with the results of element wise invocation of the input binary funtion:

this(i,j) = aFunc.invoke(aLeftArg(i,j),aRightArg(i,j))

Specified by:

fillMatching in interface PhysicalStore<ComplexNumber>

fillRow

public void fillRow(int aRow,
                    int aCol,
                    ComplexNumber aNmbr)

Specified by:

fillRow in interface PhysicalStore<ComplexNumber>

generateHouseholderColumn

public Householder<ComplexNumber> generateHouseholderColumn(int newI,
                                                            int newIj)

Specified by:

generateHouseholderColumn in interface PhysicalStore<ComplexNumber>

generateHouseholderRow

public Householder<ComplexNumber> generateHouseholderRow(int newIj,
                                                         int newI)

Specified by:

generateHouseholderRow in interface PhysicalStore<ComplexNumber>

get

public ComplexNumber get(int aRow,
                         int aCol)

getColDim

public int getColDim()

The size of this structure in the column-direction/dimension

Returns:

The number of columns

getFactory

public PhysicalStore.Factory<ComplexNumber> getFactory()

Specified by:

getFactory in interface MatrixStore<ComplexNumber>

getIndexOfLargestInColumn

public int getIndexOfLargestInColumn(int aRow,
                                     int aCol)

Specified by:

getIndexOfLargestInColumn in interface PhysicalStore<ComplexNumber>

getIndexOfLargestInRow

public int getIndexOfLargestInRow(int aRow,
                                  int aCol)

Specified by:

getIndexOfLargestInRow in interface PhysicalStore<ComplexNumber>

getMinDim

public int getMinDim()

Specified by:

getMinDim in interface MatrixStore<ComplexNumber>

getRowDim

public int getRowDim()

The size of this structure in the row-direction/dimension

Returns:

The number of rows

hashCode

public int hashCode()

Overrides:

hashCode in class ComplexArray

isAbsolute

public boolean isAbsolute(int aRow,
                          int aCol)

Specified by:

isAbsolute in interface MatrixStore<ComplexNumber>

See Also:

Scalar.isAbsolute()

isReal

public boolean isReal(int aRow,
                      int aCol)

Specified by:

isReal in interface MatrixStore<ComplexNumber>

See Also:

Scalar.isReal()

isZero

public boolean isZero(int aRow,
                      int aCol)

Specified by:

isZero in interface MatrixStore<ComplexNumber>

See Also:

Scalar.isZero()

maxpy

public void maxpy(ComplexNumber aSclrA,
                  MatrixStore<ComplexNumber> aMtrxX)

Description copied from interface: PhysicalStore

matrix a * x plus y

[this] = aSclrA [aMtrxX] + [this]

Specified by:

maxpy in interface PhysicalStore<ComplexNumber>

modifyAll

public void modifyAll(UnaryFunction<ComplexNumber> aFunc)

Specified by:

modifyAll in interface PhysicalStore<ComplexNumber>

modifyColumn

public void modifyColumn(int aRow,
                         int aCol,
                         UnaryFunction<ComplexNumber> aFunc)

Specified by:

modifyColumn in interface PhysicalStore<ComplexNumber>

modifyDiagonal

public void modifyDiagonal(int aRow,
                           int aCol,
                           UnaryFunction<ComplexNumber> aFunc)

Specified by:

modifyDiagonal in interface PhysicalStore<ComplexNumber>

modifyRow

public void modifyRow(int aRow,
                      int aCol,
                      UnaryFunction<ComplexNumber> aFunc)

Specified by:

modifyRow in interface PhysicalStore<ComplexNumber>

multiplyLeft

public MatrixStore<ComplexNumber> multiplyLeft(MatrixStore<ComplexNumber> aStore)

Specified by:

multiplyLeft in interface MatrixStore<ComplexNumber>

multiplyRight

public MatrixStore<ComplexNumber> multiplyRight(MatrixStore<ComplexNumber> aStore)

Specified by:

multiplyRight in interface MatrixStore<ComplexNumber>

raxpy

public void raxpy(ComplexNumber aSclrA,
                  int aRowX,
                  int aRowY,
                  int aFirstCol)

Description copied from interface: PhysicalStore

row a * x plus y

[this(aRowY,*)] = aSclrA [this(aRowX,*)] + [this(aRowY,*)]

Specified by:

raxpy in interface PhysicalStore<ComplexNumber>

set

public void set(int aRow,
                int aCol,
                ComplexNumber aNmbr)

Specified by:

set in interface PhysicalStore<ComplexNumber>

set

public void set(int aRow,
                int aCol,
                double aNmbr)

Specified by:

set in interface PhysicalStore<ComplexNumber>

substituteBackwards

public void substituteBackwards(Access2D<ComplexNumber> aBody,
                                boolean transposed)

Description copied from interface: DecompositionStore

Will solve the equation system [A][X]=[B] where:

• [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution).
• [A] is upper/right triangular

Specified by:

substituteBackwards in interface DecompositionStore<ComplexNumber>

Parameters:

aBody - The equation system body parameters [A]

transposed - true if the upper/right part of aBody is actually stored in the lower/left part of the matrix.

substituteForwards

public void substituteForwards(Access2D<ComplexNumber> aBody,
                               boolean onesOnDiagonal,
                               Access2D<ComplexNumber> aRHS,
                               boolean zerosAboveDiagonal)

Description copied from interface: DecompositionStore

Will solve the equation system [A][X]=[B] where:

• [aBody][this]=[this] is [A][X]=[B] ("this" is the right hand side, and it will be overwritten with the solution).
• [A] is lower/left triangular

Specified by:

substituteForwards in interface DecompositionStore<ComplexNumber>

Parameters:

aBody - The equation system body parameters [A]

onesOnDiagonal - true if aBody as ones on the diagonal

toScalar

public Scalar<ComplexNumber> toScalar(int aRow,
                                      int aCol)

Specified by:

toScalar in interface MatrixStore<ComplexNumber>

transformLeft

public void transformLeft(Householder.Reference<ComplexNumber> aTransf,
                          int aFirstCol)

Specified by:

transformLeft in interface DecompositionStore<ComplexNumber>

transformLeft

public void transformLeft(Householder<ComplexNumber> aTransf,
                          int aFirstCol)

Specified by:

transformLeft in interface PhysicalStore<ComplexNumber>

transformLeft

public void transformLeft(Rotation<ComplexNumber> aTransf)

Description copied from interface: PhysicalStore

As in MatrixStore.multiplyLeft(MatrixStore) where the left/parameter matrix is a plane rotation.

Multiplying by a plane rotation from the left means that [this] gets two of its rows updated to new combinations of those two (current) rows.

There are two ways to transpose/invert a rotation. Either you negate the angle or you interchange the two indeces that define the rotation plane.

Specified by:

transformLeft in interface PhysicalStore<ComplexNumber>

See Also:

PhysicalStore.transformRight(Rotation)

transformRight

public void transformRight(Householder.Reference<ComplexNumber> aTransf,
                           int aFirstRow)

Specified by:

transformRight in interface DecompositionStore<ComplexNumber>

transformRight

public void transformRight(Householder<ComplexNumber> aTransf,
                           int aFirstRow)

Specified by:

transformRight in interface PhysicalStore<ComplexNumber>

transformRight

public void transformRight(Rotation<ComplexNumber> aTransf)

Description copied from interface: PhysicalStore

As in MatrixStore.multiplyRight(MatrixStore) where the right/parameter matrix is a plane rotation.

Multiplying by a plane rotation from the right means that [this] gets two of its columns updated to new combinations of those two (current) columns.

There result is undefined if the two input indeces are the same (in which case the rotation plane is undefined).

Specified by:

transformRight in interface PhysicalStore<ComplexNumber>

See Also:

PhysicalStore.transformLeft(Rotation)

transpose

public ComplexDenseStore transpose()

Description copied from interface: MatrixStore

Each call must produce a new instance.

Specified by:

transpose in interface MatrixStore<ComplexNumber>

Returns:

A new transposed PhysicalStore copy.

visitAll

public void visitAll(AggregatorFunction<ComplexNumber> aVisitor)

Specified by:

visitAll in interface MatrixStore<ComplexNumber>

visitColumn

public void visitColumn(int aRow,
                        int aCol,
                        AggregatorFunction<ComplexNumber> aVisitor)

Specified by:

visitColumn in interface MatrixStore<ComplexNumber>

visitDiagonal

public void visitDiagonal(int aRow,
                          int aCol,
                          AggregatorFunction<ComplexNumber> aVisitor)

Specified by:

visitDiagonal in interface MatrixStore<ComplexNumber>

visitRow

public void visitRow(int aRow,
                     int aCol,
                     AggregatorFunction<ComplexNumber> aVisitor)

Specified by:

visitRow in interface MatrixStore<ComplexNumber>

size

public int size()

Returns:

The total number of elements contained in this structure

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