Homogenize convergence operators in docs and code

Change-Id: Iec7c12e971b331d1847f9aa91349317eb6524856
This commit is contained in:
Johannes Schönberger
2015-04-15 17:21:56 -04:00
parent 365084f976
commit 239dd59ea5
4 changed files with 20 additions and 10 deletions
+14 -4
View File
@@ -327,11 +327,10 @@ Solving
Solver terminates if
.. math:: \frac{|\Delta \text{cost}|}{\text{cost}} < \text{function_tolerance}
.. math:: \frac{|\Delta \text{cost}|}{\text{cost}} <= \text{function_tolerance}
where, :math:`\Delta \text{cost}` is the change in objective
function value (up or down) in the current iteration of
Levenberg-Marquardt.
function value (up or down) in the current iteration of the line search.
.. member:: double GradientProblemSolver::Options::gradient_tolerance
@@ -339,13 +338,24 @@ Solving
Solver terminates if
.. math:: \|x - \Pi \boxplus(x, -g(x))\|_\infty < \text{gradient_tolerance}
.. math:: \|x - \Pi \boxplus(x, -g(x))\|_\infty <= \text{gradient_tolerance}
where :math:`\|\cdot\|_\infty` refers to the max norm, :math:`\Pi`
is projection onto the bounds constraints and :math:`\boxplus` is
Plus operation for the overall local parameterization associated
with the parameter vector.
.. member:: double GradientProblemSolver::Options::parameter_tolerance
Default: ``1e-8``
Solver terminates if
.. math:: \|\Delta x\| <= (\|x\| + \text{parameter_tolerance}) * \text{parameter_tolerance}
where :math:`\Delta x` is the step computed by the linear solver in
the current iteration of the line search.
.. member:: LoggingType GradientProblemSolver::Options::logging_type
Default: ``PER_MINIMIZER_ITERATION``
+4 -4
View File
@@ -1156,7 +1156,7 @@ elimination group [LiSaad]_.
Solver terminates if
.. math:: \frac{|\Delta \text{cost}|}{\text{cost}} < \text{function_tolerance}
.. math:: \frac{|\Delta \text{cost}|}{\text{cost}} <= \text{function_tolerance}
where, :math:`\Delta \text{cost}` is the change in objective
function value (up or down) in the current iteration of
@@ -1168,7 +1168,7 @@ elimination group [LiSaad]_.
Solver terminates if
.. math:: \|x - \Pi \boxplus(x, -g(x))\|_\infty < \text{gradient_tolerance}
.. math:: \|x - \Pi \boxplus(x, -g(x))\|_\infty <= \text{gradient_tolerance}
where :math:`\|\cdot\|_\infty` refers to the max norm, :math:`\Pi`
is projection onto the bounds constraints and :math:`\boxplus` is
@@ -1181,10 +1181,10 @@ elimination group [LiSaad]_.
Solver terminates if
.. math:: \|\Delta x\| < (\|x\| + \text{parameter_tolerance}) * \text{parameter_tolerance}
.. math:: \|\Delta x\| <= (\|x\| + \text{parameter_tolerance}) * \text{parameter_tolerance}
where :math:`\Delta x` is the step computed by the linear solver in
the current iteration of Levenberg-Marquardt.
the current iteration.
.. member:: LinearSolverType Solver::Options::linear_solver_type