Rationalize some of the variable names in Solver::Options.
lm_max_diagonal -> max_lm_diagonal
lm_min_diagonal -> min_lm_diagonal
linear_solver_max_num_iterations -> max_linear_solver_iterations
linear_solver_min_num_iterations -> min_linear_solver_iterations
This follows the pattern for the other parameters in Solver::Options
where, the max/min is the first word followed by the name of the
parameter.
Change-Id: I0893610fceb6b7983fdb458a65522ba7079596a7
diff --git a/docs/source/solving.rst b/docs/source/solving.rst
index 9f6cb6b..99189e7 100644
--- a/docs/source/solving.rst
+++ b/docs/source/solving.rst
@@ -933,7 +933,7 @@
Lower threshold for relative decrease before a trust-region step is
accepted.
-.. member:: double Solver::Options::lm_min_diagonal
+.. member:: double Solver::Options::min_lm_diagonal
Default: ``1e6``
@@ -941,7 +941,7 @@
regularize the the trust region step. This is the lower bound on
the values of this diagonal matrix.
-.. member:: double Solver::Options::lm_max_diagonal
+.. member:: double Solver::Options::max_lm_diagonal
Default: ``1e32``
@@ -1071,7 +1071,7 @@
expense of an extra copy of the Jacobian matrix. Setting
``use_postordering`` to ``true`` enables this tradeoff.
-.. member:: int Solver::Options::linear_solver_min_num_iterations
+.. member:: int Solver::Options::min_linear_solver_iterations
Default: ``1``
@@ -1079,7 +1079,7 @@
makes sense when the linear solver is an iterative solver, e.g.,
``ITERATIVE_SCHUR`` or ``CGNR``.
-.. member:: int Solver::Options::linear_solver_max_num_iterations
+.. member:: int Solver::Options::max_linear_solver_iterations
Default: ``500``
