Documentation following Diataxis

[ivan-pi]

The documentation should follow the Diataxis framework (https://diataxis.fr/).

Here are a few possible sub-topics:

reference

• description
  • which method is used
  • which factorizations are used
• additional links
  • original library
  • method used
  • data structures
• other nonlinear least squares solvers

tutorial

• learn to use libdogleg-f via a curve-fitting example
• determining the equivalent point of a titration
  • (not the perfect example, because we need to find the derivative, and minimum)
• camera calibration
• computer vision, fitting a rectangle to an image
• variable scaling for ill-conditioned problems

explanation

• stating the problem dimensions (explicit vs implicit)
  • generic functions (retrieve size from dummy arrays)
  • retrieve sizes, via host association
  • global variables
• sparse vs dense jacobians
• libdogleg-f internals and the adaptor pattern

how to's

• how to re-use an existing callback in libdogleg
• installing libdogleg dependencies
• converting from a minpack callback
• how to retrieve a solver context
• controlling the solver parameters