diff options
| author |  Thomas Capricelli <orzel@freehackers.org> | 2009-11-10 22:02:10 +0100 |
|---|---|---|
| committer | Thomas Capricelli <orzel@freehackers.org> | 2009-11-10 22:02:10 +0100 |
| commit | 2612bbdf8bf31a2d9ae1d99e5aa57d1adf3ea634 (patch) | |
| tree | 053d10004bd59d1d9b08372a72765a44e83af4c6 /unsupported/Eigen | |
| parent | d47a723a6e94015662b5004dc4c0a569b23ac65c (diff) | |
make the complex module appear in doxygen + small documentation
Diffstat (limited to 'unsupported/Eigen')
| -rw-r--r-- | unsupported/Eigen/Complex | 13 | ||||
| -rw-r--r-- | unsupported/Eigen/FFT | 2 |
2 files changed, 13 insertions, 2 deletions
diff --git a/unsupported/Eigen/Complex b/unsupported/Eigen/Complex index 04228c95a..1232782ad 100644 --- a/unsupported/Eigen/Complex +++ b/unsupported/Eigen/Complex @@ -28,7 +28,18 @@ // Eigen::Complex reuses as much as possible from std::complex // and allows easy conversion to and from, even at the pointer level. - +/** \ingroup Unsupported_modules + * \defgroup Complex_Module Complex module + * + * \code + * #include <unsupported/Eigen/Complex> + * \endcode + * + * The C++ complex type has some severe limitations that prevent an + * optimal use within Eigen. This (still unsupported) module is an attempt + * to fix this. + */ + #include <complex> namespace Eigen { diff --git a/unsupported/Eigen/FFT b/unsupported/Eigen/FFT index c143ef5bb..c8521bbf0 100644 --- a/unsupported/Eigen/FFT +++ b/unsupported/Eigen/FFT @@ -35,7 +35,7 @@ * \defgroup FFT_Module Fast Fourier Transform module * * \code - * #include <unsupported/Eigen/NonLinearOptimization> + * #include <unsupported/Eigen/FFT> * \endcode * * This module provides Fast Fourier transformation, either using a built-in implementation |