mumufit::Parameter Class Reference

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

Collaboration diagram for mumufit::Parameter:

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

Private Attributes
double	m_error
	error of fit parameter calculated by the minimizer More...
AttLimits	m_limits
std::string	m_name
	unique fit parameter name More...
double	m_start_value
	starting value of fit parameters More...
double	m_step
	approximate initial step for the minimizer More...
double	m_value
	current value of fit parameters More...

Detailed Description

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

Definition at line 26 of file Parameter.h.

Constructor & Destructor Documentation

Parameter() [1/2]

Parameter::Parameter

(

)

Definition at line 30 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 32 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(), and value().

Here is the call graph for this function:

Member Function Documentation

error()

double Parameter::error

(

)

const

Definition at line 74 of file Parameter.cpp.

{
    return m_error;
}

References m_error.

limits()

AttLimits Parameter::limits

(

)

const

Definition at line 54 of file Parameter.cpp.

{
    return m_limits;
}

References m_limits.

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

name()

std::string Parameter::name

(

)

const

Definition at line 44 of file Parameter.cpp.

{
    return m_name;
}

References m_name.

Referenced by mumufit::Parameters::add(), MinimizerAdapter::setParameter(), and GeneticMinimizer::setParameter().

setError()

void Parameter::setError

(

double

value

)

Definition at line 79 of file Parameter.cpp.

{
    m_error = value;
}

References m_error, and value().

Here is the call graph for this function:

setValue()

void Parameter::setValue

(

double

value

)

Definition at line 64 of file Parameter.cpp.

{
    m_value = value;
}

References m_value, and value().

Here is the call graph for this function:

startValue()

double Parameter::startValue

(

)

const

Definition at line 49 of file Parameter.cpp.

{
    return m_start_value;
}

References m_start_value.

step()

double Parameter::step

(

)

const

Definition at line 69 of file Parameter.cpp.

{
    return m_step;
}

References m_step.

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

value()

double Parameter::value

(

)

const

Definition at line 59 of file Parameter.cpp.

{
    return m_value;
}

References m_value.

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

Member Data Documentation

m_error

double mumufit::Parameter::m_error

private

error of fit parameter calculated by the minimizer

Definition at line 58 of file Parameter.h.

Referenced by error(), and setError().

m_limits

AttLimits mumufit::Parameter::m_limits

private

Definition at line 59 of file Parameter.h.

Referenced by limits().

m_name

std::string mumufit::Parameter::m_name

private

unique fit parameter name

Definition at line 54 of file Parameter.h.

Referenced by name().

m_start_value

double mumufit::Parameter::m_start_value

private

starting value of fit parameters

Definition at line 55 of file Parameter.h.

Referenced by startValue().

m_step

double mumufit::Parameter::m_step

private

approximate initial step for the minimizer

Definition at line 57 of file Parameter.h.

Referenced by Parameter(), and step().

m_value

double mumufit::Parameter::m_value

private

current value of fit parameters

Definition at line 56 of file Parameter.h.

Referenced by setValue(), and value().

---

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

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