xref: /aosp_15_r20/external/eigen/Eigen/PaStiXSupport (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// This Source Code Form is subject to the terms of the Mozilla
5*bf2c3715SXin Li// Public License v. 2.0. If a copy of the MPL was not distributed
6*bf2c3715SXin Li// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
7*bf2c3715SXin Li
8*bf2c3715SXin Li#ifndef EIGEN_PASTIXSUPPORT_MODULE_H
9*bf2c3715SXin Li#define EIGEN_PASTIXSUPPORT_MODULE_H
10*bf2c3715SXin Li
11*bf2c3715SXin Li#include "SparseCore"
12*bf2c3715SXin Li
13*bf2c3715SXin Li#include "src/Core/util/DisableStupidWarnings.h"
14*bf2c3715SXin Li
15*bf2c3715SXin Liextern "C" {
16*bf2c3715SXin Li#include <pastix_nompi.h>
17*bf2c3715SXin Li#include <pastix.h>
18*bf2c3715SXin Li}
19*bf2c3715SXin Li
20*bf2c3715SXin Li#ifdef complex
21*bf2c3715SXin Li#undef complex
22*bf2c3715SXin Li#endif
23*bf2c3715SXin Li
24*bf2c3715SXin Li/** \ingroup Support_modules
25*bf2c3715SXin Li  * \defgroup PaStiXSupport_Module PaStiXSupport module
26*bf2c3715SXin Li  *
27*bf2c3715SXin Li  * This module provides an interface to the <a href="http://pastix.gforge.inria.fr/">PaSTiX</a> library.
28*bf2c3715SXin Li  * PaSTiX is a general \b supernodal, \b parallel and \b opensource sparse solver.
29*bf2c3715SXin Li  * It provides the two following main factorization classes:
30*bf2c3715SXin Li  * - class PastixLLT : a supernodal, parallel LLt Cholesky factorization.
31*bf2c3715SXin Li  * - class PastixLDLT: a supernodal, parallel LDLt Cholesky factorization.
32*bf2c3715SXin Li  * - class PastixLU : a supernodal, parallel LU factorization (optimized for a symmetric pattern).
33*bf2c3715SXin Li  *
34*bf2c3715SXin Li  * \code
35*bf2c3715SXin Li  * #include <Eigen/PaStiXSupport>
36*bf2c3715SXin Li  * \endcode
37*bf2c3715SXin Li  *
38*bf2c3715SXin Li  * In order to use this module, the PaSTiX headers must be accessible from the include paths, and your binary must be linked to the PaSTiX library and its dependencies.
39*bf2c3715SXin Li  * This wrapper resuires PaStiX version 5.x compiled without MPI support.
40*bf2c3715SXin Li  * The dependencies depend on how PaSTiX has been compiled.
41*bf2c3715SXin Li  * For a cmake based project, you can use our FindPaSTiX.cmake module to help you in this task.
42*bf2c3715SXin Li  *
43*bf2c3715SXin Li  */
44*bf2c3715SXin Li
45*bf2c3715SXin Li#include "src/PaStiXSupport/PaStiXSupport.h"
46*bf2c3715SXin Li
47*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h"
48*bf2c3715SXin Li
49*bf2c3715SXin Li#endif // EIGEN_PASTIXSUPPORT_MODULE_H
50