Commit Graph

51 Commits

Author SHA1 Message Date
Sameer Agarwal fa21df8cd9 Add script for building documentation.
Update make_release

Minor documentation fixes.

Change-Id: I1248ec3f58be66b5929aee6f2aa392c15d53ed83
2013-02-18 09:22:08 -08:00
Sameer Agarwal fbbea464d1 Update documentation.
Change-Id: Idb03741fab9facbbbda85d5a82723f0b4c1c6c60
2013-02-15 14:29:51 -08:00
Sameer Agarwal efb47f39c3 Documentation update
Change-Id: I0fec43bff4fe0ea6cd2d2a8b34dac2330a517da0
2013-02-15 17:10:50 +00:00
Sameer Agarwal 0abfb8f46f Delete the tex documentation.
Change-Id: I15c78a8b33c5fd94941238814ac023a8fb251a20
2013-02-11 13:40:04 -08:00
Sameer Agarwal 085cd4a664 Rewrite of the tutorial.
1. Quicker starting point.
2. Better discussion of derivatives.
3. Better hyperlinking to code and class documentation.
4. New robust estimation example.
5. Better naming of example code.
6. Removed dependency on gflags in all the core examples covered
   in the tutorial.

Change-Id: Ibf3c7fe946fa2b4d22f8916a9366df267d34ca26
2013-02-11 13:37:43 -08:00
Sameer Agarwal d91b671798 More small changes
More small changes to the docs.

1. Better landing page.
2. Minor tweaks to the side bar.
3. Reference to more example code.
4. Local MathJax references.

Change-Id: I39b9436dc2803732a875bbbee7f15802c4934031
2013-02-06 01:28:58 -08:00
Sameer Agarwal 08c891fcb6 Various small changes.
1. Compact build instructions.
2. Lots of small edits by Simon Fuhrmann.

Change-Id: I8c0c67922021041dcf7f4ecdb6c6e6dd2e2fd7e5
2013-02-05 23:35:01 -08:00
Sameer Agarwal e2e857ad6b Sidebar has global table of contents.
Change-Id: I7fe9053868a4660b0db8d7607ee618fc30ddaefd
2013-02-04 19:40:45 -08:00
Sameer Agarwal b9182147d9 Change the theme to be closer to ReadTheDocs.org
Change-Id: I61a76f5b5e5c292b54fdf51b66940ce80bd1cd5f
2013-02-04 17:55:25 -08:00
Sameer Agarwal 3d87b72c89 Convert documentation from LaTeX to Sphinx.
A live version of the doc can be found at

http://homes.cs.washington.edu/~sagarwal/ceres-solver/

As it stands, the documentation has better hyperlinking
and coverage than the latex documentation now.

Change-Id: I7ede3aa83b9b9ef25104caf331e5727b4f5beae5
2013-02-04 17:09:39 -08:00
Sameer Agarwal 146b9acb4d Update include/ceres.h to export headers.
Update the ABI version.

Change-Id: I5c1c4f110cddc816bbb5a737634f55b4cbea98e1
2013-01-22 10:40:56 -08:00
Sameer Agarwal e837aeaf9e Documentation update.
Change-Id: Ica8681f4bb58c60349d0dae453c652f2522eebf6
2013-01-21 22:47:46 +00:00
Sameer Agarwal 8af9ebf38c Update changelog.
Change-Id: I055b304b691ebbafbd93368f23ed9e6d4b2288e5
2012-11-17 15:13:22 -08:00
Sameer Agarwal c811d010c0 Documentation bug fixes.
Thanks Vladimir Chalupecky

Change-Id: I52a11d75adbf7adb1233c4d5ec2bc599448ab240
2012-11-01 10:22:11 -07:00
Sameer Agarwal 583019b8df Drop spurious changelog update.
Change-Id: I496b497b05758b697aa9f287e79509acf72dd3bd
2012-10-12 14:01:16 -07:00
Sameer Agarwal f5a7d9a73c Changelog update.
Change-Id: Ic2f141c8fdb2c1092f363032956133a933036ff0
2012-10-12 12:31:11 -07:00
Sameer Agarwal 68b32a941c ordering -> linear_solver_ordering.
Change-Id: If4af72da90725db2a2d4f397f4cb671c2e863a98
2012-10-06 23:16:04 -07:00
Sameer Agarwal ba8d967f8c Generalization of the inner iterations algorithm.
Add automatic recursive independent set decomposition.
Clean up the naming and the API for inner iterations.

Change-Id: I3d7d6babb9756842d7367e14b7279d2df98fb724
2012-10-05 08:35:53 -07:00
Sameer Agarwal faf88a1b51 Documentation update.
Change-Id: Ic5f209da760562aa89a822f7e5853c5639a427eb
2012-09-26 16:33:21 -07:00
Ricardo Martin f9a7ce831e Correct snavely reprojection error in code and doc.
The snavely reprojection error is wrong both in the sample code and
in the documentation. It should not multiply by the focal length
before calculating the distortion.

Change-Id: I292af962e634506a7cc57af9ce72b08f81ce3425
2012-09-21 12:14:44 -07:00
Sameer Agarwal 65625f7782 Solver::Options::ordering* are dead.
Remove the old ordering API, and modify solver_impl.cc
to use the new API everywhere.

In the process also clean up the linear solver instantion
logic in solver_impl.cc a bit too.

Change-Id: Ia66898abc7f622070b184b21fce8cc6140c4cebf
2012-09-17 15:41:10 -07:00
Sameer Agarwal 0b776b5cc9 Update docs.
Change-Id: I69d50bcd37aed3bea2190ca614f023e83172901b
2012-08-31 11:04:24 -07:00
Sameer Agarwal 98bf14d2b9 Miscellaneous fixes.
Change-Id: I521e11f2d20bf24960bbc6b5dab4ec8bb1503d23
2012-08-30 10:26:44 -07:00
Sameer Agarwal 8b64140878 Documentation update
Change-Id: I271a0422e7f6f42bcfd1dc6b5dc10c7a18f6a179
2012-08-29 05:41:22 -07:00
Sameer Agarwal 122cf836a6 Documentation update.
Change-Id: I0a3c5ae4bc981a8f5bdd5a8905f923dc5f09a024
2012-08-27 14:29:21 -07:00
Sameer Agarwal 1762420b6e Update changelog.
Change-Id: Idf5af69d5a9dbe35f58e30a8afcbfcd29bb7ebfe
2012-08-24 10:24:02 -07:00
Sameer Agarwal aecb2dc92b Fix relative path bug in bibtex call.
Change-Id: I0d31786564320a6831259bcdf4c75a6b665c43ad
2012-08-22 10:08:17 -07:00
Arnaud Gelas 3d644b76ad Install headers, libraries and pdf
Headers are installed in ${CMAKE_INSTALL_PREFIX}/include/ceres
Libraries are installed in ${CMAKE_INSTALL_PREFIX}/lib
pdf is installed in ${CMAKE_INSTALL_PREFIX}/share/ceres/docs

Change-Id: Ic175f2c2f5fa86820a1e8c64c2ed171f4a302a68
2012-08-21 09:40:59 +02:00
Arnaud Gelas b12b906c4d Add one option to generate the PDF from CMake at build time
Make sure pygmentize is installed

Change-Id: I068ba45c33a8e96acc906a464b12d10d58b3e231
2012-08-20 09:13:21 +02:00
Sameer Agarwal 7006a1f2b1 Correct example code in Powell's function example.
Thanks to Petter Strandmark for pointing this out.

Change-Id: I967632235dccdb481396e94904bb911c9a1efe1e
2012-08-16 18:04:22 -07:00
Keir Mierle e210e2f21c Add build instructions for Windows.
Change-Id: I5008765498dda39d058c9a89fdab070c92e58fbc
2012-07-19 12:03:36 -07:00
Sameer Agarwal 3e3b892605 Update changelog for 1.3.0 release
Change-Id: Iab3060c3e2e29873c3e576c2c9232d3afdd37cd7
2012-07-19 10:54:57 -07:00
Sameer Agarwal 4997cbc437 Return jacobians and gradients to the user.
1. Added CRSMatrix object which will store the initial
   and final jacobians if requested by the user.
2. Conversion routine and test for converting a
   CompressedRowSparseMatrix to CRSMatrix.
3. New Evaluator::Evaluate function to do the actual evaluation.
4. Changes to Program::StateVectorToParmeterBlocks and
   Program::SetParameterBlockStatePtrstoUserStatePtrs so that
   they do not try to set the state of constant parameter blocks.
5. Tests for Evaluator::Evaluate.
6. Minor cleanups in SolverImpl.
7. Minor cpplint cleanups triggered by this CL.

Change-Id: I3ac446484692f943c28f2723b719676f8c83ca3d
2012-07-16 12:17:34 -07:00
Sameer Agarwal 57a3458e56 changes.tex updated for 1.2.3 release
Change-Id: Ia0f8c6321e55f4dbcae8e8e4a4053fc814d32413
2012-06-24 12:42:36 -07:00
Sameer Agarwal 46d4b1d80b Fixed quadratic.cc documentation and code mismatch.
The hello world example, quadratic.cc and its description
in the tutorial were out of sync and led to some confusion
about the convergence behaviour. This change fixes the tex
file to match the code and discusses whats actually going
on when determining convergence.

Thanks to Nick Lewycky for reporting this.

Change-Id: Ic301d854c3f3d11e37a252e0832c00fb9e3a307c
2012-06-22 11:26:22 -07:00
Keir Mierle 2993770288 Update changes.tex for 1.2.2
Change-Id: I8ed7e01374e2d5de54b7f9d25bfd7a5aa2da9a38
2012-06-19 00:41:11 -07:00
Keir Mierle 64f1410272 Add to the changes for 1.2.1.
Change-Id: I94d2fa8ffec478950c14649fc761ff7d17dbc0d1
2012-06-18 00:57:59 -07:00
Sameer Agarwal 97fb6d9715 Documentation & Logging cleanups.
1. Document the use of dogleg and a general discussion of
   trust region methods.
2. Added a TBD section on compiler/linker flags.
3. Summary::FullReport now prints out sparse_linear_algebra_library
   and trust_region_strategy_type.

Change-Id: I01f680070d510715900f345364855689005d54bb
2012-06-17 18:59:34 -07:00
Sameer Agarwal 8ed29a77fa Documentation update.
1. Renamed ceres.tex to ceres-solver.tex
2. Updated Solver::Options docs to reflect the recent changes.
3. Updated .gitignore to ignore ceres-solver.pdf

Change-Id: Iea19f8ff5fa1638a498422c8be5ed2e6da2950c9
2012-06-07 17:55:03 -07:00
Sameer Agarwal d3eaa489bf Restructure the documentation.
1. Split into two parts - Tutorial & Reference.
2. Reference is split into Modeling and Solving.
3. Build instructions now mention CXSparse.

Change-Id: Id67fa1134f3fc2b2cea9ccf2f32d5b16d435ba6e
2012-05-30 19:49:51 -07:00
Sameer Agarwal ba3ccfbdcf Corrected the SuiteSparse url (thanks Keith Briggs). 2012-05-22 06:58:47 -07:00
Sameer Agarwal 835911ec94 Add a lower bound on the regularization constant in LM.
In some cases the Levenberg-Marquardt can oscillate between,
two values of the regularizer mu. A small value which causes
the linear solver to fail and a higher value at which the solver
makes progress. This can cause significant wastage of solver
effort, and mu should just be clamped to some value.

This CL provides this setting as Solver::Options::min_mu,
and updates the documentation to reflect this.
2012-05-14 12:41:10 -07:00
Sameer Agarwal 921e8abbcd Documentation for build semantics, CGNR and linear least squares dumping to disk 2012-05-13 11:39:47 -07:00
Sameer Agarwal 0e99e9c02c Changed the title of the manual to not track the version number, as it is still in flux and doesn't add much to the discussion. Added a way to cite the manual when referring to Ceres in a publication 2012-05-10 09:45:05 -07:00
Sameer Agarwal da3e0563cc Typo corrections in the documentation from Bing 2012-05-09 12:52:59 -07:00
Sameer Agarwal 7646039ad9 Kashif's corrections to the docs 2012-05-06 22:02:19 -07:00
Sameer Agarwal 0d2d34148d glog minimum version requirements
Building Ceres requires version 0.3.1 or better of glog.
Fedora 16 ships with a busted version 0.3.

issue 15 contains the gory details.

Added a note to the build documentation to this effect.
2012-05-06 21:16:03 -07:00
Sameer Agarwal 6447219826 1. Changes the tutorial to refer to BriefReport.
2. Some of the enums have commas at the end.
3. Fix a bug in the default value of circle_fit.cc in the examples.
2012-05-03 21:53:07 -07:00
Sameer Agarwal 017c9530df Mac OS X build instructions are much simpler, as homebrew takes care of gflags when glog is brought in. Also CMAKE does not need any flags to do the default thing 2012-05-02 08:21:59 -07:00
Sameer Agarwal 17fbc8ebb8 Minor changes to the documentation. Formatting, and typos. 2012-05-01 00:21:19 -07:00