Fitter Class Reference

List of all members.

---

Detailed Description

Definition at line 16 of file Fitter.sip.

Public Member Functions
virtual	~Fitter ()
virtual Fitter *	clone () const =0
	Copy the receiving object.
const std::string &	name () const
	Returns the name of the fitter.
virtual bool	needsDerivatives () const =0
	Returns true if the fitter needs the model function to calculate its partial derivatives.
virtual void	setFixedFlags (const std::vector< int > &)
	Sets the parameters that are to be held fixed during objective function minimization.
virtual const std::vector< int > &	getFixedFlags () const
	Returns a vector containing flags for which parameters are to be held fixed during objective function minimization.
virtual void	setLimits (unsigned int, double, double)
	Sets the limits for the parameter of the model function indexed by i.
void	setLimits (const std::string &, double, double)
	Sets the limits of the model function parameter values.
virtual bool	calcBestFit ()=0
	Calculates the best fit.
Protected Member Functions
	Fitter (const Fitter &)

---

Constructor & Destructor Documentation

Fitter::Fitter (  const Fitter &   )  [protected]

virtual Fitter::~Fitter (   )  [virtual]

---

Member Function Documentation

virtual bool Fitter::calcBestFit (   )  [pure virtual]

Calculates the best fit. Returns true if the fit converged; otherwise it returns false.

virtual Fitter* Fitter::clone (   )  const [pure virtual]

Copy the receiving object.

virtual const std::vector< int >& Fitter::getFixedFlags (   )  const [virtual]

Returns a vector containing flags for which parameters are to be held fixed during objective function minimization.

const std::string& Fitter::name (   )  const

Returns the name of the fitter.

virtual bool Fitter::needsDerivatives (   )  const [pure virtual]

Returns true if the fitter needs the model function to calculate its partial derivatives.

virtual void Fitter::setFixedFlags (  const std::vector< int > &   )  [virtual]

Sets the parameters that are to be held fixed during objective function minimization.

void Fitter::setLimits (  const std::string &  , double  , double  )

Sets the limits of the model function parameter values. Attempts to set the limits of the model function parameter values. This base class implementation throws a FitterException. Derived classes that support setting limits of the parameter values should override this member function.

virtual void Fitter::setLimits (  unsigned  int, double  , double  )  [virtual]

Sets the limits for the parameter of the model function indexed by i.

---

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

• Fitter.sip

---