CholmodSupport 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. #ifndef EIGEN_CHOLMODSUPPORT_MODULE_H
  2. #define EIGEN_CHOLMODSUPPORT_MODULE_H
  3. #include "SparseCore"
  4. #include "src/Core/util/DisableStupidWarnings.h"
  5. extern "C" {
  6. #include <cholmod.h>
  7. }
  8. /** \ingroup Support_modules
  9. * \defgroup CholmodSupport_Module CholmodSupport module
  10. *
  11. * This module provides an interface to the Cholmod library which is part of the <a href="http://www.cise.ufl.edu/research/sparse/SuiteSparse/">suitesparse</a> package.
  12. * It provides the two following main factorization classes:
  13. * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization.
  14. * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial).
  15. *
  16. * For the sake of completeness, this module also propose the two following classes:
  17. * - class CholmodSimplicialLLT
  18. * - class CholmodSimplicialLDLT
  19. * Note that these classes does not bring any particular advantage compared to the built-in
  20. * SimplicialLLT and SimplicialLDLT factorization classes.
  21. *
  22. * \code
  23. * #include <Eigen/CholmodSupport>
  24. * \endcode
  25. *
  26. * In order to use this module, the cholmod headers must be accessible from the include paths, and your binary must be linked to the cholmod library and its dependencies.
  27. * The dependencies depend on how cholmod has been compiled.
  28. * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.
  29. *
  30. */
  31. #include "src/misc/Solve.h"
  32. #include "src/misc/SparseSolve.h"
  33. #include "src/CholmodSupport/CholmodSupport.h"
  34. #include "src/Core/util/ReenableStupidWarnings.h"
  35. #endif // EIGEN_CHOLMODSUPPORT_MODULE_H