xref: /aosp_15_r20/external/eigen/Eigen/SPQRSupport (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_SPQRSUPPORT_MODULE_H
9*bf2c3715SXin Li#define EIGEN_SPQRSUPPORT_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 Li#include "SuiteSparseQR.hpp"
16*bf2c3715SXin Li
17*bf2c3715SXin Li/** \ingroup Support_modules
18*bf2c3715SXin Li  * \defgroup SPQRSupport_Module SuiteSparseQR module
19*bf2c3715SXin Li  *
20*bf2c3715SXin Li  * This module provides an interface to the SPQR library, which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
21*bf2c3715SXin Li  *
22*bf2c3715SXin Li  * \code
23*bf2c3715SXin Li  * #include <Eigen/SPQRSupport>
24*bf2c3715SXin Li  * \endcode
25*bf2c3715SXin Li  *
26*bf2c3715SXin Li  * In order to use this module, the SPQR headers must be accessible from the include paths, and your binary must be linked to the SPQR library and its dependencies (Cholmod, AMD, COLAMD,...).
27*bf2c3715SXin Li  * For a cmake based project, you can use our FindSPQR.cmake and FindCholmod.Cmake modules
28*bf2c3715SXin Li  *
29*bf2c3715SXin Li  */
30*bf2c3715SXin Li
31*bf2c3715SXin Li#include "src/CholmodSupport/CholmodSupport.h"
32*bf2c3715SXin Li#include "src/SPQRSupport/SuiteSparseQRSupport.h"
33*bf2c3715SXin Li
34*bf2c3715SXin Li#endif
35