Logo ROOT  
Reference Guide
ROOT::Fit::ParameterSettings Class Reference

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

Definition at line 46 of file ParameterSettings.h.

Public Member Functions

 ParameterSettings ()
 Default constructor. More...
 
 ParameterSettings (const std::string &name, double val)
 constructor for fixed Parameter More...
 
 ParameterSettings (const std::string &name, double val, double err)
 constructor for unlimited named Parameter More...
 
 ParameterSettings (const std::string &name, double val, double err, double min, double max)
 constructor for double limited Parameter. The given value should be within the given limits [min,max] More...
 
 ~ParameterSettings ()
 Destructor (no operations) More...
 
void Fix ()
 fix the parameter More...
 
bool HasLowerLimit () const
 check if parameter has lower limit More...
 
bool HasUpperLimit () const
 check if parameter has upper limit More...
 
bool IsBound () const
 check if is bound More...
 
bool IsDoubleBound () const
 check if is double bound (upper AND lower limit) More...
 
bool IsFixed () const
 check if is fixed More...
 
double LowerLimit () const
 return lower limit value More...
 
const std::string & Name () const
 return name More...
 
void Release ()
 release the parameter More...
 
void RemoveLimits ()
 remove all limit More...
 
void Set (const std::string &name, double value)
 set a fixed parameter More...
 
void Set (const std::string &name, double value, double step)
 set value and name (unlimited parameter) More...
 
void Set (const std::string &name, double value, double step, double lower, double upper)
 set a limited parameter. The given value should be within the given limits [min,max] More...
 
void SetLimits (double low, double up)
 set a double side limit, if low == up the parameter is fixed if low > up the limits are removed The current parameter value should be within the given limits [low,up]. More...
 
void SetLowerLimit (double low)
 set a single lower limit More...
 
void SetName (const std::string &name)
 interaction More...
 
void SetStepSize (double err)
 set the step size More...
 
void SetUpperLimit (double up)
 set a single upper limit More...
 
void SetValue (double val)
 set the value More...
 
double StepSize () const
 return step size More...
 
double UpperLimit () const
 return upper limit value More...
 
double Value () const
 copy constructor and assignment operators (leave them to the compiler) More...
 

Private Attributes

bool fFix
 
bool fHasLowerLimit
 
bool fHasUpperLimit
 
double fLowerLimit
 
std::string fName
 
double fStepSize
 
double fUpperLimit
 
double fValue
 

#include <Fit/ParameterSettings.h>

Constructor & Destructor Documentation

◆ ParameterSettings() [1/4]

ROOT::Fit::ParameterSettings::ParameterSettings ( )
inline

Default constructor.

Definition at line 58 of file ParameterSettings.h.

◆ ParameterSettings() [2/4]

ROOT::Fit::ParameterSettings::ParameterSettings ( const std::string &  name,
double  val,
double  err 
)
inline

constructor for unlimited named Parameter

Definition at line 66 of file ParameterSettings.h.

◆ ParameterSettings() [3/4]

ROOT::Fit::ParameterSettings::ParameterSettings ( const std::string &  name,
double  val,
double  err,
double  min,
double  max 
)
inline

constructor for double limited Parameter. The given value should be within the given limits [min,max]

Definition at line 73 of file ParameterSettings.h.

◆ ParameterSettings() [4/4]

ROOT::Fit::ParameterSettings::ParameterSettings ( const std::string &  name,
double  val 
)
inline

constructor for fixed Parameter

Definition at line 83 of file ParameterSettings.h.

◆ ~ParameterSettings()

ROOT::Fit::ParameterSettings::~ParameterSettings ( )
inline

Destructor (no operations)

Definition at line 118 of file ParameterSettings.h.

Member Function Documentation

◆ Fix()

void ROOT::Fit::ParameterSettings::Fix ( )
inline

fix the parameter

Definition at line 151 of file ParameterSettings.h.

◆ HasLowerLimit()

bool ROOT::Fit::ParameterSettings::HasLowerLimit ( ) const
inline

check if parameter has lower limit

Definition at line 135 of file ParameterSettings.h.

◆ HasUpperLimit()

bool ROOT::Fit::ParameterSettings::HasUpperLimit ( ) const
inline

check if parameter has upper limit

Definition at line 137 of file ParameterSettings.h.

◆ IsBound()

bool ROOT::Fit::ParameterSettings::IsBound ( ) const
inline

check if is bound

Definition at line 139 of file ParameterSettings.h.

◆ IsDoubleBound()

bool ROOT::Fit::ParameterSettings::IsDoubleBound ( ) const
inline

check if is double bound (upper AND lower limit)

Definition at line 141 of file ParameterSettings.h.

◆ IsFixed()

bool ROOT::Fit::ParameterSettings::IsFixed ( ) const
inline

check if is fixed

Definition at line 133 of file ParameterSettings.h.

◆ LowerLimit()

double ROOT::Fit::ParameterSettings::LowerLimit ( ) const
inline

return lower limit value

Definition at line 129 of file ParameterSettings.h.

◆ Name()

const std::string& ROOT::Fit::ParameterSettings::Name ( ) const
inline

return name

Definition at line 143 of file ParameterSettings.h.

◆ Release()

void ROOT::Fit::ParameterSettings::Release ( )
inline

release the parameter

Definition at line 153 of file ParameterSettings.h.

◆ RemoveLimits()

void ROOT::Fit::ParameterSettings::RemoveLimits ( )
inline

remove all limit

Definition at line 197 of file ParameterSettings.h.

◆ Set() [1/3]

void ROOT::Fit::ParameterSettings::Set ( const std::string &  name,
double  value 
)
inline

set a fixed parameter

Definition at line 108 of file ParameterSettings.h.

◆ Set() [2/3]

void ROOT::Fit::ParameterSettings::Set ( const std::string &  name,
double  value,
double  step 
)
inline

set value and name (unlimited parameter)

Definition at line 93 of file ParameterSettings.h.

◆ Set() [3/3]

void ROOT::Fit::ParameterSettings::Set ( const std::string &  name,
double  value,
double  step,
double  lower,
double  upper 
)
inline

set a limited parameter. The given value should be within the given limits [min,max]

Definition at line 100 of file ParameterSettings.h.

◆ SetLimits()

void ROOT::Fit::ParameterSettings::SetLimits ( double  low,
double  up 
)
inline

set a double side limit, if low == up the parameter is fixed if low > up the limits are removed The current parameter value should be within the given limits [low,up].

If the value is outside the limits, then a new parameter value is set to = (up+low)/2

Definition at line 162 of file ParameterSettings.h.

◆ SetLowerLimit()

void ROOT::Fit::ParameterSettings::SetLowerLimit ( double  low)
inline

set a single lower limit

Definition at line 189 of file ParameterSettings.h.

◆ SetName()

void ROOT::Fit::ParameterSettings::SetName ( const std::string &  name)
inline

interaction

set name

Definition at line 148 of file ParameterSettings.h.

◆ SetStepSize()

void ROOT::Fit::ParameterSettings::SetStepSize ( double  err)
inline

set the step size

Definition at line 157 of file ParameterSettings.h.

◆ SetUpperLimit()

void ROOT::Fit::ParameterSettings::SetUpperLimit ( double  up)
inline

set a single upper limit

Definition at line 182 of file ParameterSettings.h.

◆ SetValue()

void ROOT::Fit::ParameterSettings::SetValue ( double  val)
inline

set the value

Definition at line 155 of file ParameterSettings.h.

◆ StepSize()

double ROOT::Fit::ParameterSettings::StepSize ( ) const
inline

return step size

Definition at line 127 of file ParameterSettings.h.

◆ UpperLimit()

double ROOT::Fit::ParameterSettings::UpperLimit ( ) const
inline

return upper limit value

Definition at line 131 of file ParameterSettings.h.

◆ Value()

double ROOT::Fit::ParameterSettings::Value ( ) const
inline

copy constructor and assignment operators (leave them to the compiler)

return parameter value

Definition at line 125 of file ParameterSettings.h.

Member Data Documentation

◆ fFix

bool ROOT::Fit::ParameterSettings::fFix
private

Definition at line 213 of file ParameterSettings.h.

◆ fHasLowerLimit

bool ROOT::Fit::ParameterSettings::fHasLowerLimit
private

Definition at line 216 of file ParameterSettings.h.

◆ fHasUpperLimit

bool ROOT::Fit::ParameterSettings::fHasUpperLimit
private

Definition at line 217 of file ParameterSettings.h.

◆ fLowerLimit

double ROOT::Fit::ParameterSettings::fLowerLimit
private

Definition at line 214 of file ParameterSettings.h.

◆ fName

std::string ROOT::Fit::ParameterSettings::fName
private

Definition at line 219 of file ParameterSettings.h.

◆ fStepSize

double ROOT::Fit::ParameterSettings::fStepSize
private

Definition at line 212 of file ParameterSettings.h.

◆ fUpperLimit

double ROOT::Fit::ParameterSettings::fUpperLimit
private

Definition at line 215 of file ParameterSettings.h.

◆ fValue

double ROOT::Fit::ParameterSettings::fValue
private

Definition at line 211 of file ParameterSettings.h.

Libraries for ROOT::Fit::ParameterSettings:
[legend]

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