xref: /aosp_15_r20/external/eigen/Eigen/SparseQR (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_SPARSEQR_MODULE_H
9*bf2c3715SXin Li#define EIGEN_SPARSEQR_MODULE_H
10*bf2c3715SXin Li
11*bf2c3715SXin Li#include "SparseCore"
12*bf2c3715SXin Li#include "OrderingMethods"
13*bf2c3715SXin Li#include "src/Core/util/DisableStupidWarnings.h"
14*bf2c3715SXin Li
15*bf2c3715SXin Li/** \defgroup SparseQR_Module SparseQR module
16*bf2c3715SXin Li  * \brief Provides QR decomposition for sparse matrices
17*bf2c3715SXin Li  *
18*bf2c3715SXin Li  * This module provides a simplicial version of the left-looking Sparse QR decomposition.
19*bf2c3715SXin Li  * The columns of the input matrix should be reordered to limit the fill-in during the
20*bf2c3715SXin Li  * decomposition. Built-in methods (COLAMD, AMD) or external  methods (METIS) can be used to this end.
21*bf2c3715SXin Li  * See the \link OrderingMethods_Module OrderingMethods\endlink module for the list
22*bf2c3715SXin Li  * of built-in and external ordering methods.
23*bf2c3715SXin Li  *
24*bf2c3715SXin Li  * \code
25*bf2c3715SXin Li  * #include <Eigen/SparseQR>
26*bf2c3715SXin Li  * \endcode
27*bf2c3715SXin Li  *
28*bf2c3715SXin Li  *
29*bf2c3715SXin Li  */
30*bf2c3715SXin Li
31*bf2c3715SXin Li#include "src/SparseCore/SparseColEtree.h"
32*bf2c3715SXin Li#include "src/SparseQR/SparseQR.h"
33*bf2c3715SXin Li
34*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h"
35*bf2c3715SXin Li
36*bf2c3715SXin Li#endif
37