Commit daa6dce3 authored by Laurent Belcour's avatar Laurent Belcour
Browse files

Updating doxygen

parent 5bcbaf64
......@@ -7,7 +7,7 @@ formulation, etc. It is decomposed in three components:
<li><em>\ref core</em>: a set of classes providing interfaces to BRDFs, data type
and fitting algorithms. All the code using this library should rely on this
part.</li>
<li><em>\ref plugins</em>: a set of Qt plugins providing fitting algorithms
<li><em>\ref plugins</em>: a set of plugins providing fitting algorithms
for rational BRDFs, non-linear BRDFs, etc.</li>
<li><em>\ref softs</em>: a set of tools to fit data, convert data, export fitting to
plots, etc.</li>
......
......@@ -12,7 +12,9 @@
#include <core/fitter.h>
#include <core/args.h>
/*! \brief A vertical segment fitter for rational function using the library CGAL
* \ingroup plugins
*/
class rational_fitter_cgal : public fitter
{
public: // methods
......
......@@ -12,6 +12,9 @@
#include <core/rational_function.h>
#include <core/vertical_segment.h>
/*! \brief A least square fitter for rational function using the library Eigen
* \ingroup plugins
*/
class rational_fitter_eigen : public fitter
{
......
......@@ -13,7 +13,7 @@
#include <core/fitter.h>
#include <core/args.h>
/*! \brief A fitter for rational functions that can run in parallel
/*! \brief A vertical segment fitter for rational functions that can run in parallel
* using QuadProg++ quadratic solver.
* \ingroup plugins
*
......
......@@ -24,16 +24,6 @@ ALTA_DLL_EXPORT fitter* provide_fitter()
return new rational_fitter_quadprog();
}
data* rational_fitter_quadprog::provide_data() const
{
return new vertical_segment() ;
}
function* rational_fitter_quadprog::provide_function() const
{
return new rational_function() ;
}
rational_fitter_quadprog::rational_fitter_quadprog() : _boundary(1.0)
{
}
......
......@@ -5,7 +5,6 @@
#include <string>
// Interface
#include <QObject>
#include <core/function.h>
#include <core/rational_function.h>
#include <core/data.h>
......@@ -13,30 +12,26 @@
#include <core/fitter.h>
#include <core/args.h>
/*! \brief A rational fitter using the library QuadProg++
/*! \brief A vertical segment fitter for rational function using the library QuadProg++
* You can find the library here: http://quadprog.sourceforge.net/
* \ingroup plugins
*/
class rational_fitter_quadprog : public fitter
{
public: // methods
rational_fitter_quadprog() ;
virtual ~rational_fitter_quadprog() ;
// Fitting a data object
//
virtual bool fit_data(const data* d, function* fit, const arguments& args) ;
virtual bool fit_data(const data* d, function* fit, const arguments& args) ;
// Provide user parameters to the fitter
//
virtual void set_parameters(const arguments& args) ;
// Obtain associated data and functions
//
virtual data* provide_data() const ;
virtual function* provide_function() const ;
private: // methods
private: // methods
protected: // data
......@@ -49,8 +44,8 @@ class rational_fitter_quadprog : public fitter
int _max_np, _max_nq ;
int _min_np, _min_nq ;
// Add constraints to the boundary of the domain. You can shrink it of
// the parameter --boundary-constraint *double*
double _boundary;
// Add constraints to the boundary of the domain. You can shrink it of
// the parameter --boundary-constraint *double*
double _boundary;
} ;
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