FunctionParameter Class Reference

#include <FunctionParameter.h>

Collaboration diagram for FunctionParameter:

[legend]List of all members.

---

Detailed Description

A class to collect function parameters from a FunctionBase object but also the constraints and errors from the Fitter object Objects of this class can then be delivered to client code so that such code does not need to know how to collect what it needs itself.

This class is equivalent to Minuit's MinuitParameter class.

Author:

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 31 of file FunctionParameter.h.

Public Member Functions
double	error () const
	Returns the error on the value of the parameter.
	FunctionParameter (const std::string &name, double value, double error, bool fixed, double low_limit, double high_limit, bool has_low, bool has_high)
	The constructor.
bool	hasLowerLimit () const
	Returns true if lower limit on parameters being used.
bool	hasUpperLimit () const
	Returns true if upper limit on parameters being used.
bool	isFixed () const
	Returns the fixed flag.
double	lowerLimit () const
	Returns the lower limit, if any on the parameter.
const std::string &	name () const
	Returns the name of the parameter.
double	upperLimit () const
	Returns the upper limit, if any on the parameter.
double	value () const
	Returns the value of the parameter.
Private Attributes
double	m_error
	The error on the value after fitting.
bool	m_fixed
	The fixed flag used by the minimizer.
bool	m_has_lower
	The has low limit flag.
bool	m_has_upper
	The has uppper limit flag.
double	m_lower_limit
	The lower limit allowed during fitting.
std::string	m_name
	The name of the parameter.
double	m_upper_limit
	the upper limit allowed during fitting.
double	m_value
	The value of the parameter.

---

Constructor & Destructor Documentation

FunctionParameter	(	const std::string &	name,
		double	value,
		double	error,
		bool	fixed,
		double	low_limit,
		double	high_limit,
		bool	has_low,
		bool	has_high
	)

The constructor.

Definition at line 19 of file FunctionParameter.cxx.

---

Member Function Documentation

double error

(

)

const

Returns the error on the value of the parameter.

Definition at line 54 of file FunctionParameter.cxx.

References FunctionParameter::m_error.

bool hasLowerLimit

(

)

const

Returns true if lower limit on parameters being used.

Definition at line 82 of file FunctionParameter.cxx.

References FunctionParameter::m_has_lower.

bool hasUpperLimit

(

)

const

Returns true if upper limit on parameters being used.

Definition at line 90 of file FunctionParameter.cxx.

References FunctionParameter::m_has_upper.

bool isFixed

(

)

const

Returns the fixed flag.

Definition at line 61 of file FunctionParameter.cxx.

References FunctionParameter::m_fixed.

double lowerLimit

(

)

const

Returns the lower limit, if any on the parameter.

Definition at line 68 of file FunctionParameter.cxx.

References FunctionParameter::m_lower_limit.

const std::string & name

(

)

const

Returns the name of the parameter.

Definition at line 40 of file FunctionParameter.cxx.

References FunctionParameter::m_name.

double upperLimit

(

)

const

Returns the upper limit, if any on the parameter.

Definition at line 75 of file FunctionParameter.cxx.

References FunctionParameter::m_upper_limit.

double value

(

)

const

Returns the value of the parameter.

Definition at line 47 of file FunctionParameter.cxx.

References FunctionParameter::m_value.

---

Member Data Documentation

double m_error [private]

The error on the value after fitting.

Definition at line 46 of file FunctionParameter.h.

Referenced by FunctionParameter::error().

bool m_fixed [private]

The fixed flag used by the minimizer.

Definition at line 58 of file FunctionParameter.h.

Referenced by FunctionParameter::isFixed().

bool m_has_lower [private]

The has low limit flag.

Definition at line 62 of file FunctionParameter.h.

Referenced by FunctionParameter::hasLowerLimit().

bool m_has_upper [private]

The has uppper limit flag.

Definition at line 65 of file FunctionParameter.h.

Referenced by FunctionParameter::hasUpperLimit().

double m_lower_limit [private]

The lower limit allowed during fitting.

Definition at line 50 of file FunctionParameter.h.

Referenced by FunctionParameter::lowerLimit().

std::string m_name [private]

The name of the parameter.

Definition at line 38 of file FunctionParameter.h.

Referenced by FunctionParameter::name().

double m_upper_limit [private]

the upper limit allowed during fitting.

Definition at line 54 of file FunctionParameter.h.

Referenced by FunctionParameter::upperLimit().

double m_value [private]

The value of the parameter.

Definition at line 42 of file FunctionParameter.h.

Referenced by FunctionParameter::value().

---

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

• FunctionParameter.h
• FunctionParameter.cxx

---