diff options
Diffstat (limited to 'Eigen/Cholesky')
| -rw-r--r-- | Eigen/Cholesky | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Eigen/Cholesky b/Eigen/Cholesky index d4b487ce7..a0d4311f9 100644 --- a/Eigen/Cholesky +++ b/Eigen/Cholesky @@ -14,6 +14,17 @@ namespace Eigen { +/** \defgroup Cholesky_Module Cholesky module + * This module provides two variants of the Cholesky decomposition for selfadjoint (hermitian) matrices. + * Those decompositions are accessible via the following MatrixBase methods: + * - MatrixBase::cholesky(), + * - MatrixBase::choleskyNoSqrt() + * + * \code + * #include <Eigen/Cholesky> + * \endcode + */ + #include "src/Cholesky/Cholesky.h" #include "src/Cholesky/CholeskyWithoutSquareRoot.h" |