org.ejml.factory

Class CDecompositionFactory

java.lang.Object

org.ejml.factory.CDecompositionFactory

public class CDecompositionFactory
extends java.lang.Object

Contains operations related to creating and evaluating the quality of common matrix decompositions. Except in specialized situations, matrix decompositions should be instantiated from this factory instead of being directly constructed. Low level implementations are more prone to changes and new algorithms will be automatically placed here.

Constructor Summary

Constructors

Constructor and Description
CDecompositionFactory()

Method Summary

Modifier and Type	Method and Description
static CholeskyDecomposition<CDenseMatrix64F>	chol(int size, boolean lower) Returns a CholeskyDecomposition that has been optimized for the specified matrix size.
static boolean	decomposeSafe(DecompositionInterface<CDenseMatrix64F> decomposition, CDenseMatrix64F a) Decomposes the input matrix 'a' and makes sure it isn't modified.
static LUDecomposition<CDenseMatrix64F>	lu(int numRows, int numCols) Returns a LUDecomposition that has been optimized for the specified matrix size.
static QRDecomposition<CDenseMatrix64F>	qr(int numRows, int numCols) Returns a QRDecomposition that has been optimized for the specified matrix size.

Methods inherited from class java.lang.Object

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

Constructor Detail

CDecompositionFactory

public CDecompositionFactory()

Method Detail

lu

public static LUDecomposition<CDenseMatrix64F> lu(int numRows,
                                                  int numCols)

Returns a LUDecomposition that has been optimized for the specified matrix size.

Parameters:

numRows - Number of rows the returned decomposition is optimized for.

numCols - Number of columns that the returned decomposition is optimized for.

Returns:

LUDecomposition

qr

public static QRDecomposition<CDenseMatrix64F> qr(int numRows,
                                                  int numCols)

Returns a QRDecomposition that has been optimized for the specified matrix size.

Parameters:

numRows - Number of rows the returned decomposition is optimized for.

numCols - Number of columns that the returned decomposition is optimized for.

Returns:

QRDecomposition

chol

public static CholeskyDecomposition<CDenseMatrix64F> chol(int size,
                                                          boolean lower)

Returns a CholeskyDecomposition that has been optimized for the specified matrix size.

Parameters:

size - Number of rows and columns it should be optimized for

lower - if true then it will be a lower cholesky. false for upper. Try lower.

Returns:

QRDecomposition

decomposeSafe

public static boolean decomposeSafe(DecompositionInterface<CDenseMatrix64F> decomposition,
                                    CDenseMatrix64F a)

Decomposes the input matrix 'a' and makes sure it isn't modified.