QR Class Template Reference
[QR module]

List of all members.


Detailed Description

template<typename MatrixType>
class Eigen::QR< MatrixType >

QR decomposition of a matrix.

Warning:
This is not considered to be part of the stable public API yet. Changes may happen in future releases. See Experimental parts of Eigen
Parameters:
MatrixType the type of the matrix of which we are computing the QR decomposition
This class performs a QR decomposition using Householder transformations. The result is stored in a compact way compatible with LAPACK.

See also:
MatrixBase::qr()

Public Types

typedef Block< MatrixType,
MatrixType::ColsAtCompileTime,
MatrixType::ColsAtCompileTime > 
MatrixRBlockType
typedef Matrix< Scalar,
MatrixType::ColsAtCompileTime,
MatrixType::ColsAtCompileTime > 
MatrixTypeR
typedef MatrixType::RealScalar RealScalar
typedef MatrixType::Scalar Scalar
typedef Matrix< Scalar,
MatrixType::ColsAtCompileTime, 1 > 
VectorType

Public Member Functions

bool isFullRank () const
MatrixType matrixQ (void) const
const Part< NestByValue
< MatrixRBlockType >
, UpperTriangular > 
matrixR (void) const
 QR (const MatrixType &matrix)
int rank () const

Protected Attributes

VectorType m_hCoeffs
MatrixType m_qr
int m_rank
bool m_rankIsUptodate

Member Function Documentation

bool isFullRank (  )  const [inline]

Returns:
whether or not the matrix is of full rank

MatrixType matrixQ ( void   )  const [inline]

Returns:
the matrix Q

const Part<NestByValue<MatrixRBlockType>, UpperTriangular> matrixR ( void   )  const [inline]

Returns:
a read-only expression of the matrix R of the actual the QR decomposition

int rank (  )  const [inline]

Returns:
the rank of the matrix of which *this is the QR decomposition.


The documentation for this class was generated from the following file:

Generated on Thu Apr 9 10:10:02 2009 for Eigen by  doxygen 1.5.5