IterationInfo Class Reference

Description

Stores fit iteration info to track fit flow from various observers. Used in context of FitObjective.

Definition at line 25 of file IterationInfo.h.

Collaboration diagram for IterationInfo:

Public Member Functions
	IterationInfo ()
double	chi2 () const
unsigned	iterationCount () const
	Returns current number of minimizer iterations. More...
std::map< std::string, double >	parameterMap () const
	Returns map of fit parameter names and its current values. More...
mumufit::Parameters	parameters () const
void	update (const mumufit::Parameters &params, double chi2)

Private Attributes
double	m_chi2
mumufit::Parameters	m_current_parameters
unsigned	m_iteration_count

Constructor & Destructor Documentation

IterationInfo()

IterationInfo::IterationInfo

(

)

Definition at line 17 of file IterationInfo.cpp.

    : m_chi2(0.0)
    , m_iteration_count(0)
{
}

Member Function Documentation

chi2()

double IterationInfo::chi2

(

)

const

Definition at line 35 of file IterationInfo.cpp.

{
    return m_chi2;
}

References m_chi2.

Referenced by FitPrintService::iterationHeaderString(), and update().

iterationCount()

unsigned IterationInfo::iterationCount

(

)

const

Returns current number of minimizer iterations.

Definition at line 30 of file IterationInfo.cpp.

{
    return m_iteration_count;
}

References m_iteration_count.

Referenced by FitObjective::isFirstIteration(), and FitPrintService::iterationHeaderString().

parameterMap()

std::map< std::string, double > IterationInfo::parameterMap

(

)

const

Returns map of fit parameter names and its current values.

Definition at line 45 of file IterationInfo.cpp.

{
    std::map<std::string, double> result;
 
    for (const auto& par : m_current_parameters)
        result.insert(std::make_pair(par.name(), par.value()));
 
    return result;
}

References m_current_parameters.

parameters()

mumufit::Parameters IterationInfo::parameters

(

)

const

Definition at line 40 of file IterationInfo.cpp.

{
    return m_current_parameters;
}

References m_current_parameters.

Referenced by FitPrintService::parameterString().

update()

void IterationInfo::update	(	const mumufit::Parameters &	params,
		double	chi2
	)

Definition at line 23 of file IterationInfo.cpp.

{
    m_current_parameters = params;
    m_chi2 = chi2;
    m_iteration_count++;
}

References chi2(), m_chi2, m_current_parameters, and m_iteration_count.

Referenced by FitStatus::update().

Here is the call graph for this function:

Member Data Documentation

m_chi2

double IterationInfo::m_chi2

private

Definition at line 42 of file IterationInfo.h.

Referenced by chi2(), and update().

m_current_parameters

mumufit::Parameters IterationInfo::m_current_parameters

private

Definition at line 43 of file IterationInfo.h.

Referenced by parameterMap(), parameters(), and update().

m_iteration_count

unsigned IterationInfo::m_iteration_count

private

Definition at line 44 of file IterationInfo.h.

Referenced by iterationCount(), and update().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/IterationInfo.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Fitting/IterationInfo.cpp