xref: /aosp_15_r20/external/eigen/Eigen/SparseCholesky (revision bf2c37156dfe67e5dfebd6d394bad8b2ab5804d4)
1*bf2c3715SXin Li// This file is part of Eigen, a lightweight C++ template library
2*bf2c3715SXin Li// for linear algebra.
3*bf2c3715SXin Li//
4*bf2c3715SXin Li// Copyright (C) 2008-2013 Gael Guennebaud <[email protected]>
5*bf2c3715SXin Li//
6*bf2c3715SXin Li// This Source Code Form is subject to the terms of the Mozilla
7*bf2c3715SXin Li// Public License v. 2.0. If a copy of the MPL was not distributed
8*bf2c3715SXin Li// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
9*bf2c3715SXin Li
10*bf2c3715SXin Li#ifndef EIGEN_SPARSECHOLESKY_MODULE_H
11*bf2c3715SXin Li#define EIGEN_SPARSECHOLESKY_MODULE_H
12*bf2c3715SXin Li
13*bf2c3715SXin Li#include "SparseCore"
14*bf2c3715SXin Li#include "OrderingMethods"
15*bf2c3715SXin Li
16*bf2c3715SXin Li#include "src/Core/util/DisableStupidWarnings.h"
17*bf2c3715SXin Li
18*bf2c3715SXin Li/**
19*bf2c3715SXin Li  * \defgroup SparseCholesky_Module SparseCholesky module
20*bf2c3715SXin Li  *
21*bf2c3715SXin Li  * This module currently provides two variants of the direct sparse Cholesky decomposition for selfadjoint (hermitian) matrices.
22*bf2c3715SXin Li  * Those decompositions are accessible via the following classes:
23*bf2c3715SXin Li  *  - SimplicialLLt,
24*bf2c3715SXin Li  *  - SimplicialLDLt
25*bf2c3715SXin Li  *
26*bf2c3715SXin Li  * Such problems can also be solved using the ConjugateGradient solver from the IterativeLinearSolvers module.
27*bf2c3715SXin Li  *
28*bf2c3715SXin Li  * \code
29*bf2c3715SXin Li  * #include <Eigen/SparseCholesky>
30*bf2c3715SXin Li  * \endcode
31*bf2c3715SXin Li  */
32*bf2c3715SXin Li
33*bf2c3715SXin Li#include "src/SparseCholesky/SimplicialCholesky.h"
34*bf2c3715SXin Li#include "src/SparseCholesky/SimplicialCholesky_impl.h"
35*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h"
36*bf2c3715SXin Li
37*bf2c3715SXin Li#endif // EIGEN_SPARSECHOLESKY_MODULE_H
38