mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-02-17 18:09:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

make FFT appear in doxygen doc, and provide a mininum of documentation

Browse Source
This commit is contained in:
Thomas Capricelli 2009-11-10 21:58:17 +01:00
parent 2c9f46d151
commit d47a723a6e
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/unsupported_modules.dox
View File

@ -22,6 +22,9 @@ namespace Eigen {
/** \ingroup Unsupported_modules
* \defgroup BVH_Module */
/** \ingroup Unsupported_modules
* \defgroup FFT_Module */
/** \ingroup Unsupported_modules
* \defgroup IterativeSolvers_Module */

22
unsupported/Eigen/FFT
View File

@ -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>