saberbud/ceres-solver
1
0
Fork 0
mirror of https://github.com/ceres-solver/ceres-solver.git synced 2026-08-29 08:34:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix Solver::Options in documentation

Browse Source 
Change-Id: Ia01fdba7561aac539ce96f09b3d404cbe061de11
This commit is contained in:
MaximSmolskiy
2023-08-29 05:53:36 +03:00
parent de62bf2204
commit ed9921fc24
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/nnls_solving.rst
+11 -4
View File
@@ -986,7 +986,7 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: int Solver::Options::max_lbfgs_rank
Default: 20
Default: ``20``
The L-BFGS hessian approximation is a low rank approximation to the
inverse of the Hessian matrix. The rank of the approximation
@@ -1054,6 +1054,8 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: double Solver::Options::min_line_search_step_size
Default: ``1e-9``
The line search terminates if:
.. math:: \|\Delta x_k\|_\infty < \text{min_line_search_step_size}
@@ -1208,7 +1210,8 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: double Solver::Options::max_solver_time_in_seconds
Default: ``1e6``
Default: ``1e9``
Maximum amount of time for which the solver should run.
.. member:: int Solver::Options::num_threads
@@ -1376,7 +1379,7 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: DenseLinearAlgebraLibrary Solver::Options::dense_linear_algebra_library_type
Default:``EIGEN``
Default: ``EIGEN``
Ceres supports using multiple dense linear algebra libraries for
dense matrix factorizations. Currently ``EIGEN``, ``LAPACK`` and
@@ -1481,6 +1484,8 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: bool Solver::Options::dynamic_sparsity
Default: ``false``
Some non-linear least squares problems are symbolically dense but
numerically sparse. i.e. at any given state only a small number of
Jacobian entries are non-zero, but the position and number of
@@ -1686,7 +1691,7 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
:member:`Solver::Options::trust_region_problem_dump_format_type` is not
``CONSOLE``.
.. member:: DumpFormatType Solver::Options::trust_region_problem_dump_format
.. member:: DumpFormatType Solver::Options::trust_region_problem_dump_format_type
Default: ``TEXTFILE``
@@ -1782,6 +1787,8 @@ b. ``linear_solver_type = SPARSE_SCHUR/DENSE_SCHUR/ITERATIVE_SCHUR``
.. member:: vector<IterationCallback> Solver::Options::callbacks
Default: ``empty``
Callbacks that are executed at the end of each iteration of the
:class:`Minimizer`. They are executed in the order that they are
specified in this vector.