Commit 8e0c55c7 authored by Laurent Belcour's avatar Laurent Belcour

Updating documentation with an installation page

parent 70dd2fa3
documents/doxygen
.*.swp
......@@ -2,3 +2,5 @@ PROJECT_NAME = ALTA
INPUT = ../sources .
OUTPUT_DIRECTORY = ./doxygen
RECURSIVE = YES
GENERATE_LATEX = NO
/**
\defgroup install
How to install the various components
<h2>Requirement</h2>
<ul>
<li>Qt library with qmake</li>
<li>Eigen library (for some plugins)</li>
<li>Matlab with the Engine library (for some plugins)</li>
<li>CGAL library (for some plugins)</li>
</ul>
<h2>Installation</h2>
Once you have the required libraries, the installation of the fitting
tools is straightforward:
\verbatim
$ cd $ALTA/sources
$ qmake && make
\endverbatim
All the resulting elements (binaries, dynamic and static libraries)
are outputed in: <em>$ALTA/sources/build</em> directory.
*/
......@@ -22,6 +22,8 @@ Three types of plugins are availables:
<li><em>\ref fitter</em> plugins provide fitting algorithms.</li>
</ul>
Documentation to \ref install
The plugin_manager class will load all the Qt plugins and will provide access to
the requested elements. See the documentation of this class.
......
......@@ -4,26 +4,28 @@
#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.
/*! \brief A core implementation of a vector of double.
*
* \details
* 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:
//* // Constructor & Destructors
// Constructor & Destructors
//
vec() : std::vector<double>()
{
}
vec(int dim) : std::vector<double>(dim)
{
assign(dim, 0.0) ;
assign(dim, 0.0) ;
} ;
virtual ~vec()
{
} ;
//*/
// Mathematical operators
//
......@@ -78,7 +80,7 @@ class vec : public std::vector<double>
}
*/
// IO Functions
//! \brief IO Functions
//
friend std::ostream& operator<< (std::ostream& out, const vec& v)
{
......
......@@ -13,6 +13,7 @@ class data ;
/*! \brief A representation of an analytical function.
* \ingroup core
*
* \details
* function are functors with a domain of definition specified by a vector
* interval \f$[\vec{min} .. \vec{max}]\f$ where \f$\vec{min}\f$ and
* \f$\vec{max}\f$ have the size of the input domain.
......@@ -70,7 +71,9 @@ class function
};
/*! \brief Non-linear function interface
* \ingroup core
*
* \details
* Provide a way to obtain the dérivative of the function with respect to its
* parameters. If the function \f$f(\vec{x})\f$ is defined for a vector of
* parameters \f$\vec{a}\f$, the resulting vector is \f$df_i = {df \over
......@@ -78,8 +81,6 @@ class function
*
* \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