mumufit::Parameters Class Reference

A collection of fit parameters. More...

Public Types
using	const_iterator = parameters_t::const_iterator
using	corr_matrix_t = std::vector< std::vector< double > >
using	iterator = parameters_t::iterator
using	parameters_t = std::vector< Parameter >

Public Member Functions
	Parameters ()=default
void	add (const Parameter &par)
iterator	begin ()
const_iterator	begin () const
corr_matrix_t	correlationMatrix () const
iterator	end ()
const_iterator	end () const
std::vector< double >	errors () const
size_t	freeParameterCount () const
	Returns number of free parameters. More...
const Parameter &	operator[] (const std::string &name) const
const Parameter &	operator[] (size_t index) const
void	setCorrelationMatrix (const corr_matrix_t &matrix)
void	setErrors (const std::vector< double > &errors)
void	setValues (const std::vector< double > &values)
size_t	size () const
std::vector< double >	values () const

Private Member Functions
void	check_array_size (const std::vector< double > &values) const
size_t	check_index (size_t index) const
bool	exists (const std::string &parameter_name) const

Private Attributes
corr_matrix_t	m_corr_matrix
	correlation matrix More...
parameters_t	m_parameters

Detailed Description

A collection of fit parameters.

Definition at line 26 of file Parameters.h.

Member Typedef Documentation

const_iterator

using mumufit::Parameters::const_iterator = parameters_t::const_iterator

Definition at line 29 of file Parameters.h.

corr_matrix_t

using mumufit::Parameters::corr_matrix_t = std::vector<std::vector<double> >

Definition at line 31 of file Parameters.h.

iterator

using mumufit::Parameters::iterator = parameters_t::iterator

Definition at line 30 of file Parameters.h.

parameters_t

using mumufit::Parameters::parameters_t = std::vector<Parameter>

Definition at line 28 of file Parameters.h.

Constructor & Destructor Documentation

Parameters()

mumufit::Parameters::Parameters ( )

default

Member Function Documentation

add()

void Parameters::add

(

const Parameter &

par

)

Definition at line 22 of file Parameters.cpp.

{
    if (exists(par.name()))
        throw std::runtime_error("Parameters::add() -> Error. Parameter with the name '"
                                 + par.name() + "' already exists.");
 
    m_parameters.push_back(par);
}

References exists(), m_parameters, and mumufit::Parameter::name().

Referenced by FitParameterContainerItem::createParameters(), and MinimizerTestPlan::parameters().

Here is the call graph for this function:

begin() [1/2]

Parameters::iterator Parameters::begin

(

)

Definition at line 41 of file Parameters.cpp.

{
    return m_parameters.begin();
}

References m_parameters.

begin() [2/2]

Parameters::const_iterator Parameters::begin

(

)

const

Definition at line 31 of file Parameters.cpp.

{
    return m_parameters.begin();
}

References m_parameters.

check_array_size()

void Parameters::check_array_size ( const std::vector< double > &  values ) const

private

Definition at line 149 of file Parameters.cpp.

{
    if (values.size() != m_parameters.size()) {
        std::ostringstream ostr;
        ostr << "Parameters::check_array_size() -> Error. Size of input array " << values.size()
             << " doesn't mach number of fit parameters " << m_parameters.size() << "."
             << std::endl;
        throw std::runtime_error(ostr.str());
    }
}

References m_parameters, and values().

Referenced by setErrors(), and setValues().

Here is the call graph for this function:

check_index()

size_t Parameters::check_index ( size_t  index ) const

private

Definition at line 160 of file Parameters.cpp.

{
    if (index >= m_parameters.size())
        throw std::runtime_error("Parameters::check_index() -> Index out of bounds");
    return index;
}

References m_parameters.

Referenced by operator[]().

correlationMatrix()

Parameters::corr_matrix_t Parameters::correlationMatrix

(

)

const

Definition at line 117 of file Parameters.cpp.

{
    return m_corr_matrix;
}

References m_corr_matrix.

end() [1/2]

Parameters::iterator Parameters::end

(

)

Definition at line 46 of file Parameters.cpp.

{
    return m_parameters.end();
}

References m_parameters.

end() [2/2]

Parameters::const_iterator Parameters::end

(

)

const

Definition at line 36 of file Parameters.cpp.

{
    return m_parameters.end();
}

References m_parameters.

errors()

std::vector< double > Parameters::errors

(

)

const

Definition at line 82 of file Parameters.cpp.

{
    std::vector<double> result;
    for (const auto& par : m_parameters)
        result.push_back(par.error());
    return result;
}

References m_parameters.

Referenced by setErrors().

exists()

bool Parameters::exists ( const std::string &  parameter_name ) const

private

Definition at line 141 of file Parameters.cpp.

{
    for (const auto& par : m_parameters)
        if (par.name() == name)
            return true;
    return false;
}

References m_parameters, and RealSpace::Particles::name().

Referenced by add().

Here is the call graph for this function:

freeParameterCount()

size_t Parameters::freeParameterCount

(

)

const

Returns number of free parameters.

Definition at line 132 of file Parameters.cpp.

{
    size_t result(0);
    for (const auto& par : m_parameters)
        if (!par.limits().isFixed())
            result++;
    return result;
}

References m_parameters.

Referenced by mumufit::ResidualFunctionAdapter::chi2().

operator[]() [1/2]

const Parameter & Parameters::operator[]

(

const std::string &

name

)

const

Definition at line 98 of file Parameters.cpp.

{
    for (const auto& par : m_parameters)
        if (par.name() == name)
            return par;
 
    std::ostringstream ostr;
    ostr << "Parameters::operator[] -> Error. No parameter with name '" << name << "'. ";
    ostr << "Existing names:\n";
    for (const auto& par : m_parameters)
        ostr << par.name() << "\n";
    throw std::runtime_error(ostr.str());
}

References m_parameters, and RealSpace::Particles::name().

Here is the call graph for this function:

operator[]() [2/2]

const Parameter & Parameters::operator[]

(

size_t

index

)

const

Definition at line 112 of file Parameters.cpp.

{
    return m_parameters[check_index(index)];
}

References check_index(), and m_parameters.

Here is the call graph for this function:

setCorrelationMatrix()

void Parameters::setCorrelationMatrix

(

const corr_matrix_t &

matrix

)

Definition at line 122 of file Parameters.cpp.

{
    if (matrix.size() != size())
        throw std::runtime_error("Parameters::setCorrelationMatrix() -> Error. Wrong "
                                 "dimension of correlation matrix.");
    m_corr_matrix = matrix;
}

References m_corr_matrix, and size().

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

setErrors()

void Parameters::setErrors

(

const std::vector< double > &

errors

)

Definition at line 90 of file Parameters.cpp.

{
    check_array_size(errors);
    size_t index = 0;
    for (auto& par : m_parameters)
        par.setError(errors[index++]);
}

References check_array_size(), errors(), and m_parameters.

Referenced by MinimizerAdapter::propagateResults().

Here is the call graph for this function:

setValues()

void Parameters::setValues

(

const std::vector< double > &

values

)

Definition at line 64 of file Parameters.cpp.

{
    check_array_size(values);
 
    size_t index = 0;
    for (auto& par : m_parameters) {
        if (std::isnan(values[index]))
            throw std::runtime_error("Parameters::setValues() -> Error."
                                     " Attempt to set nan '"
                                     + par.name() + "'.");
        if (std::isinf(values[index]))
            throw std::runtime_error("Parameters::setValues() -> Error. Attempt to set inf '"
                                     + par.name() + "'.");
        par.setValue(values[index]);
        ++index;
    }
}

References check_array_size(), m_parameters, and values().

Referenced by mumufit::ResidualFunctionAdapter::get_residuals(), MinimizerAdapter::propagateResults(), and mumufit::ScalarFunctionAdapter::rootObjectiveFunction().

Here is the call graph for this function:

size()

size_t Parameters::size

(

)

const

Definition at line 51 of file Parameters.cpp.

{
    return m_parameters.size();
}

References m_parameters.

Referenced by FitObjective::evaluate(), mumufit::ResidualFunctionAdapter::get_residuals(), mumufit::ScalarFunctionAdapter::rootObjectiveFunction(), mumufit::ResidualFunctionAdapter::rootResidualFunction(), and setCorrelationMatrix().

values()

std::vector< double > Parameters::values

(

)

const

Definition at line 56 of file Parameters.cpp.

{
    std::vector<double> result;
    for (const auto& par : m_parameters)
        result.push_back(par.value());
    return result;
}

References m_parameters.

Referenced by check_array_size(), setValues(), GUIFitObserver::update(), and FitObjectiveBuilder::update_fit_parameters().

Member Data Documentation

m_corr_matrix

corr_matrix_t mumufit::Parameters::m_corr_matrix

private

correlation matrix

Definition at line 65 of file Parameters.h.

Referenced by correlationMatrix(), and setCorrelationMatrix().

m_parameters

parameters_t mumufit::Parameters::m_parameters

private

Definition at line 64 of file Parameters.h.

Referenced by add(), begin(), check_array_size(), check_index(), end(), errors(), exists(), freeParameterCount(), operator[](), setErrors(), setValues(), size(), and values().

---

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

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