diff options
Diffstat (limited to 'Eigen/UmfPackSupport')
| -rw-r--r-- | Eigen/UmfPackSupport | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Eigen/UmfPackSupport b/Eigen/UmfPackSupport index aac361e3f..984f64a84 100644 --- a/Eigen/UmfPackSupport +++ b/Eigen/UmfPackSupport @@ -12,12 +12,18 @@ extern "C" { /** \ingroup Support_modules * \defgroup UmfPackSupport_Module UmfPackSupport module * - * - * + * This module provides an interface to the UmfPack library which is part of the <a href="http://www.cise.ufl.edu/research/sparse/SuiteSparse/">suitesparse</a> package. + * It provides the following factorization class: + * - class UmfPackLU: a multifrontal sequential LU factorization. * * \code * #include <Eigen/UmfPackSupport> * \endcode + * + * 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. + * */ #include "src/misc/Solve.h" |