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

Public Member Functions
	ParameterSettings ()
	Default constructor. 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 More...

	ParameterSettings (const std::string &name, double val)
	constructor for 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 More...

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

	~ParameterSettings ()
	Destructor (no operations) More...

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

double	StepSize () const
	return step size More...

double	LowerLimit () const
	return lower limit value More...

double	UpperLimit () const
	return upper limit value More...

bool	IsFixed () const
	check if is fixed 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...

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

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

void	Fix ()
	fix the parameter More...

void	Release ()
	release the parameter More...

void	SetValue (double val)
	set the value More...

void	SetStepSize (double err)
	set the step size 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 More...

void	SetUpperLimit (double up)
	set a single upper limit More...

void	SetLowerLimit (double low)
	set a single lower limit More...

void	RemoveLimits ()
	remove all limit More...

Private Attributes
double	fValue

double	fStepSize

bool	fFix

double	fLowerLimit

double	fUpperLimit

bool	fHasLowerLimit

bool	fHasUpperLimit

std::string	fName

#include <Fit/ParameterSettings.h>

Constructor & Destructor Documentation

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

inline

Default constructor.

Definition at line 45 of file ParameterSettings.h.

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

inline

constructor for unlimited named Parameter

Definition at line 53 of file ParameterSettings.h.

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

inline

constructor for double limited Parameter

Definition at line 60 of file ParameterSettings.h.

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

inline

constructor for fixed Parameter

Definition at line 70 of file ParameterSettings.h.

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

inline

Destructor (no operations)

Definition at line 105 of file ParameterSettings.h.

Member Function Documentation

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

inline

fix the parameter

Definition at line 138 of file ParameterSettings.h.

Referenced by combinedFit(), HFit::Fit(), TMinuitMinimizer::GetVariableSettings(), ROOT::Math::BasicMinimizer::GetVariableSettings(), ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings(), Set(), SetLimits(), TBackCompFitter::SetParameter(), testUnBin1DFit(), and ROOT::Fit::UnBinFit().

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

inline

check if parameter has lower limit

Definition at line 122 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

check if parameter has upper limit

Definition at line 124 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

check if is bound

Definition at line 126 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

check if is double bound (upper AND lower limit)

Definition at line 128 of file ParameterSettings.h.

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

inline

check if is fixed

Definition at line 120 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

return lower limit value

Definition at line 116 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

return name

Definition at line 130 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

release the parameter

Definition at line 140 of file ParameterSettings.h.

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

inline

remove all limit

Definition at line 182 of file ParameterSettings.h.

Referenced by SetLimits(), and TFractionFitter::UnConstrain().

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

inline

set value and name (unlimited parameter)

Definition at line 80 of file ParameterSettings.h.

Referenced by TMinuitMinimizer::GetVariableSettings(), ROOT::Math::BasicMinimizer::GetVariableSettings(), and ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings().

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

inline

set a limited parameter

Definition at line 87 of file ParameterSettings.h.

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

inline

set a fixed parameter

Definition at line 95 of file ParameterSettings.h.

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

Definition at line 147 of file ParameterSettings.h.

Referenced by combinedFit(), TFractionFitter::Constrain(), HFit::Fit(), ROOT::Math::BasicMinimizer::GetVariableSettings(), ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings(), ParameterSettings(), Set(), TBackCompFitter::SetParameter(), testHisto2DFit(), and ROOT::Fit::UnBinFit().

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

inline

set a single lower limit

Definition at line 174 of file ParameterSettings.h.

Referenced by DoUnBinFit(), HFit::Fit(), ROOT::Math::BasicMinimizer::GetVariableSettings(), ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings(), testHisto2DFit(), testUnBin1DFit(), and ROOT::Fit::UnBinFit().

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

inline

interaction

set name

Definition at line 135 of file ParameterSettings.h.

Referenced by Set().

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

inline

set the step size

Definition at line 144 of file ParameterSettings.h.

Referenced by combinedFit(), ROOT::Fit::Fitter::DoUpdateFitConfig(), HFit::Fit(), line3Dfit(), Set(), and ROOT::Fit::UnBinFit().

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

inline

set a single upper limit

Definition at line 167 of file ParameterSettings.h.

Referenced by HFit::Fit(), ROOT::Math::BasicMinimizer::GetVariableSettings(), ROOT::Minuit2::Minuit2Minimizer::GetVariableSettings(), and ROOT::Fit::UnBinFit().

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

inline

set the value

Definition at line 142 of file ParameterSettings.h.

Referenced by ROOT::Fit::Fitter::DoUpdateFitConfig(), and Set().

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

inline

return step size

Definition at line 114 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FitResult().

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

inline

return upper limit value

Definition at line 118 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

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

inline

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

return parameter value

Definition at line 112 of file ParameterSettings.h.

Referenced by ROOT::Fit::FitResult::FillResult(), HFit::Fit(), ROOT::Fit::FitResult::FitResult(), and ROOT::Fit::UnBinFit().

Member Data Documentation

bool ROOT::Fit::ParameterSettings::fFix

private

Definition at line 198 of file ParameterSettings.h.

Referenced by Fix(), IsFixed(), and Release().

bool ROOT::Fit::ParameterSettings::fHasLowerLimit

private

Definition at line 201 of file ParameterSettings.h.

Referenced by HasLowerLimit(), IsBound(), IsDoubleBound(), RemoveLimits(), SetLimits(), SetLowerLimit(), and SetUpperLimit().

bool ROOT::Fit::ParameterSettings::fHasUpperLimit

private

Definition at line 202 of file ParameterSettings.h.

Referenced by HasUpperLimit(), IsBound(), IsDoubleBound(), RemoveLimits(), SetLimits(), SetLowerLimit(), and SetUpperLimit().

double ROOT::Fit::ParameterSettings::fLowerLimit

private

Definition at line 199 of file ParameterSettings.h.

Referenced by LowerLimit(), RemoveLimits(), SetLimits(), SetLowerLimit(), and SetUpperLimit().

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

private

Definition at line 204 of file ParameterSettings.h.

Referenced by Name(), and SetName().

double ROOT::Fit::ParameterSettings::fStepSize

private

Definition at line 197 of file ParameterSettings.h.

Referenced by SetStepSize(), and StepSize().

double ROOT::Fit::ParameterSettings::fUpperLimit

private

Definition at line 200 of file ParameterSettings.h.

Referenced by RemoveLimits(), SetLimits(), SetLowerLimit(), SetUpperLimit(), and UpperLimit().

double ROOT::Fit::ParameterSettings::fValue

private

Definition at line 196 of file ParameterSettings.h.

Referenced by SetLimits(), SetValue(), and Value().

Collaboration diagram for ROOT::Fit::ParameterSettings:

[legend]

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

math/mathcore/inc/Fit/ParameterSettings.h

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation