ROOT logo
ROOT » MATH » MATHCORE » ROOT::Fit::ParameterSettings

class ROOT::Fit::ParameterSettings


   Class, describing value, limits and step size of the parameters
   Provides functionality also to set/retrieve values, step sizes, limits and fix the
   parameters.

   To be done: add constraints (equality and inequality) as functions of the parameters

   @ingroup FitMain

This class is also known as (typedefs to this class)

vector<ROOT::Fit::ParameterSettings,allocator<ROOT::Fit::ParameterSettings> >::value_type

Function Members (Methods)

public:
~ParameterSettings()
voidFix()
boolHasLowerLimit() const
boolHasUpperLimit() const
boolIsBound() const
boolIsDoubleBound() const
boolIsFixed() const
doubleLowerLimit() const
const string&Name() const
ROOT::Fit::ParameterSettings&operator=(const ROOT::Fit::ParameterSettings&)
ROOT::Fit::ParameterSettingsParameterSettings()
ROOT::Fit::ParameterSettingsParameterSettings(const ROOT::Fit::ParameterSettings&)
ROOT::Fit::ParameterSettingsParameterSettings(const string& name, double val)
ROOT::Fit::ParameterSettingsParameterSettings(const string& name, double val, double err)
ROOT::Fit::ParameterSettingsParameterSettings(const string& name, double val, double err, double min, double max)
voidRelease()
voidRemoveLimits()
voidSet(const string& name, double value)
voidSet(const string& name, double value, double step)
voidSet(const string& name, double value, double step, double lower, double upper)
voidSetLimits(double low, double up)
voidSetLowerLimit(double low)
voidSetName(const string& name)
voidSetStepSize(double err)
voidSetUpperLimit(double up)
voidSetValue(double val)
doubleStepSize() const
doubleUpperLimit() const
doubleValue() const

Data Members

private:
boolfFixflag to control if parameter is fixed
boolfHasLowerLimitflag to control lower parameter limit
boolfHasUpperLimitflag to control upper parameter limit
doublefLowerLimitlower parameter limit
stringfNameparameter name
doublefStepSizeparameter step size (used by minimizer)
doublefUpperLimitupper parameter limit
doublefValueparameter value

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

ParameterSettings()
      Default constructor

{}
ParameterSettings(const string& name, double val, double err)
constructor for unlimited named Parameter
{}
ParameterSettings(const string& name, double val, double err, double min, double max)
constructor for double limited Parameter
SetLimits(double low, double up)
ParameterSettings(const string& name, double val)
constructor for fixed Parameter
{}
void Set(const string& name, double value, double step)
 set value and name (unlimited parameter)
SetName(const string& name)
SetValue(double val)
SetStepSize(double err)
void Set(const string& name, double value, double step, double lower, double upper)
 set a limited parameter
void Set(const string& name, double value)
 set a fixed parameter
Fix()
~ParameterSettings()
      Destructor (no operations)

{}
double Value() const
 copy constructor and assignment operators (leave them to the compiler)
 return parameter value
{ return fValue; }
double StepSize() const
 return step size
{ return fStepSize; }
double LowerLimit() const
 return lower limit value
{return fLowerLimit;}
double UpperLimit() const
 return upper limit value
{return fUpperLimit;}
bool IsFixed() const
 check if is fixed
{ return fFix; }
bool HasLowerLimit() const
 check if parameter has lower limit
{return fHasLowerLimit; }
bool HasUpperLimit() const
 check if parameter has upper limit
{return fHasUpperLimit; }
bool IsBound() const
 check if is bound
bool IsDoubleBound() const
 check if is double bound (upper AND lower limit)
const std::string & Name() const
 return name
{ return fName; }
void Release()
 release the parameter
{fFix = false;}
RemoveLimits()
void SetUpperLimit(double up)
 set a single upper limit
void SetLowerLimit(double low)
 set a single lower limit