diff options
author | Gael Guennebaud <g.gael@free.fr> | 2016-07-04 17:18:26 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2016-07-04 17:18:26 +0200 |
commit | 7f7839c12f9bbd88bee1f3c9d7f5dbbe556045d4 (patch) | |
tree | c589e0a09d130b532c8a6e374aa1ea657283ebf2 /Eigen/src/Cholesky/LDLT.h | |
parent | 32a41ee659686fe1fb76156f7a55287acf14d4bb (diff) |
Add documentation and exemples for inplace decomposition.
Diffstat (limited to 'Eigen/src/Cholesky/LDLT.h')
-rw-r--r-- | Eigen/src/Cholesky/LDLT.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/Cholesky/LDLT.h b/Eigen/src/Cholesky/LDLT.h index a31b3d6aa..69e176110 100644 --- a/Eigen/src/Cholesky/LDLT.h +++ b/Eigen/src/Cholesky/LDLT.h @@ -43,6 +43,8 @@ namespace internal { * 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 \link InplaceDecomposition inplace decomposition \endlink mechanism. + * * \sa MatrixBase::ldlt(), SelfAdjointView::ldlt(), class LLT */ template<typename _MatrixType, int _UpLo> class LDLT @@ -112,7 +114,7 @@ template<typename _MatrixType, int _UpLo> class LDLT /** \brief Constructs a LDLT factorization from a given matrix * - * This overloaded constructor is provided for inplace solving when \c MatrixType is a Eigen::Ref. + * This overloaded constructor is provided for \link InplaceDecomposition inplace decomposition \endlink when \c MatrixType is a Eigen::Ref. * * \sa LDLT(const EigenBase&) */ |