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_UMFPACKSUPPORT_MODULE_H 9*bf2c3715SXin Li#define EIGEN_UMFPACKSUPPORT_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 <umfpack.h> 17*bf2c3715SXin Li} 18*bf2c3715SXin Li 19*bf2c3715SXin Li/** \ingroup Support_modules 20*bf2c3715SXin Li * \defgroup UmfPackSupport_Module UmfPackSupport module 21*bf2c3715SXin Li * 22*bf2c3715SXin Li * This module provides an interface to the UmfPack library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package. 23*bf2c3715SXin Li * It provides the following factorization class: 24*bf2c3715SXin Li * - class UmfPackLU: a multifrontal sequential LU factorization. 25*bf2c3715SXin Li * 26*bf2c3715SXin Li * \code 27*bf2c3715SXin Li * #include <Eigen/UmfPackSupport> 28*bf2c3715SXin Li * \endcode 29*bf2c3715SXin Li * 30*bf2c3715SXin Li * In order to use this module, the umfpack headers must be accessible from the include paths, and your binary must be linked to the umfpack library and its dependencies. 31*bf2c3715SXin Li * The dependencies depend on how umfpack has been compiled. 32*bf2c3715SXin Li * For a cmake based project, you can use our FindUmfPack.cmake module to help you in this task. 33*bf2c3715SXin Li * 34*bf2c3715SXin Li */ 35*bf2c3715SXin Li 36*bf2c3715SXin Li#include "src/UmfPackSupport/UmfPackSupport.h" 37*bf2c3715SXin Li 38*bf2c3715SXin Li#include "src/Core/util/ReenableStupidWarnings.h" 39*bf2c3715SXin Li 40*bf2c3715SXin Li#endif // EIGEN_UMFPACKSUPPORT_MODULE_H 41