UmfPackSupport 1.3 KB

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