Warning, /include/eigen3/Eigen/CholmodSupport is written in an unsupported language. File is not indexed.
0001 // This file is part of Eigen, a lightweight C++ template library
0002 // for linear algebra.
0003 //
0004 // This Source Code Form is subject to the terms of the Mozilla
0005 // Public License v. 2.0. If a copy of the MPL was not distributed
0006 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
0007
0008 #ifndef EIGEN_CHOLMODSUPPORT_MODULE_H
0009 #define EIGEN_CHOLMODSUPPORT_MODULE_H
0010
0011 #include "SparseCore"
0012
0013 #include "src/Core/util/DisableStupidWarnings.h"
0014
0015 extern "C" {
0016 #include <cholmod.h>
0017 }
0018
0019 /** \ingroup Support_modules
0020 * \defgroup CholmodSupport_Module CholmodSupport module
0021 *
0022 * This module provides an interface to the Cholmod library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
0023 * It provides the two following main factorization classes:
0024 * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization.
0025 * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial).
0026 *
0027 * For the sake of completeness, this module also propose the two following classes:
0028 * - class CholmodSimplicialLLT
0029 * - class CholmodSimplicialLDLT
0030 * Note that these classes does not bring any particular advantage compared to the built-in
0031 * SimplicialLLT and SimplicialLDLT factorization classes.
0032 *
0033 * \code
0034 * #include <Eigen/CholmodSupport>
0035 * \endcode
0036 *
0037 * 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.
0038 * The dependencies depend on how cholmod has been compiled.
0039 * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task.
0040 *
0041 */
0042
0043 #include "src/CholmodSupport/CholmodSupport.h"
0044
0045 #include "src/Core/util/ReenableStupidWarnings.h"
0046
0047 #endif // EIGEN_CHOLMODSUPPORT_MODULE_H
0048
