Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Protected Attributes
Eigen::LDLT Class Reference

Detailed Description

Robust Cholesky decomposition of a matrix with pivoting.

Parameters:
MatrixTypethe type of the matrix of which to compute the LDL^T Cholesky decomposition

Perform a robust Cholesky decomposition of a positive semidefinite or negative semidefinite matrix $ A $ such that $ A = P^TLDL^*P $, where P is a permutation matrix, L is lower triangular with a unit diagonal and D is a diagonal matrix.

The decomposition uses pivoting to ensure stability, so that L will have zeros in the bottom right rank(A) - n submatrix. Avoiding the square root on D also stabilizes the computation.

Remember that Cholesky decompositions are not rank-revealing. Also, do not use a Cholesky decomposition to determine whether a system of equations has a solution.

See also:
MatrixBase::ldlt(), class LLT

List of all members.

Public Types

enum  {
  RowsAtCompileTime = MatrixType::RowsAtCompileTime, ColsAtCompileTime = MatrixType::ColsAtCompileTime, Options = MatrixType::Options & ~RowMajorBit, MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime,
  MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime, UpLo = _UpLo
}
typedef _MatrixType MatrixType
typedef MatrixType::Scalar Scalar
typedef NumTraits< typename
MatrixType::Scalar >::Real 
RealScalar
typedef MatrixType::Index Index
typedef Matrix< Scalar,
RowsAtCompileTime, 1, Options,
MaxRowsAtCompileTime, 1 > 
TmpMatrixType
typedef Transpositions
< RowsAtCompileTime,
MaxRowsAtCompileTime > 
TranspositionType
typedef PermutationMatrix
< RowsAtCompileTime,
MaxRowsAtCompileTime > 
PermutationType
typedef internal::LDLT_Traits
< MatrixType, UpLo > 
Traits

Public Member Functions

 LDLT ()
 Default Constructor.
 LDLT (Index size)
 Default Constructor with memory preallocation.
 LDLT (const MatrixType &matrix)
Traits::MatrixU matrixU () const
Traits::MatrixL matrixL () const
const TranspositionTypetranspositionsP () const
Diagonal< const MatrixTypevectorD (void) const
bool isPositive (void) const
bool isNegative (void) const
template<typename Rhs >
const internal::solve_retval
< LDLT, Rhs > 
solve (const MatrixBase< Rhs > &b) const
template<typename Derived >
bool solveInPlace (MatrixBase< Derived > &bAndX) const
LDLTcompute (const MatrixType &matrix)
 Compute / recompute the LDLT decomposition A = L D L^* = U^* D U of matrix.
const MatrixTypematrixLDLT () const
MatrixType reconstructedMatrix () const
Index rows () const
Index cols () const

Protected Attributes

MatrixType m_matrix
TranspositionType m_transpositions
TmpMatrixType m_temporary
int m_sign
bool m_isInitialized

Member Typedef Documentation

typedef MatrixType::Index Eigen::LDLT::Index

Definition at line 74 of file Cholesky.

typedef _MatrixType Eigen::LDLT::MatrixType

Definition at line 63 of file Cholesky.

typedef PermutationMatrix<RowsAtCompileTime, MaxRowsAtCompileTime> Eigen::LDLT::PermutationType

Definition at line 78 of file Cholesky.

typedef NumTraits<typename MatrixType::Scalar>::Real Eigen::LDLT::RealScalar

Definition at line 73 of file Cholesky.

typedef MatrixType::Scalar Eigen::LDLT::Scalar

Definition at line 72 of file Cholesky.

typedef Matrix<Scalar, RowsAtCompileTime, 1, Options, MaxRowsAtCompileTime, 1> Eigen::LDLT::TmpMatrixType

Definition at line 75 of file Cholesky.

typedef internal::LDLT_Traits<MatrixType,UpLo> Eigen::LDLT::Traits

Definition at line 80 of file Cholesky.

typedef Transpositions<RowsAtCompileTime, MaxRowsAtCompileTime> Eigen::LDLT::TranspositionType

Definition at line 77 of file Cholesky.


Member Enumeration Documentation

anonymous enum
Enumerator:
RowsAtCompileTime 
ColsAtCompileTime 
Options 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
UpLo 

Definition at line 64 of file Cholesky.


Constructor & Destructor Documentation

Eigen::LDLT::LDLT ( ) [inline]

Default Constructor.

The default constructor is useful in cases in which the user intends to perform decompositions via LDLT::compute(const MatrixType&).

Definition at line 87 of file Cholesky.

Eigen::LDLT::LDLT ( Index  size) [inline]

Default Constructor with memory preallocation.

Like the default constructor but with preallocation of the internal data according to the specified problem size.

See also:
LDLT()

Definition at line 95 of file Cholesky.

Eigen::LDLT::LDLT ( const MatrixType matrix) [inline]

Definition at line 102 of file Cholesky.


Member Function Documentation

Index Eigen::LDLT::cols ( ) const [inline]

Definition at line 204 of file Cholesky.

LDLT< MatrixType, _UpLo > & Eigen::LDLT::compute ( const MatrixType matrix)

Compute / recompute the LDLT decomposition A = L D L^* = U^* D U of matrix.

Definition at line 345 of file Cholesky.

bool Eigen::LDLT::isNegative ( void  ) const [inline]
Returns:
true if the matrix is negative (semidefinite)

Definition at line 155 of file Cholesky.

bool Eigen::LDLT::isPositive ( void  ) const [inline]
Returns:
true if the matrix is positive (semidefinite)

Definition at line 141 of file Cholesky.

Traits::MatrixL Eigen::LDLT::matrixL ( ) const [inline]
Returns:
a view of the lower triangular matrix L

Definition at line 119 of file Cholesky.

const MatrixType& Eigen::LDLT::matrixLDLT ( ) const [inline]
Returns:
the internal LDLT decomposition matrix

TODO: document the storage layout

Definition at line 195 of file Cholesky.

Traits::MatrixU Eigen::LDLT::matrixU ( ) const [inline]
Returns:
a view of the upper triangular matrix U

Definition at line 112 of file Cholesky.

MatrixType Eigen::LDLT::reconstructedMatrix ( ) const
Returns:
the matrix represented by the decomposition, i.e., it returns the product: P^T L D L^* P. This function is provided for debug purpose.

Definition at line 421 of file Cholesky.

Index Eigen::LDLT::rows ( ) const [inline]

Definition at line 203 of file Cholesky.

template<typename Rhs >
const internal::solve_retval<LDLT, Rhs> Eigen::LDLT::solve ( const MatrixBase< Rhs > &  b) const [inline]
Returns:
a solution x of $ A x = b $ using the current decomposition of A.
See also:
solveInPlace(), MatrixBase::ldlt()

Definition at line 169 of file Cholesky.

template<typename Derived >
bool Eigen::LDLT::solveInPlace ( MatrixBase< Derived > &  bAndX) const

Definition at line 406 of file Cholesky.

const TranspositionType& Eigen::LDLT::transpositionsP ( ) const [inline]
Returns:
the permutation matrix P as a transposition sequence.

Definition at line 127 of file Cholesky.

Diagonal<const MatrixType> Eigen::LDLT::vectorD ( void  ) const [inline]
Returns:
the coefficients of the diagonal matrix D

Definition at line 134 of file Cholesky.


Member Data Documentation

bool Eigen::LDLT::m_isInitialized [protected]

Definition at line 218 of file Cholesky.

Definition at line 214 of file Cholesky.

int Eigen::LDLT::m_sign [protected]

Definition at line 217 of file Cholesky.

Definition at line 216 of file Cholesky.

Definition at line 215 of file Cholesky.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011