diff options
Diffstat (limited to 'Eigen/CholmodSupport')
| -rw-r--r-- | Eigen/CholmodSupport | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Eigen/CholmodSupport b/Eigen/CholmodSupport index f26aaf64e..0e1ff48e0 100644 --- a/Eigen/CholmodSupport +++ b/Eigen/CholmodSupport @@ -12,6 +12,16 @@ extern "C" { /** \ingroup Support_modules * \defgroup CholmodSupport_Module CholmodSupport module * + * This module provides an interface to the Cholmod library which is part of the <a href="http://www.cise.ufl.edu/research/sparse/SuiteSparse/">suitesparse</a> package. + * It provides the two following main factorization classes: + * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization. + * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial). + * + * For the sake of completeness, this module also propose the two following classes: + * - class CholmodSimplicialLLT + * - class CholmodSimplicialLDLT + * Note that these classes does not bring any particular advantage compared to the built-in + * SimplicialLLT and SimplicialLDLT factorization classes. * * \code * #include <Eigen/CholmodSupport> |