org.ojalgo.matrix.decomposition

Class RawEigenvalue

java.lang.Object

org.ojalgo.matrix.decomposition.RawEigenvalue

All Implemented Interfaces:

Eigenvalue<java.lang.Double>, HermitianDecomposition<java.lang.Double>, MatrixDecomposition<java.lang.Double>, DeterminantTask<java.lang.Double>, InverterTask<java.lang.Double>, MatrixTask<java.lang.Double>, SolverTask<java.lang.Double>

Direct Known Subclasses:

RawEigenvalue.General, RawEigenvalue.Nonsymmetric, RawEigenvalue.Symmetric

Deprecated.

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

@Deprecated
public abstract class RawEigenvalue
extends java.lang.Object
implements Eigenvalue<java.lang.Double>

This class adapts JAMA's EigenvalueDecomposition to ojAlgo's Eigenvalue interface.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawEigenvalue.General Deprecated.
static class	RawEigenvalue.Nonsymmetric Deprecated.
static class	RawEigenvalue.Symmetric Deprecated.

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
java.lang.Double	calculateDeterminant(Access2D<java.lang.Double> matrix) Deprecated.
boolean	compute(Access2D<?> matrix) Deprecated.
boolean	compute(Access2D<?> matrix, boolean eigenvaluesOnly) Deprecated.
boolean	equals(MatrixStore<java.lang.Double> aStore, NumberContext context) Deprecated.
RawStore	getD() Deprecated. The only requirements on [D] are that it should contain the eigenvalues and that [A][V] = [V][D].
java.lang.Double	getDeterminant() Deprecated. A matrix' determinant is the product of its eigenvalues.
Array1D<ComplexNumber>	getEigenvalues() Deprecated. Even for real matrices the eigenvalues are potentially complex numbers.
RawStore	getInverse() Deprecated. The output must be a "right inverse" and a "generalised inverse".
MatrixStore<java.lang.Double>	getInverse(DecompositionStore<java.lang.Double> preallocated) Deprecated. Makes no use of preallocated at all.
ComplexNumber	getTrace() Deprecated. A matrix' trace is the sum of the diagonal elements.
RawStore	getV() Deprecated. The columns of [V] represent the eigenvectors of [A] in the sense that [A][V] = [V][D].
MatrixStore<java.lang.Double>	invert(MatrixStore<java.lang.Double> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<java.lang.Double>	invert(MatrixStore<java.lang.Double> original, DecompositionStore<java.lang.Double> preallocated) Implementiong this method is optional.
boolean	isComputed()
boolean	isFullSize() Deprecated.
boolean	isHermitian() Deprecated. If [A] is hermitian then [V][D][V]-1 becomes [Q][D][Q]H...
boolean	isOrdered() Deprecated. The eigenvalues in D (and the eigenvectors in V) are not necessarily ordered.
boolean	isSolvable() Deprecated.
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.
MatrixStore<java.lang.Double>	reconstruct() Deprecated.
void	reset() Deprecated. Delete computed results, and resets attributes to default values
RawStore	solve(Access2D<java.lang.Double> rhs) Deprecated. [A][X]=[B] or [this][return]=[rhs]
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> body, Access2D<java.lang.Double> rhs) [A][X]=[B] or [body][return]=[rhs]
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> body, Access2D<java.lang.Double> rhs, DecompositionStore<java.lang.Double> preallocated) Implementiong this method is optional.
MatrixStore<java.lang.Double>	solve(Access2D<java.lang.Double> rhs, DecompositionStore<java.lang.Double> preallocated) Makes no use of preallocated at all.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

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

make, makeBig, makeBig, makeComplex, makeComplex, makePrimitive, makePrimitive

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

checkAndCompute

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

equals, isComputed, solve

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

calculateDeterminant

public java.lang.Double calculateDeterminant(Access2D<java.lang.Double> matrix)

Deprecated.

Specified by:

calculateDeterminant in interface DeterminantTask<java.lang.Double>

compute

public boolean compute(Access2D<?> matrix,
                       boolean eigenvaluesOnly)

Deprecated.

Specified by:

compute in interface Eigenvalue<java.lang.Double>

Parameters:

matrix - A matrix to decompose

eigenvaluesOnly - No need to calculate eigenvectors

Returns:

true/false if the computation succeeded or not

equals

public boolean equals(MatrixStore<java.lang.Double> aStore,
                      NumberContext context)

Deprecated.

Specified by:

equals in interface MatrixDecomposition<java.lang.Double>

getD

public RawStore 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<java.lang.Double>

Returns:

The (block) diagonal eigenvalue matrix.

getDeterminant

public java.lang.Double getDeterminant()

Deprecated.

Description copied from interface: Eigenvalue

A matrix' determinant is the product of its eigenvalues.

Specified by:

getDeterminant in interface Eigenvalue<java.lang.Double>

Returns:

The matrix' determinant

getEigenvalues

public 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<java.lang.Double>

Returns:

The eigenvalues in an ordered array.

getInverse

public RawStore getInverse()

Deprecated.

Description copied from interface: MatrixDecomposition

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

Specified by:

getInverse in interface MatrixDecomposition<java.lang.Double>

See Also:

BasicMatrix.invert()

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<java.lang.Double>

Returns:

The matrix' trace

getV

public RawStore 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<java.lang.Double>

Returns:

The eigenvector matrix.

isFullSize

public boolean isFullSize()

Deprecated.

Specified by:

isFullSize in interface MatrixDecomposition<java.lang.Double>

Returns:

True if the implementation generates a full sized decomposition.

isHermitian

public boolean isHermitian()

Deprecated.

Description copied from interface: Eigenvalue

If [A] is hermitian then [V][D][V]^-1 becomes [Q][D][Q]^H...

Specified by:

isHermitian in interface Eigenvalue<java.lang.Double>

isOrdered

public boolean isOrdered()

Deprecated.

Description copied from interface: Eigenvalue

The eigenvalues in D (and the eigenvectors in V) are not necessarily ordered. This is a property of the algorithm/implementation, not the data.

Specified by:

isOrdered in interface Eigenvalue<java.lang.Double>

Returns:

true if they are ordered

isSolvable

public boolean isSolvable()

Deprecated.

Specified by:

isSolvable in interface MatrixDecomposition<java.lang.Double>

Returns:

true if it is ok to call MatrixDecomposition.solve(Access2D) (computation was successful); false if not

See Also:

MatrixDecomposition.solve(Access2D), MatrixDecomposition.isComputed()

reconstruct

public MatrixStore<java.lang.Double> reconstruct()

Deprecated.

Specified by:

reconstruct in interface Eigenvalue<java.lang.Double>

Specified by:

reconstruct in interface MatrixDecomposition<java.lang.Double>

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<java.lang.Double>

solve

public RawStore solve(Access2D<java.lang.Double> rhs)

Deprecated.

Description copied from interface: MatrixDecomposition

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

Specified by:

solve in interface MatrixDecomposition<java.lang.Double>

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object

compute

public final boolean compute(Access2D<?> matrix)

Deprecated.

Specified by:

compute in interface MatrixDecomposition<java.lang.Double>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

getInverse

public final MatrixStore<java.lang.Double> getInverse(DecompositionStore<java.lang.Double> preallocated)

Deprecated.

Makes no use of preallocated at all. Simply delegates to getInverse().

Specified by:

getInverse in interface MatrixDecomposition<java.lang.Double>

Parameters:

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, this is where you get the solution

See Also:

MatrixDecomposition.getInverse(org.ojalgo.matrix.decomposition.DecompositionStore)

invert

public final MatrixStore<java.lang.Double> invert(MatrixStore<java.lang.Double> 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<java.lang.Double> invert(MatrixStore<java.lang.Double> original,
                                                  DecompositionStore<java.lang.Double> 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<java.lang.Double> solve(Access2D<java.lang.Double> body,
                                                 Access2D<java.lang.Double> rhs)

Description copied from interface: SolverTask

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

solve

public final MatrixStore<java.lang.Double> solve(Access2D<java.lang.Double> body,
                                                 Access2D<java.lang.Double> rhs,
                                                 DecompositionStore<java.lang.Double> 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

solve

public MatrixStore<java.lang.Double> solve(Access2D<java.lang.Double> rhs,
                                           DecompositionStore<java.lang.Double> preallocated)

Makes no use of preallocated at all. Simply delegates to MatrixDecomposition.solve(Access2D).

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

See Also:

MatrixDecomposition.solve(Access2D, org.ojalgo.matrix.decomposition.DecompositionStore)

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()