class ROOT::Fit::ParameterSettings

library: libMathCore
#include "Fit/ParameterSettings.h"

Display options:

[ ↑ Top ] | [ ? Help ]

Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file viewVC header

Sections: class description function members data members class charts

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()
void	Fix()
bool	HasLowerLimit() const
bool	HasUpperLimit() const
bool	IsBound() const
bool	IsDoubleBound() const
bool	IsFixed() const
double	LowerLimit() const
const string&	Name() const
ROOT::Fit::ParameterSettings&	operator=(const ROOT::Fit::ParameterSettings&)
ROOT::Fit::ParameterSettings	ParameterSettings()
ROOT::Fit::ParameterSettings	ParameterSettings(const ROOT::Fit::ParameterSettings&)
ROOT::Fit::ParameterSettings	ParameterSettings(const string& name, double val)
ROOT::Fit::ParameterSettings	ParameterSettings(const string& name, double val, double err)
ROOT::Fit::ParameterSettings	ParameterSettings(const string& name, double val, double err, double min, double max)
void	Release()
void	RemoveLimits()
void	Set(const string& name, double value)
void	Set(const string& name, double value, double step)
void	Set(const string& name, double value, double step, double lower, double upper)
void	SetLimits(double low, double up)
void	SetLowerLimit(double low)
void	SetName(const string& name)
void	SetStepSize(double err)
void	SetUpperLimit(double up)
void	SetValue(double val)
double	StepSize() const
double	UpperLimit() const
double	Value() const

Data Members

private:

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
string	fName	parameter name
double	fStepSize	parameter step size (used by minimizer)
double	fUpperLimit	upper parameter limit
double	fValue	parameter value

Class Charts

Inheritance Inherited Members Includes Libraries

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

{ return fHasLowerLimit || fHasUpperLimit; }

bool IsDoubleBound() const

 check if is double bound (upper AND lower limit)

{ return fHasLowerLimit && fHasUpperLimit; }

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