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 33 of file ParameterSettings.h.

Public Member Functions
	ParameterSettings ()
	Default constructor.

	ParameterSettings (const std::string &name, double val)
	constructor for fixed Parameter

	ParameterSettings (const std::string &name, double val, double err)
	constructor for unlimited named Parameter

	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]

	~ParameterSettings ()
	Destructor (no operations)

void	Fix ()
	fix the parameter

bool	HasLowerLimit () const
	check if parameter has lower limit

bool	HasUpperLimit () const
	check if parameter has upper limit

bool	IsBound () const
	check if is bound

bool	IsDoubleBound () const
	check if is double bound (upper AND lower limit)

bool	IsFixed () const
	check if is fixed

double	LowerLimit () const
	return lower limit value

const std::string &	Name () const
	return name

void	Release ()
	release the parameter

void	RemoveLimits ()
	remove all limit

void	Set (const std::string &name, double value)
	set a fixed parameter

void	Set (const std::string &name, double value, double step)
	set value and name (unlimited parameter)

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]

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].

void	SetLowerLimit (double low)
	set a single lower limit

void	SetName (const std::string &name)
	interaction

void	SetStepSize (double err)
	set the step size

void	SetUpperLimit (double up)
	set a single upper limit

void	SetValue (double val)
	set the value

double	StepSize () const
	return step size

double	UpperLimit () const
	return upper limit value

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

Private Attributes
bool	fFix
	flag to control if parameter is fixed

bool	fHasLowerLimit
	flag to control lower parameter limit

bool	fHasUpperLimit
	flag to control upper parameter limit

double	fLowerLimit
	lower parameter limit

std::string	fName
	parameter name

double	fStepSize
	parameter step size (used by minimizer)

double	fUpperLimit
	upper parameter limit

double	fValue
	parameter value

#include <Fit/ParameterSettings.h>

Constructor & Destructor Documentation

◆ ParameterSettings() [1/4]

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

inline

Default constructor.

Definition at line 40 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 48 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 55 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 65 of file ParameterSettings.h.

◆ ~ParameterSettings()

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

inline

Destructor (no operations)

Definition at line 100 of file ParameterSettings.h.

Member Function Documentation

◆ Fix()

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

inline

fix the parameter

Definition at line 133 of file ParameterSettings.h.

◆ HasLowerLimit()

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

inline

check if parameter has lower limit

Definition at line 117 of file ParameterSettings.h.

◆ HasUpperLimit()

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

inline

check if parameter has upper limit

Definition at line 119 of file ParameterSettings.h.

◆ IsBound()

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

inline

check if is bound

Definition at line 121 of file ParameterSettings.h.

◆ IsDoubleBound()

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

inline

check if is double bound (upper AND lower limit)

Definition at line 123 of file ParameterSettings.h.

◆ IsFixed()

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

inline

check if is fixed

Definition at line 115 of file ParameterSettings.h.

◆ LowerLimit()

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

inline

return lower limit value

Definition at line 111 of file ParameterSettings.h.

◆ Name()

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

inline

return name

Definition at line 125 of file ParameterSettings.h.

◆ Release()

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

inline

release the parameter

Definition at line 135 of file ParameterSettings.h.

◆ RemoveLimits()

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

inline

remove all limit

Definition at line 157 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 90 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 75 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 82 of file ParameterSettings.h.

◆ SetLimits()

void ROOT::Fit::ParameterSettings::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].

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

Definition at line 25 of file ParameterSettings.cxx.

◆ SetLowerLimit()

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

inline

set a single lower limit

Definition at line 149 of file ParameterSettings.h.

◆ SetName()

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

inline

interaction

set name

Definition at line 130 of file ParameterSettings.h.

◆ SetStepSize()

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

inline

set the step size

Definition at line 139 of file ParameterSettings.h.

◆ SetUpperLimit()

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

inline

set a single upper limit

Definition at line 142 of file ParameterSettings.h.

◆ SetValue()

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

inline

set the value

Definition at line 137 of file ParameterSettings.h.

◆ StepSize()

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

inline

return step size

Definition at line 109 of file ParameterSettings.h.

◆ UpperLimit()

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

inline

return upper limit value

Definition at line 113 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 107 of file ParameterSettings.h.

Member Data Documentation

◆ fFix

bool ROOT::Fit::ParameterSettings::fFix

private

flag to control if parameter is fixed

Definition at line 173 of file ParameterSettings.h.

◆ fHasLowerLimit

bool ROOT::Fit::ParameterSettings::fHasLowerLimit

private

flag to control lower parameter limit

Definition at line 176 of file ParameterSettings.h.

◆ fHasUpperLimit

bool ROOT::Fit::ParameterSettings::fHasUpperLimit

private

flag to control upper parameter limit

Definition at line 177 of file ParameterSettings.h.

◆ fLowerLimit

double ROOT::Fit::ParameterSettings::fLowerLimit

private

lower parameter limit

Definition at line 174 of file ParameterSettings.h.

◆ fName

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

private

parameter name

Definition at line 179 of file ParameterSettings.h.

◆ fStepSize

double ROOT::Fit::ParameterSettings::fStepSize

private

parameter step size (used by minimizer)

Definition at line 172 of file ParameterSettings.h.

◆ fUpperLimit

double ROOT::Fit::ParameterSettings::fUpperLimit

private

upper parameter limit

Definition at line 175 of file ParameterSettings.h.

◆ fValue

double ROOT::Fit::ParameterSettings::fValue

private

parameter value

Definition at line 171 of file ParameterSettings.h.

Libraries for ROOT::Fit::ParameterSettings:

[legend]

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

math/mathcore/inc/Fit/ParameterSettings.h
math/mathcore/src/ParameterSettings.cxx

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ ParameterSettings() [1/4]

◆ ParameterSettings() [2/4]

◆ ParameterSettings() [3/4]

◆ ParameterSettings() [4/4]

◆ ~ParameterSettings()

Member Function Documentation

◆ Fix()

◆ HasLowerLimit()

◆ HasUpperLimit()

◆ IsBound()

◆ IsDoubleBound()

◆ IsFixed()

◆ LowerLimit()

◆ Name()

◆ Release()

◆ RemoveLimits()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetLimits()

◆ SetLowerLimit()

◆ SetName()

◆ SetStepSize()

◆ SetUpperLimit()

◆ SetValue()

◆ StepSize()

◆ UpperLimit()

◆ Value()

Member Data Documentation

◆ fFix

◆ fHasLowerLimit

◆ fHasUpperLimit

◆ fLowerLimit

◆ fName

◆ fStepSize

◆ fUpperLimit

◆ fValue