1*bf2c3715SXin Li// This file is part of Eigen, a lightweight C++ template library 2*bf2c3715SXin Li// for linear algebra. 3*bf2c3715SXin Li// 4*bf2c3715SXin Li// This Source Code Form is subject to the terms of the Mozilla 5*bf2c3715SXin Li// Public License v. 2.0. If a copy of the MPL was not distributed 6*bf2c3715SXin Li// with this file, You can obtain one at http://mozilla.org/MPL/2.0/. 7*bf2c3715SXin Li 8*bf2c3715SXin Li#ifndef EIGEN_CHOLMODSUPPORT_MODULE_H 9*bf2c3715SXin Li#define EIGEN_CHOLMODSUPPORT_MODULE_H 10*bf2c3715SXin Li 11*bf2c3715SXin Li#include "SparseCore" 12*bf2c3715SXin Li 13*bf2c3715SXin Li#include "src/Core/util/DisableStupidWarnings.h" 14*bf2c3715SXin Li 15*bf2c3715SXin Liextern "C" { 16*bf2c3715SXin Li #include <cholmod.h> 17*bf2c3715SXin Li} 18*bf2c3715SXin Li 19*bf2c3715SXin Li/** \ingroup Support_modules 20*bf2c3715SXin Li * \defgroup CholmodSupport_Module CholmodSupport module 21*bf2c3715SXin Li * 22*bf2c3715SXin Li * This module provides an interface to the Cholmod library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package. 23*bf2c3715SXin Li * It provides the two following main factorization classes: 24*bf2c3715SXin Li * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization. 25*bf2c3715SXin Li * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial). 26*bf2c3715SXin Li * 27*bf2c3715SXin Li * For the sake of completeness, this module also propose the two following classes: 28*bf2c3715SXin Li * - class CholmodSimplicialLLT 29*bf2c3715SXin Li * - class CholmodSimplicialLDLT 30*bf2c3715SXin Li * Note that these classes does not bring any particular advantage compared to the built-in 31*bf2c3715SXin Li * SimplicialLLT and SimplicialLDLT factorization classes. 32*bf2c3715SXin Li * 33*bf2c3715SXin Li * \code 34*bf2c3715SXin Li * #include <Eigen/CholmodSupport> 35*bf2c3715SXin Li * \endcode 36*bf2c3715SXin Li * 37*bf2c3715SXin Li * 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. 38*bf2c3715SXin Li * The dependencies depend on how cholmod has been compiled. 39*bf2c3715SXin Li * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task. 40*bf2c3715SXin Li * 41*bf2c3715SXin Li */ 42*bf2c3715SXin Li 43*bf2c3715SXin Li#include "src/CholmodSupport/CholmodSupport.h" 44*bf2c3715SXin Li 45*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h" 46*bf2c3715SXin Li 47*bf2c3715SXin Li#endif // EIGEN_CHOLMODSUPPORT_MODULE_H 48*bf2c3715SXin Li 49