Sparse linear algebra » Reference » Support modules » CholmodSupport module module

Contents

This module provides an interface to the Cholmod library which is part of the suitesparse 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.
#include <Eigen/CholmodSupport>

In order to use this module, the cholmod headers must be accessible from the include paths, and your binary must be linked to the cholmod library and its dependencies. The dependencies depend on how cholmod has been compiled. For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.

Classes

template<typename _MatrixType, int _UpLo, typename Derived>
class Eigen::CholmodBase
The base class for the direct Cholesky factorization of Cholmod.
template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodDecomposition
A general Cholesky factorization and solver based on Cholmod.
template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodSimplicialLDLT
A simplicial direct Cholesky (LDLT) factorization and solver based on Cholmod.
template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodSimplicialLLT
A simplicial direct Cholesky (LLT) factorization and solver based on Cholmod.
template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodSupernodalLLT
A supernodal Cholesky (LLT) factorization and solver based on Cholmod.