Clean up documentation and code examples in public headers

- Fix code examples in comments across autodiff_cost_function.h,
  numeric_diff_cost_function.h, conditioned_cost_function.h,
  cubic_interpolation.h, dynamic_cost_function_to_functor.h,
  dynamic_numeric_diff_cost_function.h, gradient_problem.h,
  loss_function.h, and numeric_diff_first_order_function.h.
- Fix function_tolerance sign and gradient_tolerance formula in
  solver.h, gradient_problem_solver.h, tiny_solver.h, and types.h.
- Fix outdated option/parameter references in comments across
  gradient_checker.h, gradient_problem_solver.h, numeric_diff_options.h,
  solver.h, and types.h.
- Fix include path for ceres/internal/parameter_dims.h and
  static_assert message in sized_cost_function.h.
- Fix typos, duplicate words, grammar, and capitalization in header
  comments.

Change-Id: I11cb8fca41117654bf872196c97bd6b007cda637
37 files changed
tree: 6529bcb370363807c83e6f5bb8fa0fc697bc52e5
  1. .github/
  2. bazel/
  3. cmake/
  4. config/
  5. data/
  6. docs/
  7. examples/
  8. include/
  9. internal/
  10. scripts/
  11. third_party/
  12. .bazelignore
  13. .clang-format
  14. .gitignore
  15. .gitmodules
  16. .readthedocs.yaml
  17. BUILD
  18. CITATION.cff
  19. CMakeLists.txt
  20. CONTRIBUTING.md
  21. LICENSE
  22. MODULE.bazel
  23. package.xml
  24. README.md
  25. WORKSPACE
README.md

Android Linux macOS Windows

Ceres Solver

Ceres Solver is an open source C++ library for modeling and solving large, complicated optimization problems. It is a feature rich, mature and performant library which has been used in production at Google since 2010. Ceres Solver can solve two kinds of problems.

  1. Non-linear Least Squares problems with bounds constraints.
  2. General unconstrained optimization problems.

Please see ceres-solver.org for more information.