org.ojalgo.matrix.jama

Class JamaEigenvalue.General

java.lang.Object

org.ojalgo.matrix.jama.JamaEigenvalue

org.ojalgo.matrix.jama.JamaEigenvalue.General

All Implemented Interfaces:

Eigenvalue<Double>, MatrixDecomposition<Double>, DecompositionTask<Double>, DeterminantTask<Double>, InverterTask<Double>, SolverTask<Double>

Enclosing class:

JamaEigenvalue

public static final class JamaEigenvalue.General
extends JamaEigenvalue

Nested Class Summary

Nested classes/interfaces inherited from class org.ojalgo.matrix.jama.JamaEigenvalue

JamaEigenvalue.General, JamaEigenvalue.Nonsymmetric, JamaEigenvalue.Symmetric

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

InverterTask.Factory<N extends Number>

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

SolverTask.Factory<N extends Number>

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

DeterminantTask.Factory<N extends Number>

Field Summary

Fields inherited from interface org.ojalgo.matrix.decomposition.task.InverterTask

BIG, COMPLEX, PRIMITIVE

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

BIG, COMPLEX, PRIMITIVE

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

BIG, COMPLEX, PRIMITIVE

Constructor Summary

Constructors

Constructor and Description
General()

Method Summary

Modifier and Type	Method and Description
boolean	compute(Access2D<?> aStore)
boolean	equals(MatrixDecomposition<Double> other, NumberContext context)
MatrixStore<Double>	getInverse(DecompositionStore<Double> preallocated) Makes no use of preallocated at all.
MatrixStore<Double>	invert(MatrixStore<Double> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<Double>	invert(MatrixStore<Double> original, DecompositionStore<Double> preallocated) Implementiong this method is optional.
DecompositionStore<Double>	preallocate(Access2D<Double> template) Implementiong this method is optional.
DecompositionStore<Double>	preallocate(Access2D<Double> templateBody, Access2D<Double> templateRHS) Implementiong this method is optional.
MatrixStore<Double>	solve(Access2D<Double> body, Access2D<Double> rhs) [A][X]=[B] or [this][return]=[aRHS]
MatrixStore<Double>	solve(Access2D<Double> body, Access2D<Double> rhs, DecompositionStore<Double> preallocated) Implementiong this method is optional.
JamaMatrix	solve(Access2D<Double> rhs, DecompositionStore<Double> preallocated) Makes no use of preallocated at all.

Methods inherited from class org.ojalgo.matrix.jama.JamaEigenvalue

calculateDeterminant, compute, equals, getD, getDeterminant, getEigenvalues, getInverse, getTrace, getV, isAspectRatioNormal, isComputed, isFullSize, isHermitian, isOrdered, isSolvable, reconstruct, reset, solve, toString

Methods inherited from class java.lang.Object

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

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

compute, equals, getInverse, preallocate, solve

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

invert, invert, preallocate

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

solve, solve

Constructor Detail

General

public General()

Method Detail

compute

public final boolean compute(Access2D<?> aStore)

Specified by:

compute in interface MatrixDecomposition<Double>

Parameters:

aStore - A matrix to decompose

Returns:

true if the computation suceeded; false if not

equals

public final boolean equals(MatrixDecomposition<Double> other,
                            NumberContext context)

Specified by:

equals in interface MatrixDecomposition<Double>

getInverse

public final MatrixStore<Double> getInverse(DecompositionStore<Double> preallocated)

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

Specified by:

getInverse in interface MatrixDecomposition<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

See Also:

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

invert

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

Description copied from interface: InverterTask

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

Specified by:

invert in interface InverterTask<Double>

See Also:

BasicMatrix.invert()

invert

public final MatrixStore<Double> invert(MatrixStore<Double> original,
                                        DecompositionStore<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 #getInverse().

Specified by:

invert in interface InverterTask<Double>

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

preallocate

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

Description copied from interface: InverterTask

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with #solve(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 InverterTask<Double>

Returns:

preallocate

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

Description copied from interface: MatrixDecomposition

Implementiong this method is optional.

Will create a DecompositionStore instance suitable for use with MatrixDecomposition.solve(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 MatrixDecomposition<Double>

Specified by:

preallocate in interface SolverTask<Double>

Returns:

solve

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

Description copied from interface: SolverTask

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

Specified by:

solve in interface SolverTask<Double>

solve

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

Specified by:

solve in interface SolverTask<Double>

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 final JamaMatrix solve(Access2D<Double> rhs,
                              DecompositionStore<Double> preallocated)

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

Specified by:

solve in interface MatrixDecomposition<Double>

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)