• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// This Source Code Form is subject to the terms of the Mozilla
5// Public License v. 2.0. If a copy of the MPL was not distributed
6// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
7
8#ifndef EIGEN_CHOLMODSUPPORT_MODULE_H
9#define EIGEN_CHOLMODSUPPORT_MODULE_H
10
11#include "SparseCore"
12
13#include "src/Core/util/DisableStupidWarnings.h"
14
15extern "C" {
16  #include <cholmod.h>
17}
18
19/** \ingroup Support_modules
20  * \defgroup CholmodSupport_Module CholmodSupport module
21  *
22  * This module provides an interface to the Cholmod library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
23  * It provides the two following main factorization classes:
24  * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization.
25  * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial).
26  *
27  * For the sake of completeness, this module also propose the two following classes:
28  * - class CholmodSimplicialLLT
29  * - class CholmodSimplicialLDLT
30  * Note that these classes does not bring any particular advantage compared to the built-in
31  * SimplicialLLT and SimplicialLDLT factorization classes.
32  *
33  * \code
34  * #include <Eigen/CholmodSupport>
35  * \endcode
36  *
37  * 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.
38  * The dependencies depend on how cholmod has been compiled.
39  * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.
40  *
41  */
42
43#include "src/CholmodSupport/CholmodSupport.h"
44
45#include "src/Core/util/ReenableStupidWarnings.h"
46
47#endif // EIGEN_CHOLMODSUPPORT_MODULE_H
48
49