diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2012-06-21 10:51:22 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2012-06-21 10:51:22 +0200 |
| commit | 6f3057f624da32ee854ba13df2bb5e399050c8c4 (patch) | |
| tree | 68eb512466a650d22db358b103894043414e4e9f /Eigen/PaStiXSupport | |
| parent | 5b5f3ecafa25aee1af27ea3503ad9e0e1ee49d04 (diff) | |
extend documentation of *Support modules
Diffstat (limited to 'Eigen/PaStiXSupport')
| -rw-r--r-- | Eigen/PaStiXSupport | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/Eigen/PaStiXSupport b/Eigen/PaStiXSupport index 1dbb0941b..7c616ee5e 100644 --- a/Eigen/PaStiXSupport +++ b/Eigen/PaStiXSupport @@ -17,10 +17,22 @@ extern "C" { /** \ingroup Support_modules * \defgroup PaStiXSupport_Module PaStiXSupport module - * + * + * This module provides an interface to the <a href="http://pastix.gforge.inria.fr/">PaSTiX</a> library. + * PaSTiX is a general \b supernodal, \b parallel and \b opensource sparse solver. + * It provides the two following main factorization classes: + * - class PastixLLT : a supernodal, parallel LLt Cholesky factorization. + * - class PastixLDLT: a supernodal, parallel LDLt Cholesky factorization. + * - class PastixLU : a supernodal, parallel LU factorization (optimized for a symmetric pattern). + * * \code * #include <Eigen/PaStiXSupport> * \endcode + * + * In order to use this module, the PaSTiX headers must be accessible from the include paths, and your binary must be linked to the PaSTiX library and its dependencies. + * The dependencies depend on how PaSTiX has been compiled. + * For a cmake based project, you can use our FindPaSTiX.cmake module to help you in this task. + * */ #include "src/misc/Solve.h" |