org.ejml.alg.block.decomposition.chol

Class BlockCholeskyOuterForm

java.lang.Object

org.ejml.alg.block.decomposition.chol.BlockCholeskyOuterForm

All Implemented Interfaces:

CholeskyDecomposition<BlockMatrix64F>, DecompositionInterface<BlockMatrix64F>

public class BlockCholeskyOuterForm
extends Object
implements CholeskyDecomposition<BlockMatrix64F>

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.

Author:

Peter Abeles

Constructor Summary

Constructors

Constructor and Description
BlockCholeskyOuterForm(boolean lower) Creates a new BlockCholeskyOuterForm

Method Summary

Methods

Modifier and Type	Method and Description
boolean	decompose(BlockMatrix64F A) Decomposes the provided matrix and stores the result in the same matrix.
BlockMatrix64F	getT(BlockMatrix64F T) Returns the triangular matrix from the decomposition.
boolean	inputModified() Is the input matrix to DecompositionInterface.decompose(org.ejml.data.Matrix64F) 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 Detail

BlockCholeskyOuterForm

public BlockCholeskyOuterForm(boolean lower)

Creates a new BlockCholeskyOuterForm

Parameters:

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

Method Detail

decompose

public boolean decompose(BlockMatrix64F A)

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

Specified by:

decompose in interface DecompositionInterface<BlockMatrix64F>

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

Returns:

True if lower, false if upper.

getT

public BlockMatrix64F getT(BlockMatrix64F 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<BlockMatrix64F>

Parameters:

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

Returns:

A lower or upper triangular matrix.

inputModified

public boolean inputModified()

Description copied from interface: DecompositionInterface

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

Specified by:

inputModified in interface DecompositionInterface<BlockMatrix64F>

Returns:

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