org.ejml.alg.dense.decomposition.qr

Class QRDecompositionBlock64

java.lang.Object

org.ejml.alg.dense.decomposition.BaseDecompositionBlock64

org.ejml.alg.dense.decomposition.qr.QRDecompositionBlock64

All Implemented Interfaces:

DecompositionInterface<DenseMatrix64F>, QRDecomposition<DenseMatrix64F>

public class QRDecompositionBlock64
extends BaseDecompositionBlock64
implements QRDecomposition<DenseMatrix64F>

Wrapper that allows QRDecomposition(BlockMatrix64F) to be used as a QRDecomposition(DenseMatrix64F).

Author:

Peter Abeles

Field Summary

Fields inherited from class org.ejml.alg.dense.decomposition.BaseDecompositionBlock64

Ablock, alg, blockLength, tmp

Constructor Summary

Constructors

Constructor and Description
QRDecompositionBlock64()

Method Summary

Methods

Modifier and Type	Method and Description
DenseMatrix64F	getQ(DenseMatrix64F Q, boolean compact) Returns the Q matrix from the decomposition.
DenseMatrix64F	getR(DenseMatrix64F R, boolean compact) Returns the R matrix from the decomposition.

Methods inherited from class org.ejml.alg.dense.decomposition.BaseDecompositionBlock64

convertBlockToRow, decompose, inputModified

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ejml.factory.DecompositionInterface

decompose, inputModified

Constructor Detail

QRDecompositionBlock64

public QRDecompositionBlock64()

Method Detail

getQ

public DenseMatrix64F getQ(DenseMatrix64F Q,
                  boolean compact)

Description copied from interface: QRDecomposition

Returns the Q matrix from the decomposition. Should only be called after DecompositionInterface.decompose(org.ejml.data.Matrix64F) has been called.

If parameter Q is not null, then that matrix is used to store the Q matrix. Otherwise a new matrix is created.

Specified by:

getQ in interface QRDecomposition<DenseMatrix64F>

Parameters:

Q - If not null then the Q matrix is written to it. Modified.

compact - If true an m by n matrix is created, otherwise n by n.

Returns:

The Q matrix.

getR

public DenseMatrix64F getR(DenseMatrix64F R,
                  boolean compact)

Description copied from interface: QRDecomposition

Returns the R matrix from the decomposition. Should only be called after DecompositionInterface.decompose(org.ejml.data.Matrix64F) has been.

If setZeros is true then an n × m matrix is required and all the elements are set. If setZeros is false then the matrix must be at least m × m and only the upper triangular elements are set.

If parameter R is not null, then that matrix is used to store the R matrix. Otherwise a new matrix is created.

Specified by:

getR in interface QRDecomposition<DenseMatrix64F>

Parameters:

R - If not null then the R matrix is written to it. Modified.

compact - If true only the upper triangular elements are set

Returns:

The R matrix.