Eigen  5.0.1-dev
 
Loading...
Searching...
No Matches
SPQRSupport
1// 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
8#ifndef EIGEN_SPQRSUPPORT_MODULE_H
9#define EIGEN_SPQRSUPPORT_MODULE_H
10
11#include "SparseCore"
12
13#include "src/Core/util/DisableStupidWarnings.h"
14
15#include "SuiteSparseQR.hpp"
16
17/** \ingroup Support_modules
18 * \defgroup SPQRSupport_Module SuiteSparseQR module
19 *
20 * This module provides an interface to the SPQR library, which is part of the <a
21 * href="http://www.suitesparse.com">suitesparse</a> package.
22 *
23 * \code
24 * #include <Eigen/SPQRSupport>
25 * \endcode
26 *
27 * In order to use this module, the SPQR headers must be accessible from the include paths, and your binary must be
28 * linked to the SPQR library and its dependencies (Cholmod, AMD, COLAMD,...). For a cmake based project, you can use
29 * our FindSPQR.cmake and FindCholmod.Cmake modules
30 *
31 */
32
33#include "CholmodSupport"
34
35// IWYU pragma: begin_exports
36#include "src/SPQRSupport/SuiteSparseQRSupport.h"
37// IWYU pragma: end_exports
38
39#include "src/Core/util/ReenableStupidWarnings.h"
40
41#endif