org.ojalgo.matrix.decomposition
Class TridiagonalDecomposition<N extends Number>

java.lang.Object
  org.ojalgo.matrix.decomposition.TridiagonalDecomposition<N>

All Implemented Interfaces:

MatrixDecomposition<N>, Tridiagonal<N>

public abstract class TridiagonalDecomposition<N extends Number>
extends Object
implements Tridiagonal<N>

Field Summary

static boolean

DEBUG

Method Summary

boolean	compute(MatrixStore<N> aStore)
boolean	equals(MatrixDecomposition<N> aDecomp, NumberContext aCntxt)
boolean	equals(MatrixStore<N> aStore, NumberContext aCntxt)
boolean	equals(Object someObj)
MatrixStore<N>	getD()
MatrixStore<N>	getInverse() The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	getQ()
List<Householder<N>>	getTransformations()
MatrixStore<N>	invert(MatrixStore<N> aStore) A convenience method that produces exactly the same result as if you first call MatrixDecomposition.compute(MatrixStore) and then MatrixDecomposition.getInverse().
boolean	isAspectRatioNormal()
boolean	isComputed()
boolean	isFullSize()
boolean	isSolvable()
static Tridiagonal<BigDecimal>	makeBig()
static Tridiagonal<ComplexNumber>	makeComplex()
static Tridiagonal<Double>	makePrimitive()
MatrixStore<N>	reconstruct()
void	reset() Delete computed results, and resets attributes to default values
MatrixStore<N>	solve(MatrixStore<N> aRHS)
Future<DecomposeAndSolve<N>>	solve(MatrixStore<N> aBody, MatrixStore<N> aRHS) Will solve [aBody][X]=[aRHS] concurrently by first calling MatrixDecomposition.compute(MatrixStore) using [aBody], and then MatrixDecomposition.solve(MatrixStore) using [aRHS].

Methods inherited from class java.lang.Object

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

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

equals, invert, isComputed, reset, solve

Field Detail

DEBUG

public static boolean DEBUG

Method Detail

makeBig

public static final Tridiagonal<BigDecimal> makeBig()

makeComplex

public static final Tridiagonal<ComplexNumber> makeComplex()

makePrimitive

public static final Tridiagonal<Double> makePrimitive()

compute

public final boolean compute(MatrixStore<N> aStore)

Specified by:

compute in interface MatrixDecomposition<N extends Number>

Parameters:

aStore - A matrix to decompose

Returns:

true if the computation suceeded; false if not

equals

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

Specified by:

equals in interface MatrixDecomposition<N extends Number>

getD

public final MatrixStore<N> getD()

Specified by:

getD in interface Tridiagonal<N extends Number>

getInverse

public final MatrixStore<N> getInverse()

Description copied from interface: MatrixDecomposition

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

Specified by:

getInverse in interface MatrixDecomposition<N extends Number>

See Also:

BasicMatrix.invert()

getQ

public final MatrixStore<N> getQ()

Specified by:

getQ in interface Tridiagonal<N extends Number>

getTransformations

public final List<Householder<N>> getTransformations()

isFullSize

public final boolean isFullSize()

Specified by:

isFullSize in interface MatrixDecomposition<N extends Number>

Returns:

True if the implementation generates a full sized decomposition.

isSolvable

public final boolean isSolvable()

Specified by:

isSolvable in interface MatrixDecomposition<N extends Number>

Returns:

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

See Also:

MatrixDecomposition.solve(MatrixStore), MatrixDecomposition.isComputed()

reconstruct

public MatrixStore<N> reconstruct()

Specified by:

reconstruct in interface MatrixDecomposition<N extends Number>

solve

public final MatrixStore<N> solve(MatrixStore<N> aRHS)

Specified by:

solve in interface MatrixDecomposition<N extends Number>

reset

public void reset()

Description copied from interface: MatrixDecomposition

Delete computed results, and resets attributes to default values

Specified by:

reset in interface MatrixDecomposition<N extends Number>

equals

public final boolean equals(MatrixDecomposition<N> aDecomp,
                            NumberContext aCntxt)

Specified by:

equals in interface MatrixDecomposition<N extends Number>

equals

public boolean equals(Object someObj)

Overrides:

equals in class Object

invert

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

Description copied from interface: MatrixDecomposition

A convenience method that produces exactly the same result as if you first call MatrixDecomposition.compute(MatrixStore) and then MatrixDecomposition.getInverse().

Specified by:

invert in interface MatrixDecomposition<N extends Number>

isAspectRatioNormal

public final boolean isAspectRatioNormal()

isComputed

public final boolean isComputed()

Specified by:

isComputed in interface MatrixDecomposition<N extends Number>

Returns:

true if computation has been attemped; false if not.

See Also:

MatrixDecomposition.compute(MatrixStore), MatrixDecomposition.isSolvable()

solve

public Future<DecomposeAndSolve<N>> solve(MatrixStore<N> aBody,
                                          MatrixStore<N> aRHS)

Description copied from interface: MatrixDecomposition

Will solve [aBody][X]=[aRHS] concurrently by first calling MatrixDecomposition.compute(MatrixStore) using [aBody], and then MatrixDecomposition.solve(MatrixStore) using [aRHS]. If either of the input [aBody] or [aRHS] is set to null the corresponing calculation is skipped.

Specified by:

solve in interface MatrixDecomposition<N extends Number>

Parameters:

aBody - The equation system body

aRHS - The equation system right hand side

Returns:

The matrix decomposition and the equation system solution, [X]