diff options
author | Thomas Capricelli <orzel@freehackers.org> | 2010-01-27 08:14:50 +0100 |
---|---|---|
committer | Thomas Capricelli <orzel@freehackers.org> | 2010-01-27 08:14:50 +0100 |
commit | e97529c2e3cf5006ff9252d34ae6ae5bc010c159 (patch) | |
tree | 920d2ea6b69cedfbd78fc061f3a3915ece1f4770 /unsupported/Eigen/NonLinearOptimization | |
parent | 4365a48748b3aeb6c15178b8471b1a5a8e0e9802 (diff) |
doc : update code, mention examples
Diffstat (limited to 'unsupported/Eigen/NonLinearOptimization')
-rw-r--r-- | unsupported/Eigen/NonLinearOptimization | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/unsupported/Eigen/NonLinearOptimization b/unsupported/Eigen/NonLinearOptimization index 432d94d93..8d8f4fe43 100644 --- a/unsupported/Eigen/NonLinearOptimization +++ b/unsupported/Eigen/NonLinearOptimization @@ -108,19 +108,23 @@ namespace Eigen { * handle the loop: init + loop until a stop condition is met. Those are provided for * convenience. * - * As an example, the method LevenbergMarquardt.minimizeNumericalDiff() is + * As an example, the method LevenbergMarquardt::minimize() is * implemented as follow : * \code - * LevenbergMarquardt.minimizeNumericalDiff(Matrix< Scalar, Dynamic, 1 > &x, - * const int mode ) + * Status LevenbergMarquardt<FunctorType,Scalar>::minimize(FVectorType &x, const int mode) * { - * Status status = minimizeNumericalDiffInit(x, mode); - * while (status==Running) - * status = minimizeNumericalDiffOneStep(x, mode); + * Status status = minimizeInit(x, mode); + * do { + * status = minimizeOneStep(x, mode); + * } while (status==Running); * return status; * } * \endcode * + * \section examples Examples + * + * The easiest way to understand how to use this module is by looking at the many examples in the file + * unsupported/test/NonLinearOptimization.cpp. */ #ifndef EIGEN_PARSED_BY_DOXYGEN |