Commit 7d37b868 authored by Laurent Belcour's avatar Laurent Belcour

Adding documentation for the vec type

parent d4e476a9
......@@ -4,6 +4,10 @@
#include <iostream>
#include <cassert>
/*! \brief A core implementation of a vector of double. This type is used for
*! any transmission of vector data with unfixed dimension. It allows to have
*! a generic fitter working for n-Dimensional data.
*/
class vec : public std::vector<double>
{
public:
......
......@@ -73,9 +73,10 @@ class function
* parameters \f$\vec{a}\f$, the resulting vector is \f$df_i = {df \over
* da_i}\f$.
*
* \note that it is not necessary to have an analytical formulation
* \note It is not necessary to have an analytical formulation
* of the derivative and a numerical evaluation of it can be provided.
*
* \todo Add a Levenberg-Marquardt fitter for this generic kind of function
*/
class nonlinear_function: public function
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment