diff options
Diffstat (limited to 'Eigen/SuperLUSupport')
-rw-r--r-- | Eigen/SuperLUSupport | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Eigen/SuperLUSupport b/Eigen/SuperLUSupport index 09aa1b6ca..575e14fbc 100644 --- a/Eigen/SuperLUSupport +++ b/Eigen/SuperLUSupport @@ -31,11 +31,21 @@ namespace Eigen { struct SluMatrix; } /** \ingroup Support_modules * \defgroup SuperLUSupport_Module SuperLUSupport module * + * This module provides an interface to the <a href="http://crd-legacy.lbl.gov/~xiaoye/SuperLU/">SuperLU</a> library. + * It provides the following factorization class: + * - class SuperLU: a supernodal sequential LU factorization. + * - class SuperILU: a supernodal sequential incomplete LU factorization (to be used as a preconditioner for iterative methods). + * * \warning When including this module, you have to use SUPERLU_EMPTY instead of EMPTY which is no longer defined because it is too polluting. * * \code * #include <Eigen/SuperLUSupport> * \endcode + * + * In order to use this module, the superlu headers must be accessible from the include paths, and your binary must be linked to the superlu library and its dependencies. + * The dependencies depend on how superlu has been compiled. + * For a cmake based project, you can use our FindSuperLU.cmake module to help you in this task. + * */ #include "src/misc/Solve.h" |