org.ojalgo.matrix.decomposition

Class EigenvalueDecomposition<N extends java.lang.Number>

java.lang.Object

org.ojalgo.matrix.decomposition.EigenvalueDecomposition<N>

All Implemented Interfaces:

Eigenvalue<N>, HermitianDecomposition<N>, MatrixDecomposition<N>, DeterminantTask<N>, InverterTask<N>, MatrixTask<N>, SolverTask<N>

Deprecated.

v38 This class will be made package private. Use the inteface instead.

@Deprecated
public abstract class EigenvalueDecomposition<N extends java.lang.Number>
extends java.lang.Object
implements Eigenvalue<N>

Author:

apete

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.SolverTask

SolverTask.Factory<N extends java.lang.Number>

Nested classes/interfaces inherited from interface org.ojalgo.matrix.task.DeterminantTask

DeterminantTask.Factory<N extends java.lang.Number>

Field Summary

Fields inherited from interface org.ojalgo.matrix.task.SolverTask

BIG, COMPLEX, PRIMITIVE

Fields inherited from interface org.ojalgo.matrix.task.DeterminantTask

BIG, COMPLEX, PRIMITIVE

Method Summary

Modifier and Type	Method and Description
N	calculateDeterminant(Access2D<N> matrix) Deprecated.
boolean	checkAndCompute(Access2D<?> matrix) Deprecated. Will check if then the input matrix is hermitian and if it is then compute the decomposition.
boolean	compute(Access2D<?> matrix) Deprecated.
boolean	equals(java.lang.Object someObj)
MatrixStore<N>	getD() Deprecated. The only requirements on [D] are that it should contain the eigenvalues and that [A][V] = [V][D].
Array1D<ComplexNumber>	getEigenvalues() Deprecated. Even for real matrices the eigenvalues are potentially complex numbers.
MatrixStore<N>	getV() Deprecated. The columns of [V] represent the eigenvectors of [A] in the sense that [A][V] = [V][D].
MatrixStore<N>	invert(MatrixStore<N> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	invert(MatrixStore<N> original, DecompositionStore<N> preallocated) Implementiong this method is optional.
boolean	isComputed()
static <N extends java.lang.Number> Eigenvalue<N>	make(Access2D<N> template) Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead
static Eigenvalue<java.math.BigDecimal>	makeBig() Deprecated. v38 Use Eigenvalue.makeBig() instead
static Eigenvalue<java.math.BigDecimal>	makeBig(boolean symmetric) Deprecated. v38 Use Eigenvalue.makeBig(boolean) instead
static Eigenvalue<ComplexNumber>	makeComplex() Deprecated. v38 Use Eigenvalue.makeComplex() instead
static Eigenvalue<ComplexNumber>	makeComplex(boolean hermitian) Deprecated. v38 Use Eigenvalue.makeComplex(boolean) instead
static Eigenvalue<java.lang.Double>	makeJama() Deprecated. v38 Use Eigenvalue.makePrimitive() instead
static Eigenvalue<java.lang.Double>	makeJama(boolean symmetric) Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead
static Eigenvalue<java.lang.Double>	makePrimitive() Deprecated. v38 Use Eigenvalue.makePrimitive() instead
static Eigenvalue<java.lang.Double>	makePrimitive(boolean symmetric) Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead
DecompositionStore<N>	preallocate(Access2D<N> template) Implementiong this method is optional.
DecompositionStore<N>	preallocate(Access2D<N> templateBody, Access2D<N> templateRHS) Implementiong this method is optional.
void	reset() Deprecated. Delete computed results, and resets attributes to default values
MatrixStore<N>	solve(Access2D<N> rhs) Deprecated. [A][X]=[B] or [this][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs) [A][X]=[B] or [body][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs, DecompositionStore<N> preallocated) Implementiong this method is optional.
MatrixStore<N>	solve(Access2D<N> rhs, DecompositionStore<N> preallocated) Deprecated. Implementiong this method is optional.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ojalgo.matrix.decomposition.Eigenvalue

compute, getDeterminant, getTrace, isHermitian, isOrdered, reconstruct

Methods inherited from interface org.ojalgo.matrix.decomposition.MatrixDecomposition

equals, equals, getInverse, getInverse, isComputed, isFullSize, isSolvable

Methods inherited from interface org.ojalgo.matrix.task.InverterTask

invert, invert, preallocate

Methods inherited from interface org.ojalgo.matrix.task.SolverTask

preallocate, solve, solve

Method Detail

make

@Deprecated
public static final <N extends java.lang.Number> Eigenvalue<N> make(Access2D<N> template)

Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead

Specified by:

make in interface Eigenvalue<N extends java.lang.Number>

makeBig

@Deprecated
public static final Eigenvalue<java.math.BigDecimal> makeBig()

Deprecated. v38 Use Eigenvalue.makeBig() instead

Specified by:

makeBig in interface Eigenvalue<N extends java.lang.Number>

makeBig

@Deprecated
public static final Eigenvalue<java.math.BigDecimal> makeBig(boolean symmetric)

Deprecated. v38 Use Eigenvalue.makeBig(boolean) instead

Specified by:

makeBig in interface Eigenvalue<N extends java.lang.Number>

makeComplex

@Deprecated
public static final Eigenvalue<ComplexNumber> makeComplex()

Deprecated. v38 Use Eigenvalue.makeComplex() instead

Specified by:

makeComplex in interface Eigenvalue<N extends java.lang.Number>

makeComplex

@Deprecated
public static final Eigenvalue<ComplexNumber> makeComplex(boolean hermitian)

Deprecated. v38 Use Eigenvalue.makeComplex(boolean) instead

Specified by:

makeComplex in interface Eigenvalue<N extends java.lang.Number>

makeJama

@Deprecated
public static final Eigenvalue<java.lang.Double> makeJama()

Deprecated. v38 Use Eigenvalue.makePrimitive() instead

makeJama

@Deprecated
public static final Eigenvalue<java.lang.Double> makeJama(boolean symmetric)

Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead

makePrimitive

@Deprecated
public static final Eigenvalue<java.lang.Double> makePrimitive()

Deprecated. v38 Use Eigenvalue.makePrimitive() instead

Specified by:

makePrimitive in interface Eigenvalue<N extends java.lang.Number>

makePrimitive

@Deprecated
public static final Eigenvalue<java.lang.Double> makePrimitive(boolean symmetric)

Deprecated. v38 Use Eigenvalue.makePrimitive(boolean) instead

Specified by:

makePrimitive in interface Eigenvalue<N extends java.lang.Number>

calculateDeterminant

public final N calculateDeterminant(Access2D<N> matrix)

Deprecated.

Specified by:

calculateDeterminant in interface DeterminantTask<N extends java.lang.Number>

compute

public final boolean compute(Access2D<?> matrix)

Deprecated.

Specified by:

compute in interface MatrixDecomposition<N extends java.lang.Number>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

getD

public final MatrixStore<N> getD()

Deprecated.

Description copied from interface: Eigenvalue

The only requirements on [D] are that it should contain the eigenvalues and that [A][V] = [V][D]. The ordering of the eigenvalues is not specified.

• If [A] is real and symmetric then [D] is (purely) diagonal with real eigenvalues.
• If [A] is real but not symmetric then [D] is block-diagonal with real eigenvalues in 1-by-1 blocks and complex eigenvalues in 2-by-2 blocks.
• If [A] is complex then [D] is (purely) diagonal with complex eigenvalues.

Specified by:

getD in interface Eigenvalue<N extends java.lang.Number>

Returns:

The (block) diagonal eigenvalue matrix.

getEigenvalues

public final Array1D<ComplexNumber> getEigenvalues()

Deprecated.

Description copied from interface: Eigenvalue

Even for real matrices the eigenvalues are potentially complex numbers. Typically they need to be expressed as complex numbers when [A] is not symmetric.

The eigenvalues in this array should be ordered in descending order - largest (modulus) first.

Specified by:

getEigenvalues in interface Eigenvalue<N extends java.lang.Number>

Returns:

The eigenvalues in an ordered array.

getV

public final MatrixStore<N> getV()

Deprecated.

Description copied from interface: Eigenvalue

The columns of [V] represent the eigenvectors of [A] in the sense that [A][V] = [V][D].

Specified by:

getV in interface Eigenvalue<N extends java.lang.Number>

Returns:

The eigenvector matrix.

checkAndCompute

public final boolean checkAndCompute(Access2D<?> matrix)

Deprecated.

Description copied from interface: HermitianDecomposition

Will check if then the input matrix is hermitian and if it is then compute the decomposition.

Specified by:

checkAndCompute in interface HermitianDecomposition<N extends java.lang.Number>

Parameters:

matrix - A matrix to decompose

Returns:

true if the hermitian check passed and computation suceeded; false if not

reset

public void reset()

Deprecated.

Description copied from interface: MatrixDecomposition

Delete computed results, and resets attributes to default values

Specified by:

reset in interface MatrixDecomposition<N extends java.lang.Number>

solve

public final MatrixStore<N> solve(Access2D<N> rhs)

Deprecated.

Description copied from interface: MatrixDecomposition

[A][X]=[B] or [this][return]=[rhs]

Specified by:

solve in interface MatrixDecomposition<N extends java.lang.Number>

solve

public final MatrixStore<N> solve(Access2D<N> rhs,
                                  DecompositionStore<N> preallocated)

Deprecated.

Description copied from interface: MatrixDecomposition

Implementiong this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling MatrixDecomposition.solve(Access2D).

Specified by:

solve in interface MatrixDecomposition<N extends java.lang.Number>

Parameters:

rhs - The Right Hand Side, wont be modfied

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The solution

equals

public boolean equals(java.lang.Object someObj)

Overrides:

equals in class java.lang.Object

invert

public final MatrixStore<N> invert(MatrixStore<N> original)

Description copied from interface: InverterTask

The output must be a "right inverse" and a "generalised inverse".

See Also:

BasicMatrix.invert()

invert

public final MatrixStore<N> invert(MatrixStore<N> original,
                                   DecompositionStore<N> preallocated)

Description copied from interface: InverterTask

Implementiong this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling InverterTask.invert(MatrixStore).

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The inverse

solve

public final MatrixStore<N> solve(Access2D<N> body,
                                  Access2D<N> rhs)

Description copied from interface: SolverTask

[A][X]=[B] or [body][return]=[rhs]

solve

public final MatrixStore<N> solve(Access2D<N> body,
                                  Access2D<N> rhs,
                                  DecompositionStore<N> preallocated)

Description copied from interface: SolverTask

Implementiong this method is optional.

Exactly how a specific implementation makes use of preallocated is not specified by this interface. It must be documented for each implementation.

Should produce the same results as calling SolverTask.solve(Access2D, Access2D).

rhs - The Right Hand Side, wont be modfied

preallocated - Preallocated memory for the results, possibly some intermediate results. You must assume this is modified, but you cannot assume it will contain the full/final/correct solution.

Returns:

The solution

preallocate

public final DecompositionStore<N> preallocate(Access2D<N> template)

Description copied from interface: InverterTask

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with InverterTask.invert(MatrixStore, DecompositionStore). When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb (if A is square then there is no doubt).

Specified by:

preallocate in interface InverterTask<N extends java.lang.Number>

preallocate

public final DecompositionStore<N> preallocate(Access2D<N> templateBody,
                                               Access2D<N> templateRHS)

Description copied from interface: SolverTask

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with SolverTask.solve(Access2D, Access2D, DecompositionStore). When solving an equation system [A][X]=[B] ([mxn][nxb]=[mxb]) the preallocated memory/matrix will typically be either mxb or nxb (if A is square then there is no doubt).

Specified by:

preallocate in interface SolverTask<N extends java.lang.Number>

Returns:

isComputed

public final boolean isComputed()

Specified by:

isComputed in interface MatrixDecomposition<N extends java.lang.Number>

Returns:

true if computation has been attemped; false if not.

See Also:

MatrixDecomposition.compute(Access2D), MatrixDecomposition.isSolvable()