From cda397b11775000a7b6da375728ebb851ebec232 Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Mon, 28 Nov 2011 16:36:37 +0100 Subject: cleanning pass on the sparse modules: - remove outdated/deprecated code - improve a bit the documentation --- Eigen/src/CholmodSupport/CholmodSupport.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'Eigen/src/CholmodSupport') 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 class CholmodDecomposition -- cgit v1.2.3