org.ojalgo.matrix.decomposition

Class CholeskyDecomposition<N extends java.lang.Number>

java.lang.Object

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

All Implemented Interfaces:

Cholesky<N>, HermitianDecomposition<N>, LDU<N>, MatrixDecomposition<N>, DeterminantTask<N>, InverterTask<N>, MatrixTask<N>, SolverTask<N>

Deprecated.

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

@Deprecated
public abstract class CholeskyDecomposition<N extends java.lang.Number>
extends java.lang.Object
implements Cholesky<N>

Author:

apete

Nested Class Summary

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.DeterminantTask

BIG, COMPLEX, PRIMITIVE

Method Summary

Modifier and Type	Method and Description
boolean	compute(Access2D<?> aStore) Deprecated.
boolean	compute(Access2D<?> matrix, boolean checkHermitian) Deprecated.
boolean	equals(MatrixStore<N> aStore, NumberContext context) Deprecated.
boolean	equals(java.lang.Object someObj)
N	getDeterminant() Deprecated.
MatrixStore<N>	getInverse() The output must be a "right inverse" and a "generalised inverse".
MatrixStore<N>	getInverse(DecompositionStore<N> preallocated) Deprecated. Implementiong this method is optional.
MatrixStore<N>	getL() Deprecated. Must implement either Cholesky.getL() or Cholesky.getR().
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.
boolean	isSPD() Deprecated. To use the Cholesky decomposition rather than the LU decomposition the matrix must be symmetric and positive definite.
static <N extends java.lang.Number> Cholesky<N>	make(Access2D<N> aTypical) Deprecated. v38 Use Cholesky.make(Access2D) instead
static Cholesky<java.math.BigDecimal>	makeBig() Deprecated. v38 Use Cholesky.makeBig() instead
static Cholesky<ComplexNumber>	makeComplex() Deprecated. v38 Use Cholesky.makeComplex() instead
static Cholesky<java.lang.Double>	makeJama() Deprecated. v38 Use Cholesky.makePrimitive() instead
static Cholesky<java.lang.Double>	makePrimitive() Deprecated. v38 Use Cholesky.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. Solves [this][X] = [aRHS] by first solving

Methods inherited from class java.lang.Object

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

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

getR, reconstruct

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

calculateDeterminant

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

checkAndCompute

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

equals, 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> Cholesky<N> make(Access2D<N> aTypical)

Deprecated. v38 Use Cholesky.make(Access2D) instead

Specified by:

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

makeBig

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

Deprecated. v38 Use Cholesky.makeBig() instead

Specified by:

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

makeComplex

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

Deprecated. v38 Use Cholesky.makeComplex() instead

Specified by:

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

makeJama

@Deprecated
public static final Cholesky<java.lang.Double> makeJama()

Deprecated. v38 Use Cholesky.makePrimitive() instead

makePrimitive

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

Deprecated. v38 Use Cholesky.makePrimitive() instead

Specified by:

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

compute

public final boolean compute(Access2D<?> aStore)

Deprecated.

Specified by:

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

Parameters:

aStore - A matrix to decompose

Returns:

true if the computation suceeded; false if not

compute

public final boolean compute(Access2D<?> matrix,
                             boolean checkHermitian)

Deprecated.

Specified by:

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

equals

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

Deprecated.

Specified by:

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

getDeterminant

public N getDeterminant()

Deprecated.

Specified by:

getDeterminant in interface LDU<N extends java.lang.Number>

getInverse

public final MatrixStore<N> getInverse(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.getInverse().

Specified by:

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

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

getL

public MatrixStore<N> getL()

Deprecated.

Description copied from interface: Cholesky

Must implement either Cholesky.getL() or Cholesky.getR().

Specified by:

getL in interface Cholesky<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 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()

isSPD

public boolean isSPD()

Deprecated.

Description copied from interface: Cholesky

To use the Cholesky decomposition rather than the LU decomposition the matrix must be symmetric and positive definite. It is recommended that the decomposition algorithm checks for this during calculation. Possibly the matrix could be assumed to be symmetric (to improve performance) but tests should be made to assure the matrix is positive definite.

Specified by:

isSPD in interface Cholesky<N extends java.lang.Number>

Returns:

true if the tests did not fail.

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

Deprecated.

Solves [this][X] = [aRHS] by first solving

 [L][Y] = [RHS]
 

and then

 [U][X] = [Y]
 

.

Specified by:

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

Parameters:

rhs - The right hand side

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:

[X] The solution will be written to "preallocated" and then returned.

See Also:

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

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

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