org.ejml.alg.dense.decompose.chol

Class CholeskyDecompositionCommon_CD64

java.lang.Object

org.ejml.alg.dense.decompose.chol.CholeskyDecompositionCommon_CD64

All Implemented Interfaces:

CholeskyDecomposition<CDenseMatrix64F>, DecompositionInterface<CDenseMatrix64F>

Direct Known Subclasses:

CholeskyDecompositionInner_CD64

public abstract class CholeskyDecompositionCommon_CD64
extends java.lang.Object
implements CholeskyDecomposition<CDenseMatrix64F>

This is an abstract class for a Cholesky decomposition. It provides the solvers, but the actual decomposition is provided in other classes.

See Also:

CholeskyDecomposition

Constructor Summary

Constructors

Constructor and Description
CholeskyDecompositionCommon_CD64(boolean lower) Specifies if a lower or upper variant should be constructed.

Method Summary

Modifier and Type	Method and Description
CDenseMatrix64F	_getT() Returns the raw decomposed matrix.
Complex64F	computeDeterminant() Computes the matrix's determinant using the decomposition.
boolean	decompose(CDenseMatrix64F mat) Computes the decomposition of the input matrix.
CDenseMatrix64F	getT(CDenseMatrix64F T) Returns the triangular matrix from the decomposition.
boolean	inputModified() Is the input matrix to DecompositionInterface.decompose(org.ejml.data.Matrix) is modified during the decomposition process.
boolean	isLower() If true the decomposition was for a lower triangular matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

CholeskyDecompositionCommon_CD64

public CholeskyDecompositionCommon_CD64(boolean lower)

Specifies if a lower or upper variant should be constructed.

Parameters:

lower - should a lower or upper triangular matrix be used.

Method Detail

isLower

public boolean isLower()

If true the decomposition was for a lower triangular matrix. If false it was for an upper triangular matrix.

Specified by:

isLower in interface CholeskyDecomposition<CDenseMatrix64F>

Returns:

True if lower, false if upper.

decompose

public boolean decompose(CDenseMatrix64F mat)

Computes the decomposition of the input matrix. Depending on the implementation the input matrix might be stored internally or modified. If it is modified then the function DecompositionInterface.inputModified() will return true and the matrix should not be modified until the decomposition is no longer needed.

Specified by:

decompose in interface DecompositionInterface<CDenseMatrix64F>

Parameters:

mat - The matrix which is being decomposed. Modification is implementation dependent.

Returns:

Returns if it was able to decompose the matrix.

inputModified

public boolean inputModified()

Description copied from interface: DecompositionInterface

Is the input matrix to DecompositionInterface.decompose(org.ejml.data.Matrix) is modified during the decomposition process.

Specified by:

inputModified in interface DecompositionInterface<CDenseMatrix64F>

Returns:

true if the input matrix to decompose() is modified.

getT

public CDenseMatrix64F getT(CDenseMatrix64F T)

Description copied from interface: CholeskyDecomposition

Returns the triangular matrix from the decomposition.

If an input is provided that matrix is used to write the results to. Otherwise a new matrix is created and the results written to it.

Specified by:

getT in interface CholeskyDecomposition<CDenseMatrix64F>

Parameters:

T - If not null then the decomposed matrix is written here.

Returns:

A lower or upper triangular matrix.

_getT

public CDenseMatrix64F _getT()

Returns the raw decomposed matrix.

Returns:

A lower or upper triangular matrix.

computeDeterminant

public Complex64F computeDeterminant()

Description copied from interface: CholeskyDecomposition

Computes the matrix's determinant using the decomposition.

Specified by:

computeDeterminant in interface CholeskyDecomposition<CDenseMatrix64F>

Returns:

The determinant.