A class for model parameters. More...

#include <ModelParameter.h>

Detailed Description

A class for model parameters.

Author: HEPfit Collaboration

Copyright: GNU General Public License

This class stores the details of the model parameters defined in the SomeModel.conf file or specified by the user. The name of the model parameter has to correspond to the list of names in the SomeModel.cpp file in the Model src directories.
e.g. GF, which can be found in StandardModel.cpp file in the StandardModel project source folder StandardModel/src.

Definition at line 28 of file ModelParameter.h.

Public Member Functions
double	getave () const
	A get method to get the average. More...

std::string	getCgp_name () const
	A get method to get the name of the set of correlated parameter. More...

double	geterrf () const
	A get method to get the flat error. More...

double	geterrg () const
	A get method to get the gaussian error. More...

double	getmax () const
	A get method to get the maximum value. More...

double	getmin () const
	A get method to get the minimum value. More...

std::string	getname () const
	A get method to get the name of each parameter. More...

bool	IsCorrelated () const
	A method to check if the parameters are correlated or not. More...

bool	IsFixed () const
	A method to check if the parameter is fixed. More...

	ModelParameter ()
	Constructor. More...

	ModelParameter (std::string name_in, double ave_in, double errg_in, double errf_in)
	Constructor. More...

boost::tokenizer< boost::char_separator< char > >::iterator &	ParseModelParameter (boost::tokenizer< boost::char_separator< char > >::iterator &beg)
	Parser for model parameters. More...

void	setCgp_name (std::string cgp_name)
	A set method to set the name of the set of correlated parameter. More...

virtual	~ModelParameter ()
	The default destructor. More...

Private Attributes
double	ave
	The average value of the model parameter. More...

std::string	cgp_name

double	errf
	The flat error of the model parameter. More...

double	errg
	The Gaussian error of the model parameter. More...

bool	isFixed
	A boolean flag that is true if the parameter is fixed. More...

double	max
	The maximum value of the model parameter. More...

double	min
	The minimum value of the model parameter. More...

std::string	name
	The name of the model parameter. More...

Friends
std::ostream &	operator<< (std::ostream &output, const ModelParameter &m)
	Befriending of the std::ostream operator << to generate an output stream for printing the model parameters. More...

Constructor & Destructor Documentation

◆ ModelParameter() [1/2]

ModelParameter::ModelParameter	(	std::string	name_in,
		double	ave_in,
		double	errg_in,
		double	errf_in
	)

Constructor.

Parameters

[in]	name_in	the name for the model parameter
[in]	ave_in	the average value for the model parameter
[in]	errg_in	the gaussian error for the model parameter
[in]	errf_in	the flat error for the model parameter

Definition at line 10 of file ModelParameter.cpp.

 {
     name = name_in;
     ave = ave_in;
     errg = errg_in;
     errf = errf_in;
     min = ave - errf - 5.*errg;
     max = ave + errf + 5.*errg;
     cgp_name.clear();
     if(errg == 0. && errf == 0.)
         isFixed = true;
     else
         isFixed = false;
 }

◆ ModelParameter() [2/2]

ModelParameter::ModelParameter ( )

Constructor.

Definition at line 25 of file ModelParameter.cpp.

26 {}

◆ ~ModelParameter()

ModelParameter::~ModelParameter ( )

virtual

The default destructor.

Definition at line 28 of file ModelParameter.cpp.

29 {

30 }

Member Function Documentation

◆ getave()

double ModelParameter::getave ( ) const

inline

A get method to get the average.

Returns: the average of the parameter

Definition at line 78 of file ModelParameter.h.

     {
         return ave;
     }

◆ getCgp_name()

std::string ModelParameter::getCgp_name ( ) const

inline

A get method to get the name of the set of correlated parameter.

Returns: a string that contains the name

Definition at line 132 of file ModelParameter.h.

     {
         return cgp_name;
     }

◆ geterrf()

double ModelParameter::geterrf ( ) const

inline

A get method to get the flat error.

Returns: the flat error of the parameter

Definition at line 87 of file ModelParameter.h.

     {
         return errf;
     }

◆ geterrg()

double ModelParameter::geterrg ( ) const

inline

A get method to get the gaussian error.

Returns: the Gaussian error of the parameter

Definition at line 96 of file ModelParameter.h.

     {
         return errg;
     }

◆ getmax()

double ModelParameter::getmax ( ) const

inline

A get method to get the maximum value.

Returns: the maximum value of the parameter

Definition at line 114 of file ModelParameter.h.

     {
         return max;
     }

◆ getmin()

double ModelParameter::getmin ( ) const

inline

A get method to get the minimum value.

Returns: the minimum value of the parameter

Definition at line 105 of file ModelParameter.h.

     {
         return min;
     }

◆ getname()

std::string ModelParameter::getname ( ) const

inline

A get method to get the name of each parameter.

Returns: a string that contains the name

Definition at line 69 of file ModelParameter.h.

     {
         return name;
     }

◆ IsCorrelated()

bool ModelParameter::IsCorrelated ( ) const

inline

A method to check if the parameters are correlated or not.

Returns: a boolean which is true of the parameters are correlated

Definition at line 60 of file ModelParameter.h.

     {
         return(!cgp_name.empty());
     }

◆ IsFixed()

bool ModelParameter::IsFixed ( ) const

inline

A method to check if the parameter is fixed.

Returns: a boolean that is true if the parameter is fixed

Definition at line 123 of file ModelParameter.h.

     {
         return isFixed;
     }

◆ ParseModelParameter()

boost::tokenizer< boost::char_separator< char > >::iterator & ModelParameter::ParseModelParameter ( boost::tokenizer< boost::char_separator< char > >::iterator & beg )

Parser for model parameters.

Parameters

[in] beg iterator for reading the model parameter

Definition at line 39 of file ModelParameter.cpp.

 {
  
     name = *beg;
     ++beg;
     ave = atof((*beg).c_str());
     ++beg;
     errg = atof((*beg).c_str());
     ++beg;
     errf = atof((*beg).c_str());
     ++beg;
     min = ave - errf - 5.*errg;
     max = ave + errf + 5.*errg;
     
     cgp_name.clear();
     if(errg == 0. && errf == 0.)
         isFixed = true;
     else
         isFixed = false;
     
     return beg;
 }

◆ setCgp_name()

void ModelParameter::setCgp_name ( std::string cgp_name )

inline

A set method to set the name of the set of correlated parameter.

Definition at line 140 of file ModelParameter.h.

     {
         this->cgp_name = cgp_name;
     }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	output,
		const ModelParameter &	m
	)

friend

Befriending of the std::ostream operator << to generate an output stream for printing the model parameters.

Parameters

[out]	output	the formatted output stream to print the model parameters
[in]	m	a reference to an object of type ModelParameter()

Definition at line 32 of file ModelParameter.cpp.

 {
     output << "ModelParameter name, average, gaussian error, flat error" << std::endl;
     output << m.name << " " << m.ave << " " << m.errg << " " << m.errf << std::endl;
     return output;
 }

Member Data Documentation

◆ ave

double ModelParameter::ave

private

The average value of the model parameter.

Definition at line 155 of file ModelParameter.h.

◆ cgp_name

std::string ModelParameter::cgp_name

private

Definition at line 161 of file ModelParameter.h.

◆ errf

double ModelParameter::errf

private

The flat error of the model parameter.

Definition at line 157 of file ModelParameter.h.

◆ errg

double ModelParameter::errg

private

The Gaussian error of the model parameter.

Definition at line 156 of file ModelParameter.h.

◆ isFixed

bool ModelParameter::isFixed

private

A boolean flag that is true if the parameter is fixed.

Definition at line 160 of file ModelParameter.h.

◆ max

double ModelParameter::max

private

The maximum value of the model parameter.

Definition at line 159 of file ModelParameter.h.

◆ min

double ModelParameter::min

private

The minimum value of the model parameter.

Definition at line 158 of file ModelParameter.h.

◆ name

std::string ModelParameter::name

private

The name of the model parameter.

Definition at line 154 of file ModelParameter.h.

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

Detailed Description

Public Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ ModelParameter() [1/2]

◆ ModelParameter() [2/2]

◆ ~ModelParameter()

Member Function Documentation

◆ getave()

◆ getCgp_name()

◆ geterrf()

◆ geterrg()

◆ getmax()

◆ getmin()

◆ getname()

◆ IsCorrelated()

◆ IsFixed()

◆ ParseModelParameter()

◆ setCgp_name()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ ave

◆ cgp_name

◆ errf

◆ errg

◆ isFixed

◆ max

◆ min

◆ name