org.ojalgo.matrix.decomposition

Class TridiagonalDecomposition<N extends java.lang.Number>

java.lang.Object

org.ojalgo.matrix.decomposition.TridiagonalDecomposition<N>

All Implemented Interfaces:

MatrixDecomposition<N>, Tridiagonal<N>, InverterTask<N>, MatrixTask<N>, SolverTask<N>

Deprecated.

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

@Deprecated
public abstract class TridiagonalDecomposition<N extends java.lang.Number>
extends java.lang.Object
implements Tridiagonal<N>

Author:

apete

Nested Class Summary

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

InverterTask.Factory<N extends java.lang.Number>

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

SolverTask.Factory<N extends java.lang.Number>

Field Summary

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

BIG, COMPLEX, PRIMITIVE

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

BIG, COMPLEX, PRIMITIVE

Method Summary

Modifier and Type	Method and Description
boolean	compute(Access2D<?> matrix) Deprecated.
boolean	equals(MatrixStore<N> aStore, NumberContext context) Deprecated.
boolean	equals(java.lang.Object someObj)
MatrixStore<N>	getD() Deprecated.
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() Deprecated.
MatrixStore<N>	invert(MatrixStore<N> original) The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	invert(MatrixStore<N> original, DecompositionStore<N> preallocated) Implementiong this method is optional.
boolean	isComputed()
boolean	isFullSize() Deprecated.
boolean	isSolvable() Deprecated.
static <N extends java.lang.Number> Tridiagonal<N>	make(Access2D<N> aTypical) Deprecated. v38 Use Tridiagonal.make(Access2D) instead
static Tridiagonal<java.math.BigDecimal>	makeBig() Deprecated. v38 Use Tridiagonal.makeBig() instead
static Tridiagonal<ComplexNumber>	makeComplex() Deprecated. v38 Use Tridiagonal.makeComplex() instead
static Tridiagonal<java.lang.Double>	makePrimitive() Deprecated. v38 Use Tridiagonal.makePrimitive() instead
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.
void	reset() Deprecated. Delete computed results, and resets attributes to default values
MatrixStore<N>	solve(Access2D<N> rhs) [A][X]=[B] or [this][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs) [A][X]=[B] or [body][return]=[rhs]
MatrixStore<N>	solve(Access2D<N> body, Access2D<N> rhs, DecompositionStore<N> preallocated) Implementiong this method is optional.
MatrixStore<N>	solve(Access2D<N> rhs, DecompositionStore<N> preallocated) Deprecated. 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.Tridiagonal

reconstruct

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

equals, getInverse, getInverse, 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

make

@Deprecated
public static final <N extends java.lang.Number> Tridiagonal<N> make(Access2D<N> aTypical)

Deprecated. v38 Use Tridiagonal.make(Access2D) instead

Specified by:

make in interface Tridiagonal<N extends java.lang.Number>

makeBig

@Deprecated
public static final Tridiagonal<java.math.BigDecimal> makeBig()

Deprecated. v38 Use Tridiagonal.makeBig() instead

Specified by:

makeBig in interface Tridiagonal<N extends java.lang.Number>

makeComplex

@Deprecated
public static final Tridiagonal<ComplexNumber> makeComplex()

Deprecated. v38 Use Tridiagonal.makeComplex() instead

Specified by:

makeComplex in interface Tridiagonal<N extends java.lang.Number>

makePrimitive

@Deprecated
public static final Tridiagonal<java.lang.Double> makePrimitive()

Deprecated. v38 Use Tridiagonal.makePrimitive() instead

Specified by:

makePrimitive in interface Tridiagonal<N extends java.lang.Number>

compute

public final boolean compute(Access2D<?> matrix)

Deprecated.

Specified by:

compute in interface MatrixDecomposition<N extends java.lang.Number>

Parameters:

matrix - A matrix to decompose

Returns:

true if the computation suceeded; false if not

equals

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

Deprecated.

Specified by:

equals in interface MatrixDecomposition<N extends java.lang.Number>

getD

public final MatrixStore<N> getD()

Deprecated.

Specified by:

getD in interface Tridiagonal<N extends java.lang.Number>

getQ

public final MatrixStore<N> getQ()

Deprecated.

Specified by:

getQ in interface Tridiagonal<N extends java.lang.Number>

isFullSize

public final boolean isFullSize()

Deprecated.

Specified by:

isFullSize in interface MatrixDecomposition<N extends java.lang.Number>

Returns:

True if the implementation generates a full sized decomposition.

isSolvable

public final boolean isSolvable()

Deprecated.

Specified by:

isSolvable in interface MatrixDecomposition<N extends java.lang.Number>

Returns:

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

See Also:

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

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<N extends java.lang.Number>

solve

public MatrixStore<N> solve(Access2D<N> rhs,
                            DecompositionStore<N> preallocated)

Deprecated.

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

Specified by:

solve in interface MatrixDecomposition<N extends java.lang.Number>

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

getInverse

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

solve

public final MatrixStore<N> solve(Access2D<N> rhs)

Description copied from interface: MatrixDecomposition

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

equals

public boolean equals(java.lang.Object someObj)

Overrides:

equals in class java.lang.Object

invert

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

Description copied from interface: SolverTask

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

solve

public final MatrixStore<N> solve(Access2D<N> body,
                                  Access2D<N> rhs,
                                  DecompositionStore<N> 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

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