diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2017-08-22 12:04:09 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2017-08-22 12:04:09 +0200 |
| commit | 2c3d70d915a939d0da33ca22742a26c271adcb82 (patch) | |
| tree | c6b20dba2c91199d02a451c03027b611d7247114 /Eigen/src/Cholesky | |
| parent | a6e7a41a553d3663cefc45a5d2b509494d8adb37 (diff) | |
Re-enable hidden doc in LLT
Diffstat (limited to 'Eigen/src/Cholesky')
| -rw-r--r-- | Eigen/src/Cholesky/LLT.h | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h index 3b0b9faf4..3de94f726 100644 --- a/Eigen/src/Cholesky/LLT.h +++ b/Eigen/src/Cholesky/LLT.h @@ -24,7 +24,7 @@ template<typename MatrixType, int UpLo> struct LLT_Traits; * * \tparam _MatrixType the type of the matrix of which we are computing the LL^T Cholesky decomposition * \tparam _UpLo the triangular part that will be used for the decompositon: Lower (default) or Upper. - * The other triangular part won't be read. + * The other triangular part won't be read. * * This class performs a LL^T Cholesky decomposition of a symmetric, positive definite * matrix A such that A = LL^* = U^*U, where L is lower triangular. @@ -43,12 +43,11 @@ template<typename MatrixType, int UpLo> struct LLT_Traits; * * This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism. * + * Note that during the decomposition, only the lower (or upper, as defined by _UpLo) triangular part of A is considered. + * Therefore, the strict lower part does not have to store correct values. + * * \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) - * Note that during the decomposition, only the upper triangular part of A is considered. Therefore, - * the strict lower part does not have to store correct values. - */ template<typename _MatrixType, int _UpLo> class LLT { public: |