Package org.ejml.dense.block.decomposition.chol

Class CholeskyOuterForm_MT_FDRB

java.lang.Object

org.ejml.dense.block.decomposition.chol.CholeskyOuterForm_MT_FDRB

All Implemented Interfaces:

CholeskyDecomposition<FMatrixRBlock>, CholeskyDecomposition_F32<FMatrixRBlock>, DecompositionInterface<FMatrixRBlock>

@Generated("org.ejml.dense.block.decomposition.chol.CholeskyOuterForm_FDRB")
public class CholeskyOuterForm_MT_FDRB
extends Object
implements CholeskyDecomposition_F32<FMatrixRBlock>

Block Cholesky using outer product form. The original matrix is stored and modified.

Based on the description provided in "Fundamentals of Matrix Computations" 2nd Ed. by David S. Watkins.

Constructor Summary

Constructors

Constructor	Description
CholeskyOuterForm_MT_FDRB(boolean lower)	Creates a new BlockCholeskyOuterForm

Method Summary

Modifier and Type	Method	Description
Complex_F32	computeDeterminant()	Computes the matrix's determinant using the decomposition.
boolean	decompose(FMatrixRBlock A)	Decomposes the provided matrix and stores the result in the same matrix.
FMatrixRBlock	getT(@Nullable FMatrixRBlock T)	Returns the triangular matrix from the decomposition.
boolean	inputModified()	Checks if 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

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

Constructor Details

CholeskyOuterForm_MT_FDRB

public CholeskyOuterForm_MT_FDRB(boolean lower)

Creates a new BlockCholeskyOuterForm

Parameters:

lower - Should it decompose it into a lower triangular matrix or not.

Method Details

decompose

public boolean decompose(FMatrixRBlock A)

Decomposes the provided matrix and stores the result in the same matrix.

Specified by:

decompose in interface DecompositionInterface<FMatrixRBlock>

Parameters:

A - Matrix that is to be decomposed. Modified.

Returns:

If it succeeded or not.

isLower

public boolean isLower()

Description copied from interface: CholeskyDecomposition

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

Returns:

True if lower, false if upper.

getT

public FMatrixRBlock getT(@Nullable
 @Nullable FMatrixRBlock 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<FMatrixRBlock>

Parameters:

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

Returns:

A lower or upper triangular matrix.

computeDeterminant

public Complex_F32 computeDeterminant()

Description copied from interface: CholeskyDecomposition_F32

Computes the matrix's determinant using the decomposition.

Specified by:

computeDeterminant in interface CholeskyDecomposition_F32<FMatrixRBlock>

Returns:

The determinant.

inputModified

public boolean inputModified()

Description copied from interface: DecompositionInterface

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

Specified by:

inputModified in interface DecompositionInterface<FMatrixRBlock>

Returns:

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