• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2013 Gael Guennebaud <gael.guennebaud@inria.fr>
5//
6// This Source Code Form is subject to the terms of the Mozilla
7// Public License v. 2.0. If a copy of the MPL was not distributed
8// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9
10#ifndef EIGEN_SPARSECHOLESKY_MODULE_H
11#define EIGEN_SPARSECHOLESKY_MODULE_H
12
13#include "SparseCore"
14#include "OrderingMethods"
15
16#include "src/Core/util/DisableStupidWarnings.h"
17
18/**
19  * \defgroup SparseCholesky_Module SparseCholesky module
20  *
21  * This module currently provides two variants of the direct sparse Cholesky decomposition for selfadjoint (hermitian) matrices.
22  * Those decompositions are accessible via the following classes:
23  *  - SimplicialLLt,
24  *  - SimplicialLDLt
25  *
26  * Such problems can also be solved using the ConjugateGradient solver from the IterativeLinearSolvers module.
27  *
28  * \code
29  * #include <Eigen/SparseCholesky>
30  * \endcode
31  */
32
33#ifdef EIGEN_MPL2_ONLY
34#error The SparseCholesky module has nothing to offer in MPL2 only mode
35#endif
36
37#include "src/SparseCholesky/SimplicialCholesky.h"
38
39#ifndef EIGEN_MPL2_ONLY
40#include "src/SparseCholesky/SimplicialCholesky_impl.h"
41#endif
42
43#include "src/Core/util/ReenableStupidWarnings.h"
44
45#endif // EIGEN_SPARSECHOLESKY_MODULE_H
46