Fit::Parameter Class Reference

Collaboration diagram for Fit::Parameter:

Public Member Functions
	Parameter ()
	Parameter (const std::string &name, double value, const AttLimits &limits=AttLimits::limitless(), double step=0.0)
std::string	name () const
double	startValue () const
AttLimits	limits () const
double	value () const
void	setValue (double value)
double	step () const
double	error () const
void	setError (double value)

Private Attributes
std::string	m_name
double	m_start_value
double	m_value
double	m_step
double	m_error
AttLimits	m_limits

Detailed Description

A fittable parameter with value, error, step, and limits.

Definition at line 27 of file Parameter.h.

Constructor & Destructor Documentation

Parameter() [1/2]

Parameter::Parameter

(

)

Definition at line 31 of file Parameter.cpp.

: m_start_value(0.0), m_value(0.0), m_step(0.0), m_error(0.0) {}

Parameter() [2/2]

Parameter::Parameter	(	const std::string &	name,
		double	value,
		const AttLimits &	limits = AttLimits::limitless(),
		double	step = 0.0
	)

Fit parameter constructor.

Parameters

name	unique name of fit parameters
value	starting value of fit parameter
limits	fit parameter limits
step	initial step of fit parameter during the minimization, will be calculated automatically, if zero.

Definition at line 33 of file Parameter.cpp.

    : m_name(name), m_start_value(value), m_value(value), m_step(step), m_error(0.0),
      m_limits(limits)
{
    if (step <= 0.0)
        m_step = step_for_value(value);
}

References m_step, step(), anonymous_namespace{Parameter.cpp}::step_for_value(), and value().

Here is the call graph for this function:

Member Function Documentation

name()

std::string Parameter::name

(

)

const

Definition at line 41 of file Parameter.cpp.

{
    return m_name;
}

References m_name.

Referenced by Fit::Parameters::add(), Fit::Parameters::operator[](), RootMinimizerAdapter::setParameter(), and GeneticMinimizer::setParameter().

startValue()

double Parameter::startValue

(

)

const

Definition at line 46 of file Parameter.cpp.

{
    return m_start_value;
}

References m_start_value.

limits()

AttLimits Parameter::limits

(

)

const

Definition at line 51 of file Parameter.cpp.

{
    return m_limits;
}

References m_limits.

Referenced by RootMinimizerAdapter::setParameter(), GeneticMinimizer::setParameter(), and GSLLevenbergMarquardtMinimizer::setParameter().

value()

double Parameter::value

(

)

const

Definition at line 56 of file Parameter.cpp.

{
    return m_value;
}

References m_value.

Referenced by Parameter(), setError(), RootMinimizerAdapter::setParameter(), and setValue().

setValue()

void Parameter::setValue

(

double

value

)

Definition at line 61 of file Parameter.cpp.

{
    m_value = value;
}

References m_value, and value().

Here is the call graph for this function:

step()

double Parameter::step

(

)

const

Definition at line 66 of file Parameter.cpp.

{
    return m_step;
}

References m_step.

Referenced by Parameter(), and RootMinimizerAdapter::setParameter().

error()

double Parameter::error

(

)

const

Definition at line 71 of file Parameter.cpp.

{
    return m_error;
}

References m_error.

setError()

void Parameter::setError

(

double

value

)

Definition at line 76 of file Parameter.cpp.

{
    m_error = value;
}

References m_error, and value().

Here is the call graph for this function:

Member Data Documentation

m_name

std::string Fit::Parameter::m_name

private

unique fit parameter name

Definition at line 56 of file Parameter.h.

Referenced by name().

m_start_value

double Fit::Parameter::m_start_value

private

starting value of fit parameters

Definition at line 57 of file Parameter.h.

Referenced by startValue().

m_value

double Fit::Parameter::m_value

private

current value of fit parameters

Definition at line 58 of file Parameter.h.

Referenced by setValue(), and value().

m_step

double Fit::Parameter::m_step

private

approximate initial step for the minimizer

Definition at line 59 of file Parameter.h.

Referenced by Parameter(), and step().

m_error

double Fit::Parameter::m_error

private

error of fit parameter calculated by the minimizer

Definition at line 60 of file Parameter.h.

Referenced by error(), and setError().

m_limits

AttLimits Fit::Parameter::m_limits

private

Definition at line 61 of file Parameter.h.

Referenced by limits().

---

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

• /home/www/ba/Fit/Kernel/Parameter.h
• /home/www/ba/Fit/Kernel/Parameter.cpp