Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::IModelFunction Class Reference

#include <IModelFunction.h>

Inheritance diagram for Anaphe::IModelFunction:

Anaphe::IFunction List of all members.

Detailed Description

Interface of model function for fitting. It supports setting and retrieving of the (double) parameters. PENDING: to be investigated -> it should also contain parameter constraint information (the valid range of parameter values, if applicable).


Public Methods

virtual void setParameters (const std::vector< double > &params)=0
 Set new vector of parameters.

virtual const std::vector<
double > & 
parameters () const=0
 Retrieve current vector of parameters.

virtual const std::vector<
double > & 
parameterGradient (const std::vector< double > &x) const=0
 Compute gradient with respect to parameters.

virtual bool hasParameterGradient () const=0
 Return true if has parameter gradient.

virtual int numberOfParameters () const=0
 Number of parameters.

virtual std::string nameOfParameter (int ix) const=0
 Names of paramaters. Names should be unique. Case-insensitive for comparison. Case-sensitive for storage and output. All or several names may be left blank "" if the implementation does not want to provide them.


Member Function Documentation

virtual bool Anaphe::IModelFunction::hasParameterGradient   const [pure virtual]
 

virtual std::string Anaphe::IModelFunction::nameOfParameter int    ix const [pure virtual]
 

virtual int Anaphe::IModelFunction::numberOfParameters   const [pure virtual]
 

virtual const std::vector<double>& Anaphe::IModelFunction::parameterGradient const std::vector< double > &    x const [pure virtual]
 

virtual const std::vector<double>& Anaphe::IModelFunction::parameters   const [pure virtual]
 

virtual void Anaphe::IModelFunction::setParameters const std::vector< double > &    params [pure virtual]
 


The documentation for this class was generated from the following file:

Anaphe documentation generated by Doxygen (www.doxygen.org)