aboutsummaryrefslogtreecommitdiffhomepage
path: root/unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h
diff options
context:
space:
mode:
authorGravatar Thomas Capricelli <orzel@freehackers.org>2009-11-09 03:07:36 +0100
committerGravatar Thomas Capricelli <orzel@freehackers.org>2009-11-09 03:07:36 +0100
commitcddc83752c926be15a2d08d49d560406de6985d0 (patch)
tree156331450037cc8f713176113a7830a43c8e86a0 /unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h
parentecbcdafb0fb039a0496e9209f10bb67793843608 (diff)
starting documentation
Diffstat (limited to 'unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h')
-rw-r--r--unsupported/Eigen/src/NonLinear/LevenbergMarquardt.h8
1 files changed, 8 insertions, 0 deletions
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
{