source: pacpussensors/trunk/Vislab/lib3dv/eigen/Eigen/UmfPackSupport@ 136

Last change on this file since 136 was 136, checked in by ldecherf, 7 years ago

Doc

File size: 1.1 KB
Line 
1#ifndef EIGEN_UMFPACKSUPPORT_MODULE_H
2#define EIGEN_UMFPACKSUPPORT_MODULE_H
3
4#include "SparseCore"
5
6#include "src/Core/util/DisableStupidWarnings.h"
7
8extern "C" {
9#include <umfpack.h>
10}
11
12/** \ingroup Support_modules
13 * \defgroup UmfPackSupport_Module UmfPackSupport module
14 *
15 * This module provides an interface to the UmfPack library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package.
16 * It provides the following factorization class:
17 * - class UmfPackLU: a multifrontal sequential LU factorization.
18 *
19 * \code
20 * #include <Eigen/UmfPackSupport>
21 * \endcode
22 *
23 * 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.
24 * The dependencies depend on how umfpack has been compiled.
25 * For a cmake based project, you can use our FindUmfPack.cmake module to help you in this task.
26 *
27 */
28
29#include "src/misc/Solve.h"
30#include "src/misc/SparseSolve.h"
31
32#include "src/UmfPackSupport/UmfPackSupport.h"
33
34#include "src/Core/util/ReenableStupidWarnings.h"
35
36#endif // EIGEN_UMFPACKSUPPORT_MODULE_H
Note: See TracBrowser for help on using the repository browser.