org.ojalgo.matrix.decomposition
Class PrimitiveEigenvalue

java.lang.Object
  org.ojalgo.matrix.decomposition.PrimitiveEigenvalue

All Implemented Interfaces:

Serializable, Eigenvalue<Double>, MatrixDecomposition<Double>

Deprecated. Version 19. Use JamaEigenvalue instead.

public final class PrimitiveEigenvalue
extends Object
implements Eigenvalue<Double>

PrimitiveEigenvalue

See Also:

Serialized Form

Constructor Summary

PrimitiveEigenvalue()
Deprecated.

Method Summary

boolean	compute(BasicMatrix aMtrx)
boolean	compute(MatrixStore<Double> aMtrx) Deprecated. Check for symmetry, then construct the eigenvalue decomposition
boolean	equals(BasicMatrix aMtrx, NumberContext aCntxt)
MatrixStore<Double>	getD() Deprecated. The only requirements on [D] are that it should contain the eigenvalues and that [A][V] = [V][D].
ComplexNumber	getDeterminant() Deprecated. A matrix' determinant is the product of its eigenvalues.
BasicArray<ComplexNumber>	getEigenvalues() Deprecated. Even for real matrices the eigenvalues are potentially complex numbers.
BasicMatrix	getMatrixD() Deprecated. Return the block diagonal eigenvalue matrix
BasicMatrix	getMatrixV() Deprecated. Return the eigenvector matrix
MatrixStore<Double>	getStoreD() Deprecated. Use getD() instead
MatrixStore<Double>	getStoreV() Deprecated. Use getV() instead
ComplexNumber	getTrace() Deprecated. A matrix' trace is the sum of the diagonal elements.
MatrixStore<Double>	getV() Deprecated. The columns of [V] represent the eigenvectors of [A] in the sense that [A][V] = [V][D].
boolean	isComputed()
boolean	isEconomySize() Deprecated.
BasicMatrix	solve(BasicMatrix aRHS)
MatrixStore<Double>	solve(MatrixStore<Double> aRHS) Deprecated.

Methods inherited from class java.lang.Object

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

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

compute, equals, isComputed, solve

Constructor Detail

PrimitiveEigenvalue

public PrimitiveEigenvalue()

Deprecated.

Method Detail

compute

public boolean compute(MatrixStore<Double> aMtrx)

Deprecated.

Check for symmetry, then construct the eigenvalue decomposition

Specified by:

compute in interface MatrixDecomposition<Double>

Parameters:

aMtrx - A matrix to decompose

Returns:

true if the computation suceeded; false if not

getD

public MatrixStore<Double> 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<Double>

Returns:

The (block) diagonal eigenvalue matrix.

getDeterminant

public ComplexNumber getDeterminant()

Deprecated.

Description copied from interface: Eigenvalue

A matrix' determinant is the product of its eigenvalues.

Specified by:

getDeterminant in interface Eigenvalue<Double>

Returns:

The matrix' determinant

getEigenvalues

public BasicArray<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<Double>

Returns:

The eigenvalues in an ordered array.

getMatrixD

public BasicMatrix getMatrixD()

Deprecated.

Return the block diagonal eigenvalue matrix

Specified by:

getMatrixD in interface Eigenvalue<Double>

Returns:

D

getMatrixV

public BasicMatrix getMatrixV()

Deprecated.

Return the eigenvector matrix

Specified by:

getMatrixV in interface Eigenvalue<Double>

Returns:

V

getStoreD

public MatrixStore<Double> getStoreD()

Deprecated. Use getD() instead

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:

getStoreD in interface Eigenvalue<Double>

Returns:

The (block) diagonal eigenvalue matrix.

getStoreV

public MatrixStore<Double> getStoreV()

Deprecated. Use getV() instead

Description copied from interface: Eigenvalue

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

Specified by:

getStoreV in interface Eigenvalue<Double>

Returns:

The eigenvector matrix.

getTrace

public ComplexNumber getTrace()

Deprecated.

Description copied from interface: Eigenvalue

A matrix' trace is the sum of the diagonal elements. It is also the sum of the eigenvalues. This method should return the sum of the eigenvalues.

Specified by:

getTrace in interface Eigenvalue<Double>

Returns:

The matrix' trace

getV

public MatrixStore<Double> 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<Double>

Returns:

The eigenvector matrix.

isEconomySize

public boolean isEconomySize()

Deprecated.

Specified by:

isEconomySize in interface MatrixDecomposition<Double>

Returns:

True if the implementation generates an economy sized decomposition.

solve

public MatrixStore<Double> solve(MatrixStore<Double> aRHS)

Deprecated.

Specified by:

solve in interface MatrixDecomposition<Double>

compute

public final boolean compute(BasicMatrix aMtrx)

Specified by:

compute in interface MatrixDecomposition<N extends Number>

Parameters:

aMtrx - A matrix to decompose

Returns:

true if the computation suceeded; false if not

equals

public boolean equals(BasicMatrix aMtrx,
                      NumberContext aCntxt)

Specified by:

equals in interface MatrixDecomposition<N extends Number>

isComputed

public boolean isComputed()

Specified by:

isComputed in interface MatrixDecomposition<N extends Number>

Returns:

true if computation has been attemped AND was successful so that it is possible to call MatrixDecomposition.solve(MatrixStore); false if not

solve

public final BasicMatrix solve(BasicMatrix aRHS)

Specified by:

solve in interface MatrixDecomposition<N extends Number>