diff options
| author |  Thomas Capricelli <orzel@freehackers.org> | 2009-11-09 03:07:36 +0100 |
|---|---|---|
| committer | Thomas Capricelli <orzel@freehackers.org> | 2009-11-09 03:07:36 +0100 |
| commit | cddc83752c926be15a2d08d49d560406de6985d0 (patch) | |
| tree | 156331450037cc8f713176113a7830a43c8e86a0 | |
| parent | ecbcdafb0fb039a0496e9209f10bb67793843608 (diff) | |
starting documentation
| -rw-r--r-- | unsupported/Eigen/AutoDiff | 3 | ||||
| -rw-r--r-- | unsupported/Eigen/NonLinear | 3 | ||||
| -rw-r--r-- | unsupported/Eigen/NumericalDiff | 5 | ||||
| -rw-r--r-- | unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h | 8 |
4 files changed, 16 insertions, 3 deletions
diff --git a/unsupported/Eigen/AutoDiff b/unsupported/Eigen/AutoDiff index 2bf8de6f6..c6f6ba0b2 100644 --- a/unsupported/Eigen/AutoDiff +++ b/unsupported/Eigen/AutoDiff @@ -35,6 +35,9 @@ namespace Eigen { * This module features forward automatic differentation via a simple * templated scalar type wrapper AutoDiffScalar. * + * Warning : this should NOT be confused with numerical differentiation, which + * is a different method and has its own module in Eigen. + * * \code * #include <unsupported/Eigen/AutoDiff> * \endcode diff --git a/unsupported/Eigen/NonLinear b/unsupported/Eigen/NonLinear index 334b6d65d..d4f18f077 100644 --- a/unsupported/Eigen/NonLinear +++ b/unsupported/Eigen/NonLinear @@ -31,8 +31,7 @@ namespace Eigen { /** \ingroup Unsupported_modules - * \defgroup NonLinear Support for non linear optimization and non linear least - * square using minpack routines. + * \defgroup NonLinearOptimization_Module Non linear optimization module * * \code * #include <unsupported/Eigen/NonLinear> diff --git a/unsupported/Eigen/NumericalDiff b/unsupported/Eigen/NumericalDiff index 991ce7c35..82a070d93 100644 --- a/unsupported/Eigen/NumericalDiff +++ b/unsupported/Eigen/NumericalDiff @@ -30,9 +30,12 @@ namespace Eigen { /** \ingroup Unsupported_modules - * \defgroup NumericalDiff_Module Support for numerical differenciation. + * \defgroup NumericalDiff_Module Numerical differenciation module * See http://en.wikipedia.org/wiki/Numerical_differentiation * + * Warning : this should NOT be confused with automatic differentiation, which + * is a different method and has its own module in Eigen. + * * \code * #include <unsupported/Eigen/NumericalDiff> * \endcode diff --git a/unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h b/unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h index f541c385b..27c6a5f15 100644 --- a/unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h +++ b/unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h @@ -1,4 +1,12 @@ + +/** + * \brief Performs non linear optimization over a non-linear function, + * using a variant of the Levenberg Marquardt algorithm. + * + * Check wikipedia for more information. + * http://en.wikipedia.org/wiki/Levenberg%E2%80%93Marquardt_algorithm + */ template<typename FunctorType, typename Scalar=double> class LevenbergMarquardt { |