Home | History | Annotate | Download | only in Eigen
      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 href="http://www.suitesparse.com">suitesparse</a> package.
     21   *
     22   * \code
     23   * #include <Eigen/SPQRSupport>
     24   * \endcode
     25   *
     26   * 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   * For a cmake based project, you can use our FindSPQR.cmake and FindCholmod.Cmake modules
     28   *
     29   */
     30 
     31 #include "src/CholmodSupport/CholmodSupport.h"
     32 #include "src/SPQRSupport/SuiteSparseQRSupport.h"
     33 
     34 #endif
     35