diff options
author | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-11-07 17:14:06 +0000 |
---|---|---|
committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-11-07 17:14:06 +0000 |
commit | 45a6bb34c3e67c865b489518767eadf747d391d7 (patch) | |
tree | 2a27bfd03741e4e261fe6244740ffc7034fd37a1 /Eigen/src/Cholesky/LLT.h | |
parent | f422668d39c51a7281e55404cfed4a262747eb51 (diff) |
Add simple example on how to compute Cholesky decomposition.
Diffstat (limited to 'Eigen/src/Cholesky/LLT.h')
-rw-r--r-- | Eigen/src/Cholesky/LLT.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h index c284e53c8..f061cbf42 100644 --- a/Eigen/src/Cholesky/LLT.h +++ b/Eigen/src/Cholesky/LLT.h @@ -29,7 +29,7 @@ namespace internal{ template<typename MatrixType, int UpLo> struct LLT_Traits; } -/** \ingroup cholesky_Module +/** \ingroup Cholesky_Module * * \class LLT * @@ -49,6 +49,9 @@ template<typename MatrixType, int UpLo> struct LLT_Traits; * use LDLT instead for the semidefinite case. Also, do not use a Cholesky decomposition to determine whether a system of equations * has a solution. * + * Example: \include LLT_example.cpp + * Output: \verbinclude LLT_example.out + * * \sa MatrixBase::llt(), class LDLT */ /* HEY THIS DOX IS DISABLED BECAUSE THERE's A BUG EITHER HERE OR IN LDLT ABOUT THAT (OR BOTH) @@ -334,8 +337,10 @@ template<typename MatrixType> struct LLT_Traits<MatrixType,Upper> /** Computes / recomputes the Cholesky decomposition A = LL^* = U^*U of \a matrix * - * * \returns a reference to *this + * + * Example: \include TutorialLinAlgComputeTwice.cpp + * Output: \verbinclude TutorialLinAlgComputeTwice.out */ template<typename MatrixType, int _UpLo> LLT<MatrixType,_UpLo>& LLT<MatrixType,_UpLo>::compute(const MatrixType& a) |