Warning, /include/eigen3/Eigen/KLUSupport 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_KLUSUPPORT_MODULE_H
0009 #define EIGEN_KLUSUPPORT_MODULE_H
0010
0011 #include <Eigen/SparseCore>
0012
0013 #include <Eigen/src/Core/util/DisableStupidWarnings.h>
0014
0015 extern "C" {
0016 #include <btf.h>
0017 #include <klu.h>
0018 }
0019
0020 /** \ingroup Support_modules
0021 * \defgroup KLUSupport_Module KLUSupport module
0022 *
0023 * This module provides an interface to the KLU library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
0024 * It provides the following factorization class:
0025 * - class KLU: a sparse LU factorization, well-suited for circuit simulation.
0026 *
0027 * \code
0028 * #include <Eigen/KLUSupport>
0029 * \endcode
0030 *
0031 * In order to use this module, the klu and btf headers must be accessible from the include paths, and your binary must be linked to the klu library and its dependencies.
0032 * The dependencies depend on how umfpack has been compiled.
0033 * For a cmake based project, you can use our FindKLU.cmake module to help you in this task.
0034 *
0035 */
0036
0037 #include "src/KLUSupport/KLUSupport.h"
0038
0039 #include <Eigen/src/Core/util/ReenableStupidWarnings.h>
0040
0041 #endif // EIGEN_KLUSUPPORT_MODULE_H
