CholmodSupport 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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_CHOLMODSUPPORT_MODULE_H
  8. #define EIGEN_CHOLMODSUPPORT_MODULE_H
  9. #include "SparseCore"
  10. #include "src/Core/util/DisableStupidWarnings.h"
  11. extern "C" {
  12. #include <cholmod.h>
  13. }
  14. /** \ingroup Support_modules
  15. * \defgroup CholmodSupport_Module CholmodSupport module
  16. *
  17. * This module provides an interface to the Cholmod library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
  18. * It provides the two following main factorization classes:
  19. * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization.
  20. * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial).
  21. *
  22. * For the sake of completeness, this module also propose the two following classes:
  23. * - class CholmodSimplicialLLT
  24. * - class CholmodSimplicialLDLT
  25. * Note that these classes does not bring any particular advantage compared to the built-in
  26. * SimplicialLLT and SimplicialLDLT factorization classes.
  27. *
  28. * \code
  29. * #include <Eigen/CholmodSupport>
  30. * \endcode
  31. *
  32. * 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.
  33. * The dependencies depend on how cholmod has been compiled.
  34. * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.
  35. *
  36. */
  37. #include "src/CholmodSupport/CholmodSupport.h"
  38. #include "src/Core/util/ReenableStupidWarnings.h"
  39. #endif // EIGEN_CHOLMODSUPPORT_MODULE_H