From 6f3057f624da32ee854ba13df2bb5e399050c8c4 Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Thu, 21 Jun 2012 10:51:22 +0200 Subject: extend documentation of *Support modules --- Eigen/PaStiXSupport | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'Eigen/PaStiXSupport') 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 PaSTiX 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 * \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" -- cgit v1.2.3