docs/source/index.rst

   1 ============
   2 Ceres Solver
   3 ============
   4
   5 Ceres Solver [#f1]_ is an open source C++ library for modeling and
   6 solving large, complicated optimization problems. It can be used to
   7 solve `Non-linear Least Squares`_ problems with bounds constraints and
   8 general unconstrained optimization problems. It is a mature, feature
   9 rich, and performant library that has been used in production at
  10 Google since 2010. For more, see :doc:`features`.
  11
  12 `ceres-solver@googlegroups.com
  13 <https://groups.google.com/forum/?fromgroups#!forum/ceres-solver>`_ is
  14 the place for discussions and questions about Ceres Solver. We use the
  15 `GitHub Issue Tracker
  16 <https://github.com/ceres-solver/ceres-solver/issues>`_ to manage bug
  17 reports and feature requests.
  18
  19
  20 .. toctree::
  21    :maxdepth: 1
  22    :hidden:
  23
  24    features
  25    installation
  26    tutorial
  27    derivatives
  28    nnls_modeling
  29    nnls_solving
  30    nnls_covariance
  31    gradient_solver
  32    faqs
  33    users
  34    contributing
  35    version_history
  36    bibliography
  37    license
  38
  39 .. _Non-linear Least Squares: http://en.wikipedia.org/wiki/Non-linear_least_squares
  40
  41
  42 Cite Us
  43 =======
  44
  45 If you use Ceres Solver for a publication, please cite it as::
  46
  47     @misc{ceres-solver,
  48       author = "Sameer Agarwal and Keir Mierle and Others",
  49       title = "Ceres Solver",
  50       howpublished = "\url{http://ceres-solver.org}",
  51     }
  52
  53
  54 .. rubric:: Footnotes
  55
  56 .. [#f1] While there is some debate as to who invented the method of
  57          Least Squares [Stigler]_, there is no questioning the fact
  58          that it was `Carl Friedrich Gauss
  59          <http://www-groups.dcs.st-and.ac.uk/~history/Biographies/Gauss.html>`_
  60          who brought it to the attention of the world. Using just 22
  61          observations of the newly discovered asteroid `Ceres
  62          <http://en.wikipedia.org/wiki/Ceres_(dwarf_planet)>`_, Gauss
  63          used the method of least squares to correctly predict when
  64          and where the asteroid will emerge from behind the Sun
  65          [TenenbaumDirector]_. We named our solver after Ceres to
  66          celebrate this seminal event in the history of astronomy,
  67          statistics and optimization.