2015-10-26 18:46:05 +08:00
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
2010-06-18 17:28:30 +08:00
#ifndef EIGEN_UMFPACKSUPPORT_MODULE_H
#define EIGEN_UMFPACKSUPPORT_MODULE_H
2011-11-12 21:11:27 +08:00
#include "SparseCore"
2010-06-18 17:28:30 +08:00
2011-11-16 16:27:38 +08:00
#include "src/Core/util/DisableStupidWarnings.h"
2010-06-18 17:28:30 +08:00
2011-02-18 01:19:28 +08:00
extern "C" {
2010-06-18 17:28:30 +08:00
#include <umfpack.h>
2011-02-18 01:19:28 +08:00
}
2010-06-18 17:28:30 +08:00
2011-11-28 23:36:37 +08:00
/** \ingroup Support_modules
2011-11-12 21:11:27 +08:00
* \defgroup UmfPackSupport_Module UmfPackSupport module
2010-06-18 17:28:30 +08:00
*
2016-01-28 05:48:40 +08:00
* This module provides an interface to the UmfPack library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
2012-06-21 16:51:22 +08:00
* It provides the following factorization class:
* - class UmfPackLU: a multifrontal sequential LU factorization.
2010-06-18 17:28:30 +08:00
*
* \code
* #include <Eigen/UmfPackSupport>
* \endcode
2012-06-21 16:51:22 +08:00
*
* 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.
* The dependencies depend on how umfpack has been compiled.
* For a cmake based project, you can use our FindUmfPack.cmake module to help you in this task.
*
2010-06-18 17:28:30 +08:00
*/
2011-11-12 21:11:27 +08:00
#include "src/UmfPackSupport/UmfPackSupport.h"
2010-06-18 17:28:30 +08:00
2011-11-16 16:27:38 +08:00
#include "src/Core/util/ReenableStupidWarnings.h"
2010-06-18 17:28:30 +08:00
#endif // EIGEN_UMFPACKSUPPORT_MODULE_H