blob: 369d1f5ec9bae8856dd672ba1515d5449f9cfbb8 [file] [log] [blame]
Miao Wang2b8756b2017-03-06 13:45:08 -08001// 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
Narayan Kamathc981c482012-11-02 10:59:05 +00008#ifndef EIGEN_CHOLESKY_MODULE_H
9#define EIGEN_CHOLESKY_MODULE_H
10
11#include "Core"
12
13#include "src/Core/util/DisableStupidWarnings.h"
14
15/** \defgroup Cholesky_Module Cholesky module
16 *
17 *
18 *
19 * This module provides two variants of the Cholesky decomposition for selfadjoint (hermitian) matrices.
Miao Wang2b8756b2017-03-06 13:45:08 -080020 * Those decompositions are also accessible via the following methods:
21 * - MatrixBase::llt()
Narayan Kamathc981c482012-11-02 10:59:05 +000022 * - MatrixBase::ldlt()
Miao Wang2b8756b2017-03-06 13:45:08 -080023 * - SelfAdjointView::llt()
24 * - SelfAdjointView::ldlt()
Narayan Kamathc981c482012-11-02 10:59:05 +000025 *
26 * \code
27 * #include <Eigen/Cholesky>
28 * \endcode
29 */
30
Narayan Kamathc981c482012-11-02 10:59:05 +000031#include "src/Cholesky/LLT.h"
32#include "src/Cholesky/LDLT.h"
33#ifdef EIGEN_USE_LAPACKE
Miao Wang2b8756b2017-03-06 13:45:08 -080034#include "src/misc/lapacke.h"
35#include "src/Cholesky/LLT_LAPACKE.h"
Narayan Kamathc981c482012-11-02 10:59:05 +000036#endif
37
38#include "src/Core/util/ReenableStupidWarnings.h"
39
40#endif // EIGEN_CHOLESKY_MODULE_H
41/* vim: set filetype=cpp et sw=2 ts=2 ai: */