ground/gcs/src/libs/eigen/Eigen/UmfPackSupport

   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_UMFPACKSUPPORT_MODULE_H
   9 #define EIGEN_UMFPACKSUPPORT_MODULE_H
  10
  11 #include "SparseCore"
  12
  13 #include "src/Core/util/DisableStupidWarnings.h"
  14
  15 extern "C" {
  16 #include <umfpack.h>
  17 }
  18
  19 /** \ingroup Support_modules
  20   * \defgroup UmfPackSupport_Module UmfPackSupport module
  21   *
  22   * This module provides an interface to the UmfPack library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
  23   * It provides the following factorization class:
  24   * - class UmfPackLU: a multifrontal sequential LU factorization.
  25   *
  26   * \code
  27   * #include <Eigen/UmfPackSupport>
  28   * \endcode
  29   *
  30   * In order to use this module, the umfpack headers must be accessible from the include paths, and your binary must be linked to the umfpack library and its dependencies.
  31   * The dependencies depend on how umfpack has been compiled.
  32   * For a cmake based project, you can use our FindUmfPack.cmake module to help you in this task.
  33   *
  34   */
  35
  36 #include "src/UmfPackSupport/UmfPackSupport.h"
  37
  38 #include "src/Core/util/ReenableStupidWarnings.h"
  39
  40 #endif // EIGEN_UMFPACKSUPPORT_MODULE_H