|
12 | 12 |
|
13 | 13 | #include "src/Core/util/DisableStupidWarnings.h" |
14 | 14 |
|
15 | | -/** \ingroup Support_modules |
16 | | - * \defgroup CholmodSupport_Module CholmodSupport module |
17 | | - * |
18 | | - * This module provides an interface to the Cholmod library which is part of the <a href="http://www.suitesparse.com">suitesparse</a> package. |
19 | | - * It provides the two following main factorization classes: |
20 | | - * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization. |
21 | | - * - class CholmodDecomposiiton: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of the underlying factorization method (supernodal or simplicial). |
22 | | - * |
23 | | - * For the sake of completeness, this module also propose the two following classes: |
24 | | - * - class CholmodSimplicialLLT |
25 | | - * - class CholmodSimplicialLDLT |
26 | | - * Note that these classes does not bring any particular advantage compared to the built-in |
27 | | - * SimplicialLLT and SimplicialLDLT factorization classes. |
28 | | - * |
29 | | - * \code |
30 | | - * #include <Eigen/CholmodSupport> |
31 | | - * \endcode |
32 | | - * |
33 | | - * 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. |
34 | | - * The dependencies depend on how cholmod has been compiled. |
35 | | - * For a cmake based project, you can use our FindCholmod.cmake module to help you in this task. |
36 | | - * |
37 | | - */ |
| 15 | +#include <RcppEigenCholmod.h> |
38 | 16 |
|
| 17 | +/** \ingroup Support_modules |
| 18 | + * \defgroup CholmodSupport_Module CholmodSupport module |
| 19 | + * |
| 20 | + * This module provides an interface to the Cholmod library which is part of the <a |
| 21 | + * href="http://www.suitesparse.com">suitesparse</a> package. It provides the two following main factorization classes: |
| 22 | + * - class CholmodSupernodalLLT: a supernodal LLT Cholesky factorization. |
| 23 | + * - class CholmodDecomposition: a general L(D)LT Cholesky factorization with automatic or explicit runtime selection of |
| 24 | + * the underlying factorization method (supernodal or simplicial). |
| 25 | + * |
| 26 | + * For the sake of completeness, this module also propose the two following classes: |
| 27 | + * - class CholmodSimplicialLLT |
| 28 | + * - class CholmodSimplicialLDLT |
| 29 | + * Note that these classes does not bring any particular advantage compared to the built-in |
| 30 | + * SimplicialLLT and SimplicialLDLT factorization classes. |
| 31 | + * |
| 32 | + * \code |
| 33 | + * #include <Eigen/CholmodSupport> |
| 34 | + * \endcode |
| 35 | + * |
| 36 | + * In order to use this module, the cholmod headers must be accessible from the include paths, and your binary must be |
| 37 | + * linked to the cholmod library and its dependencies. The dependencies depend on how cholmod has been compiled. For a |
| 38 | + * cmake based project, you can use our FindCholmod.cmake module to help you in this task. |
| 39 | + * |
| 40 | + */ |
| 41 | + |
| 42 | +// IWYU pragma: begin_exports |
39 | 43 | #include "src/CholmodSupport/CholmodSupport.h" |
| 44 | +// IWYU pragma: end_exports |
40 | 45 |
|
41 | 46 | #include "src/Core/util/ReenableStupidWarnings.h" |
42 | 47 |
|
43 | | -#endif // EIGEN_CHOLMODSUPPORT_MODULE_H |
44 | | - |
| 48 | +#endif // EIGEN_CHOLMODSUPPORT_MODULE_H |
0 commit comments