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

doc : update code, mention examples

Browse Source
This commit is contained in:
Thomas Capricelli 2010-01-27 08:14:50 +01:00
parent 4365a48748
commit e97529c2e3
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
unsupported/Eigen/NonLinearOptimization
View File

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