mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-09-14 18:33:16 +08:00
make the complex module appear in doxygen + small documentation
This commit is contained in:
parent
d47a723a6e
commit
2612bbdf8b
@ -22,6 +22,9 @@ namespace Eigen {
|
||||
/** \ingroup Unsupported_modules
|
||||
* \defgroup BVH_Module */
|
||||
|
||||
/** \ingroup Unsupported_modules
|
||||
* \defgroup Complex_Module */
|
||||
|
||||
/** \ingroup Unsupported_modules
|
||||
* \defgroup FFT_Module */
|
||||
|
||||
|
@ -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 {
|
||||
|
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user