SparseCholesky 1.25 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2008-2013 Gael Guennebaud <gael.guennebaud@inria.fr>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef EIGEN_SPARSECHOLESKY_MODULE_H
#define EIGEN_SPARSECHOLESKY_MODULE_H

#include "SparseCore"
#include "OrderingMethods"

#include "src/Core/util/DisableStupidWarnings.h"

/**
 * \defgroup SparseCholesky_Module SparseCholesky module
 *
 * This module currently provides two variants of the direct sparse Cholesky decomposition for selfadjoint (hermitian)
 * matrices. Those decompositions are accessible via the following classes:
 *  - SimplicialLLt,
 *  - SimplicialLDLt
 *
 * Such problems can also be solved using the ConjugateGradient solver from the IterativeLinearSolvers module.
 *
 * \code
 * #include <Eigen/SparseCholesky>
 * \endcode
 */

// IWYU pragma: begin_exports
#include "src/SparseCholesky/SimplicialCholesky.h"
#include "src/SparseCholesky/SimplicialCholesky_impl.h"
// IWYU pragma: end_exports

#include "src/Core/util/ReenableStupidWarnings.h"

#endif  // EIGEN_SPARSECHOLESKY_MODULE_H