GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-15 02:43:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

make the complex module appear in doxygen + small documentation

Browse Source
This commit is contained in:
Thomas Capricelli 2009-11-10 22:02:10 +01:00
parent d47a723a6e
commit 2612bbdf8b
3 changed files with 16 additions and 2 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 /** \ingroup Unsupported_modules
* \defgroup BVH_Module */ * \defgroup BVH_Module */
/** \ingroup Unsupported_modules
* \defgroup Complex_Module */
/** \ingroup Unsupported_modules /** \ingroup Unsupported_modules
* \defgroup FFT_Module */ * \defgroup FFT_Module */

13
unsupported/Eigen/Complex
View File

@ -28,7 +28,18 @@
// Eigen::Complex reuses as much as possible from std::complex // Eigen::Complex reuses as much as possible from std::complex
// and allows easy conversion to and from, even at the pointer level. // 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> #include <complex>
namespace Eigen { namespace Eigen {

2
unsupported/Eigen/FFT
View File

@ -35,7 +35,7 @@
* \defgroup FFT_Module Fast Fourier Transform module * \defgroup FFT_Module Fast Fourier Transform module
* *
* \code * \code
* #include <unsupported/Eigen/NonLinearOptimization> * #include <unsupported/Eigen/FFT>
* \endcode * \endcode
* *
* This module provides Fast Fourier transformation, either using a built-in implementation * This module provides Fast Fourier transformation, either using a built-in implementation