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/CholmodSupport | |
| parent | 5b5f3ecafa25aee1af27ea3503ad9e0e1ee49d04 (diff) | |
extend documentation of *Support modules
Diffstat (limited to 'Eigen/CholmodSupport')
| -rw-r--r-- | Eigen/CholmodSupport | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Eigen/CholmodSupport b/Eigen/CholmodSupport index 0e1ff48e0..745b884e7 100644 --- a/Eigen/CholmodSupport +++ b/Eigen/CholmodSupport @@ -26,6 +26,11 @@ extern "C" { * \code * #include <Eigen/CholmodSupport> * \endcode + * + * In order to use this module, the cholmod headers must be accessible from the include paths, and your binary must be linked to the cholmod library and its dependencies. + * The dependencies depend on how cholmod has been compiled. + * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task. + * */ #include "src/misc/Solve.h" |