CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IFitParameterSettings Class Reference

#include <IFitParameterSettings.h>

List of all members.

Public Methods
virtual	~IFitParameterSettings ()
	Destructor. More...
virtual std::string	name () const=0
	Name of the parameter to which settings apply. More...
virtual double	stepSize () const=0
	Step size allows to control the "sensitivity" of the change of the parameter when fitters looks for the optimal parameter value. Default is 1.0. More...
virtual double	upperBound () const=0
	Bounds. More...
virtual double	lowerBound () const=0
virtual bool	isBound () const=0
	Shortcut for lowerBound() == -INF && upperBound() == +INF. More...
virtual bool	isFixed () const=0
	Value of the parameter cannot change if isFixed() == true. Parameter can be fixed independently from setting the bounds. More...
virtual void	setStepSize (double step)=0
	Set the step size for the fitter. More...
virtual void	setBounds (double lo, double up)=0
	Set bounds. If bounds not set, then default bound is (-INF,+INF). More...
virtual void	removeBounds ()=0
	Shortcut for setBounds(-INF,+INF). More...
virtual void	setFixed (bool isFixed)=0
	Fix/unfix parameter. More...
virtual void	setLowerBound (double lowerBound)=0
virtual void	setUpperBound (double upperBound)=0
virtual void	reset ()=0
	Reset all settings to the default values (remove bounds, step size = 1.0, no fix). More...

---

Detailed Description

@interface

Fitting-specific settings applied to a parameter of the fitted function.

Author:

The AIDA team (http://aida.freehep.org/)

Definition at line 27 of file IFitParameterSettings.h.

---

Constructor & Destructor Documentation

AIDA::IFitParameterSettings::~IFitParameterSettings ( ) [inline, virtual]

Definition at line 31 of file IFitParameterSettings.h.

---

Member Function Documentation

bool AIDA::IFitParameterSettings::isBound ( ) const [pure virtual]

bool AIDA::IFitParameterSettings::isFixed ( ) const [pure virtual]

double AIDA::IFitParameterSettings::lowerBound ( ) const [pure virtual]

std::string AIDA::IFitParameterSettings::name ( ) const [pure virtual]

void AIDA::IFitParameterSettings::removeBounds ( ) [pure virtual]

void AIDA::IFitParameterSettings::reset ( ) [pure virtual]

void AIDA::IFitParameterSettings::setBounds ( double lo, double up ) [pure virtual]

void AIDA::IFitParameterSettings::setFixed ( bool isFixed ) [pure virtual]

void AIDA::IFitParameterSettings::setLowerBound ( double lowerBound ) [pure virtual]

Set the lower bound. When this method is invoked any previous bound is reset. The new bounds are (lowerBound, +INF). Parameters: lowerBound   The lower bound.

void AIDA::IFitParameterSettings::setStepSize ( double step ) [pure virtual]

void AIDA::IFitParameterSettings::setUpperBound ( double upperBound ) [pure virtual]

Set the upper bound. When this method is invoked any previous bound is reset. The new bounds are (-INF, upperBound). Parameters: upperBound   The upper bound.

double AIDA::IFitParameterSettings::stepSize ( ) const [pure virtual]

double AIDA::IFitParameterSettings::upperBound ( ) const [pure virtual]

---

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

• IFitParameterSettings.h

---