org.ejml.alg.dense.decompose.lu

Class LUDecompositionBase_CD64

java.lang.Object

org.ejml.alg.dense.decompose.lu.LUDecompositionBase_CD64

All Implemented Interfaces:

DecompositionInterface<CDenseMatrix64F>, LUDecomposition<CDenseMatrix64F>

Direct Known Subclasses:

LUDecompositionAlt_CD64, LUDecompositionNR_CD64

public abstract class LUDecompositionBase_CD64
extends java.lang.Object
implements LUDecomposition<CDenseMatrix64F>

Contains common data structures and operations for LU decomposition algorithms.

Constructor Summary

Constructors

Constructor and Description
LUDecompositionBase_CD64()

Method Summary

Modifier and Type	Method and Description
double[]	_getVV()
void	_solveVectorInternal(double[] vv) a specialized version of solve that avoid additional checks that are not needed.
Complex64F	computeDeterminant() Computes the determinant from the LU decomposition.
int[]	getIndx()
CDenseMatrix64F	getLower(CDenseMatrix64F lower) Writes the lower triangular matrix into the specified matrix.
CDenseMatrix64F	getLU()
int[]	getPivot()
CDenseMatrix64F	getPivot(CDenseMatrix64F pivot) For numerical stability there are often row interchanges.
CDenseMatrix64F	getUpper(CDenseMatrix64F upper) Writes the upper triangular matrix into the specified matrix.
boolean	inputModified() Is the input matrix to DecompositionInterface.decompose(org.ejml.data.Matrix) is modified during the decomposition process.
boolean	isSingular() Determines if the decomposed matrix is singular.
double	quality()
void	setExpectedMaxSize(int numRows, int numCols)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ejml.interfaces.decomposition.DecompositionInterface

decompose

Constructor Detail

LUDecompositionBase_CD64

public LUDecompositionBase_CD64()

Method Detail

setExpectedMaxSize

public void setExpectedMaxSize(int numRows,
                               int numCols)

getLU

public CDenseMatrix64F getLU()

getIndx

public int[] getIndx()

getPivot

public int[] getPivot()

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.

getLower

public CDenseMatrix64F getLower(CDenseMatrix64F lower)

Writes the lower triangular matrix into the specified matrix.

Specified by:

getLower in interface LUDecomposition<CDenseMatrix64F>

Parameters:

lower - Where the lower triangular matrix is written to.

Returns:

The L matrix.

getUpper

public CDenseMatrix64F getUpper(CDenseMatrix64F upper)

Writes the upper triangular matrix into the specified matrix.

Specified by:

getUpper in interface LUDecomposition<CDenseMatrix64F>

Parameters:

upper - Where the upper triangular matrix is writen to.

Returns:

The U matrix.

getPivot

public CDenseMatrix64F getPivot(CDenseMatrix64F pivot)

Description copied from interface: LUDecomposition

For numerical stability there are often row interchanges. This computes a pivot matrix that will undo those changes.

Specified by:

getPivot in interface LUDecomposition<CDenseMatrix64F>

Parameters:

pivot - Storage for the pivot matrix. If null then a new matrix is returned. Modified.

Returns:

The pivot matrix.

isSingular

public boolean isSingular()

Determines if the decomposed matrix is singular. This function can return false and the matrix be almost singular, which is still bad.

Specified by:

isSingular in interface LUDecomposition<CDenseMatrix64F>

Returns:

true if singular false otherwise.

computeDeterminant

public Complex64F computeDeterminant()

Computes the determinant from the LU decomposition.

Specified by:

computeDeterminant in interface LUDecomposition<CDenseMatrix64F>

Returns:

The matrix's determinant.

quality

public double quality()

_solveVectorInternal

public void _solveVectorInternal(double[] vv)

a specialized version of solve that avoid additional checks that are not needed.

_getVV

public double[] _getVV()