SparseQR 1.2 KB

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