diff options
author | Thomas Capricelli <orzel@freehackers.org> | 2009-11-10 21:58:17 +0100 |
---|---|---|
committer | Thomas Capricelli <orzel@freehackers.org> | 2009-11-10 21:58:17 +0100 |
commit | d47a723a6e94015662b5004dc4c0a569b23ac65c (patch) | |
tree | ee1e1b4a85022958d0b1412d415e5a38195b752f | |
parent | 2c9f46d1513350735e960e6fadc3750176ab0426 (diff) |
make FFT appear in doxygen doc, and provide a mininum of documentation
-rw-r--r-- | doc/unsupported_modules.dox | 3 | ||||
-rw-r--r-- | unsupported/Eigen/FFT | 22 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/unsupported_modules.dox b/doc/unsupported_modules.dox index 4b56922dc..455e80860 100644 --- a/doc/unsupported_modules.dox +++ b/doc/unsupported_modules.dox @@ -23,6 +23,9 @@ namespace Eigen { * \defgroup BVH_Module */ /** \ingroup Unsupported_modules + * \defgroup FFT_Module */ + +/** \ingroup Unsupported_modules * \defgroup IterativeSolvers_Module */ /** \ingroup Unsupported_modules diff --git a/unsupported/Eigen/FFT b/unsupported/Eigen/FFT index 8f7a2fcae..c143ef5bb 100644 --- a/unsupported/Eigen/FFT +++ b/unsupported/Eigen/FFT @@ -30,6 +30,28 @@ #include <map> #include <Eigen/Core> + +/** \ingroup Unsupported_modules + * \defgroup FFT_Module Fast Fourier Transform module + * + * \code + * #include <unsupported/Eigen/NonLinearOptimization> + * \endcode + * + * This module provides Fast Fourier transformation, either using a built-in implementation + * or as a frontend to various FFT libraries. + * + * The build-in implementation is based on kissfft. It is a small, free, and + * reasonably efficient default. + * + * Frontends are + * + * - fftw (http://www.fftw.org) : faster, GPL -- incompatible with Eigen in LGPL form, bigger code size. + * - MLK (http://en.wikipedia.org/wiki/Math_Kernel_Library) : fastest, commercial -- may be incompatible with Eigen in GPL form + * + */ + + #ifdef EIGEN_FFTW_DEFAULT // FFTW: faster, GPL -- incompatible with Eigen in LGPL form, bigger code size # include <fftw3.h> |