1 // This file is part of Eigen, a lightweight C++ template library
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/.
8 #ifndef EIGEN_SPARSEQR_MODULE_H
9 #define EIGEN_SPARSEQR_MODULE_H
12 #include "OrderingMethods"
13 #include "src/Core/util/DisableStupidWarnings.h"
15 /** \defgroup SparseQR_Module SparseQR module
16 * \brief Provides QR decomposition for sparse matrices
18 * This module provides a simplicial version of the left-looking Sparse QR decomposition.
19 * The columns of the input matrix should be reordered to limit the fill-in during the
20 * decomposition. Built-in methods (COLAMD, AMD) or external methods (METIS) can be used to this end.
21 * See the \link OrderingMethods_Module OrderingMethods\endlink module for the list
22 * of built-in and external ordering methods.
25 * #include <Eigen/SparseQR>
31 #include "OrderingMethods"
32 #include "src/SparseCore/SparseColEtree.h"
33 #include "src/SparseQR/SparseQR.h"
35 #include "src/Core/util/ReenableStupidWarnings.h"