Robust Cholesky decomposition of a matrix with pivoting.
_MatrixType | the type of the matrix of which to compute the LDL^T Cholesky decomposition |
_UpLo | the triangular part that will be used for the decompositon: Lower (default) or Upper. The other triangular part won't be read. |
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 D 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.
This class supports the inplace decomposition mechanism.
const LDLT & | adjoint () const |
template<typename InputType > | |
LDLT< MatrixType, _UpLo > & | compute (const EigenBase< InputType > &a) |
ComputationInfo | info () const |
Reports whether previous computation was successful. More... |
|
bool | isNegative (void) const |
bool | isPositive () const |
LDLT () | |
Default Constructor. More... |
|
template<typename InputType > | |
LDLT (const EigenBase< InputType > &matrix) | |
Constructor with decomposition. More... |
|
template<typename InputType > | |
LDLT (EigenBase< InputType > &matrix) | |
Constructs a LDLT factorization from a given matrix. More... |
|
LDLT (Index size) | |
Default Constructor with memory preallocation. More... |
|
Traits::MatrixL | matrixL () const |
const MatrixType & | matrixLDLT () const |
Traits::MatrixU | matrixU () const |
template<typename Derived > | |
LDLT< MatrixType, _UpLo > & | rankUpdate (const MatrixBase< Derived > &w, const typename LDLT< MatrixType, _UpLo >::RealScalar &sigma) |
RealScalar | rcond () const |
MatrixType | reconstructedMatrix () const |
void | setZero () |
template<typename Rhs > | |
const Solve< LDLT, Rhs > | solve (const MatrixBase< Rhs > &b) const |
const TranspositionType & | transpositionsP () const |
Diagonal< const MatrixType > | vectorD () const |
Public Member Functions inherited from Eigen::SolverBase< LDLT< _MatrixType, _UpLo > > | |
AdjointReturnType | adjoint () const |
LDLT< _MatrixType, _UpLo > & | derived () |
const LDLT< _MatrixType, _UpLo > & | derived () const |
const Solve< LDLT< _MatrixType, _UpLo >, Rhs > | solve (const MatrixBase< Rhs > &b) const |
SolverBase () | |
ConstTransposeReturnType | transpose () const |
Public Member Functions inherited from Eigen::EigenBase< Derived > | |
EIGEN_CONSTEXPR Index | cols () const EIGEN_NOEXCEPT |
Derived & | derived () |
const Derived & | derived () const |
EIGEN_CONSTEXPR Index | rows () const EIGEN_NOEXCEPT |
EIGEN_CONSTEXPR Index | size () const EIGEN_NOEXCEPT |
Public Types inherited from Eigen::EigenBase< Derived > | |
typedef Eigen::Index | Index |
The interface type of indices. More... |
|
| inline |
Default Constructor.
The default constructor is useful in cases in which the user intends to perform decompositions via LDLT::compute(const MatrixType&).
| inlineexplicit |
Default Constructor with memory preallocation.
Like the default constructor but with preallocation of the internal data according to the specified problem size.
| inlineexplicit |
Constructor with decomposition.
This calculates the decomposition for the input matrix.
| inlineexplicit |
Constructs a LDLT factorization from a given matrix.
This overloaded constructor is provided for inplace decomposition when MatrixType
is a Eigen::Ref.
| inline |
*this
, that is, a const reference to the decomposition itself as the underlying matrix is self-adjoint.This method is provided for compatibility with other matrix decompositions, thus enabling generic code such as:
x = decomposition.adjoint().solve(b)
LDLT<MatrixType,_UpLo>& Eigen::LDLT< _MatrixType, _UpLo >::compute | ( | const EigenBase< InputType > & | a | ) |
Compute / recompute the LDLT decomposition A = L D L^* = U^* D U of matrix
| inline |
Reports whether previous computation was successful.
Success
if computation was successful, NumericalIssue
if the factorization failed because of a zero pivot.
| inline |
| inline |
| inline |
| inline |
TODO: document the storage layout
| inline |
LDLT<MatrixType,_UpLo>& Eigen::LDLT< _MatrixType, _UpLo >::rankUpdate | ( | const MatrixBase< Derived > & | w, |
const typename LDLT< MatrixType, _UpLo >::RealScalar & | sigma | ||
) |
Update the LDLT decomposition: given A = L D L^T, efficiently compute the decomposition of A + sigma w w^T.
w | a vector to be incorporated into the decomposition. |
sigma | a scalar, +1 for updates and -1 for "downdates," which correspond to removing previously-added column vectors. Optional; default value is +1. |
| inline |
*this
is the LDLT decomposition. MatrixType Eigen::LDLT< MatrixType, _UpLo >::reconstructedMatrix |
| inline |
Clear any existing decomposition
| inline |
This function also supports in-place solves using the syntax x = decompositionObject.solve(x)
.
This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this:
bool a_solution_exists = (A*result).isApprox(b, precision);
This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get inf
or nan
values.
More precisely, this method solves \( A x = b \) using the decomposition \( A = P^T L D L^* P \) by solving the systems \( P^T y_1 = b \), \( L y_2 = y_1 \), \( D y_3 = y_2 \), \( L^* y_4 = y_3 \) and \( P x = y_4 \) in succession. If the matrix \( A \) is singular, then \( D \) will also be singular (all the other matrices are invertible). In that case, the least-square solution of \( D y_3 = y_2 \) is computed. This does not mean that this function computes the least-square solution of \( A x = b \) if \( A \) is singular.
| inline |
| inline |
© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1LDLT.html