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

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

All Implemented Interfaces:

MatrixDecomposition<N>, Schur<N>

public abstract class SchurDecomposition<N extends Number>
extends Object
implements Schur<N>

You create instances of (some subclass of) this class by calling the static factory method makePrimitive().

Author:

apete

Nested Class Summary

static class

SchurDecomposition.SchurResult<N extends Number>

Method Summary

boolean	compute(Access2D<?> aMtrx)
boolean	equals(MatrixDecomposition<N> aDecomp, NumberContext aCntxt)
boolean	equals(MatrixStore<N> aMtrx, NumberContext aCntxt)
boolean	equals(Object someObj)
Array1D<ComplexNumber>	getDiagonal()
MatrixStore<N>	getInverse() The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	getInverse(DecompositionStore<N> preallocated) Implementiong this method is optional.
MatrixStore<N>	getQ()
MatrixStore<N>	getU()
boolean	isAspectRatioNormal()
boolean	isComputed()
boolean	isFullSize()
boolean	isOrdered()
boolean	isSolvable()
static <N extends Number> Schur<N>	make(Access2D<N> aTypical)
static Schur<Double>	makePrimitive()
MatrixStore<N>	reconstruct()
void	reset() Delete computed results, and resets attributes to default values
MatrixStore<N>	solve(MatrixStore<N> aRHS) [A][X]=[B] or [this][return]=[aRHS]
MatrixStore<N>	solve(MatrixStore<N> aRHS, DecompositionStore<N> preallocated) 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.MatrixDecomposition

equals, getInverse, getInverse, isComputed, solve, solve

Method Detail

make

public static final <N extends Number> Schur<N> make(Access2D<N> aTypical)

makePrimitive

public static final Schur<Double> makePrimitive()

compute

public boolean compute(Access2D<?> 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(MatrixStore<N> aMtrx,
                      NumberContext aCntxt)

Specified by:

equals in interface MatrixDecomposition<N extends Number>

getDiagonal

public Array1D<ComplexNumber> getDiagonal()

Specified by:

getDiagonal in interface Schur<N extends Number>

getQ

public MatrixStore<N> getQ()

Specified by:

getQ in interface Schur<N extends Number>

getU

public MatrixStore<N> getU()

Specified by:

getU in interface Schur<N extends Number>

isFullSize

public boolean isFullSize()

Specified by:

isFullSize in interface MatrixDecomposition<N extends Number>

Returns:

True if the implementation generates a full sized decomposition.

isOrdered

public boolean isOrdered()

Specified by:

isOrdered in interface Schur<N extends Number>

isSolvable

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

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>

getInverse

public MatrixStore<N> getInverse()

Description copied from interface: MatrixDecomposition

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

See Also:

BasicMatrix.invert()

getInverse

public MatrixStore<N> getInverse(DecompositionStore<N> preallocated)

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

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

solve

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

Description copied from interface: MatrixDecomposition

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

solve

public MatrixStore<N> solve(MatrixStore<N> aRHS,
                            DecompositionStore<N> preallocated)

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

Parameters:

aRHS - 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 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

isAspectRatioNormal

public 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(Access2D), MatrixDecomposition.isSolvable()