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/LLT.h | |
| parent | 32a41ee659686fe1fb76156f7a55287acf14d4bb (diff) | |
Add documentation and exemples for inplace decomposition.
Diffstat (limited to 'Eigen/src/Cholesky/LLT.h')
| -rw-r--r-- | Eigen/src/Cholesky/LLT.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h index ad163c749..bd966656d 100644 --- a/Eigen/src/Cholesky/LLT.h +++ b/Eigen/src/Cholesky/LLT.h @@ -41,6 +41,8 @@ template<typename MatrixType, int UpLo> struct LLT_Traits; * Example: \include LLT_example.cpp * Output: \verbinclude LLT_example.out * + * This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism. + * * \sa MatrixBase::llt(), SelfAdjointView::llt(), class LDLT */ /* HEY THIS DOX IS DISABLED BECAUSE THERE's A BUG EITHER HERE OR IN LDLT ABOUT THAT (OR BOTH) @@ -96,7 +98,7 @@ template<typename _MatrixType, int _UpLo> class LLT /** \brief Constructs a LDLT factorization from a given matrix * - * This overloaded constructor is provided for inplace solving when + * This overloaded constructor is provided for \link InplaceDecomposition inplace decomposition \endlink when * \c MatrixType is a Eigen::Ref. * * \sa LLT(const EigenBase&) |