diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2011-11-28 16:36:37 +0100 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2011-11-28 16:36:37 +0100 |
| commit | cda397b11775000a7b6da375728ebb851ebec232 (patch) | |
| tree | 3faea217a46402c4ecda059ea4db4f83ea44ef2f /Eigen/src/CholmodSupport | |
| parent | 2d621d235d67f8cab4f6a77ada9db0087bc82234 (diff) | |
cleanning pass on the sparse modules:
- remove outdated/deprecated code
- improve a bit the documentation
Diffstat (limited to 'Eigen/src/CholmodSupport')
| -rw-r--r-- | Eigen/src/CholmodSupport/CholmodSupport.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Eigen/src/CholmodSupport/CholmodSupport.h b/Eigen/src/CholmodSupport/CholmodSupport.h index 3e502c0aa..c7cf3ad63 100644 --- a/Eigen/src/CholmodSupport/CholmodSupport.h +++ b/Eigen/src/CholmodSupport/CholmodSupport.h @@ -149,7 +149,9 @@ enum CholmodMode { CholmodAuto, CholmodSimplicialLLt, CholmodSupernodalLLt, CholmodLDLt }; -/** \brief A Cholesky factorization and solver based on Cholmod +/** \ingroup CholmodSupport_Module + * \class CholmodDecomposition + * \brief A Cholesky factorization and solver based on Cholmod * * This class allows to solve for A.X = B sparse linear problems via a LL^T or LDL^T Cholesky factorization * using the Cholmod library. The sparse matrix A must be selfajoint and positive definite. The vectors or matrices @@ -159,6 +161,7 @@ enum CholmodMode { * \tparam _UpLo the triangular part that will be used for the computations. It can be Lower * or Upper. Default is Lower. * + * \sa TutorialSparseDirectSolvers */ template<typename _MatrixType, int _UpLo = Lower> class CholmodDecomposition |