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 @@ -22,6 +22,9 @@ namespace Eigen { /** \ingroup Unsupported_modules * \defgroup BVH_Module */ +/** \ingroup Unsupported_modules + * \defgroup FFT_Module */ + /** \ingroup Unsupported_modules * \defgroup IterativeSolvers_Module */ 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 #include + +/** \ingroup Unsupported_modules + * \defgroup FFT_Module Fast Fourier Transform module + * + * \code + * #include + * \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