FitStatus Class Reference

Description

Contains status of the fitting (running, interupted etc) and all intermediate information which has to be collected during the fit. Owned by FitObjective.

Definition at line 39 of file FitStatus.h.

Collaboration diagram for FitStatus:

Public Member Functions
	FitStatus (const FitObjective *fit_objective)
	~FitStatus ()
void	addObserver (int every_nth, fit_observer_t &&)
void	finalize (const mumufit::MinimizerResult &result)
	Should be explicitly called on last iteration to notify all observers. More...
void	initPrint (int every_nth)
bool	isCompleted () const
bool	isInterrupted () const
IterationInfo	iterationInfo () const
mumufit::MinimizerResult	minimizerResult () const
void	setInterrupted ()
void	update (const mumufit::Parameters &params, double chi2)

Private Types
enum	EFitStatus {   IDLE , RUNNING , COMPLETED , FAILED ,   INTERRUPTED }

Private Attributes
const FitObjective *	m_fit_objective
EFitStatus	m_fit_status
IterationInfo	m_iterationInfo
std::unique_ptr< mumufit::MinimizerResult >	m_minimizer_result
FitObserver< FitObjective >	m_observers
std::unique_ptr< FitPrintService >	m_print_service

Member Enumeration Documentation

EFitStatus

enum FitStatus::EFitStatus

private

Enumerator
IDLE
RUNNING
COMPLETED
FAILED
INTERRUPTED

Definition at line 62 of file FitStatus.h.

{ IDLE, RUNNING, COMPLETED, FAILED, INTERRUPTED };

Constructor & Destructor Documentation

FitStatus()

FitStatus::FitStatus

(

const FitObjective *

fit_objective

)

Definition at line 21 of file FitStatus.cpp.

    : m_fit_status(IDLE)
    , m_fit_objective(fit_objective)
{
}

~FitStatus()

FitStatus::~FitStatus ( )

default

Member Function Documentation

addObserver()

void FitStatus::addObserver	(	int	every_nth,
		fit_observer_t &&	observer
	)

Definition at line 65 of file FitStatus.cpp.

{
    m_observers.addObserver(every_nth, std::move(observer));
}

References FitObserver< T >::addObserver(), and m_observers.

Referenced by initPrint().

Here is the call graph for this function:

finalize()

void FitStatus::finalize

(

const mumufit::MinimizerResult &

result

)

Should be explicitly called on last iteration to notify all observers.

Definition at line 84 of file FitStatus.cpp.

{
    m_minimizer_result = std::make_unique<mumufit::MinimizerResult>(result);
    m_fit_status = COMPLETED;
    m_observers.notify_all(*m_fit_objective);
}

References COMPLETED, m_fit_objective, m_fit_status, m_minimizer_result, m_observers, and FitObserver< T >::notify_all().

Here is the call graph for this function:

initPrint()

void FitStatus::initPrint

(

int

every_nth

)

Definition at line 54 of file FitStatus.cpp.

{
    m_print_service = std::make_unique<FitPrintService>();
 
    FitObserver<FitObjective>::observer_t callback = [&](const FitObjective& objective) {
        m_print_service->print(objective);
    };
 
    addObserver(every_nth, std::move(callback));
}

References addObserver(), and m_print_service.

Here is the call graph for this function:

isCompleted()

bool FitStatus::isCompleted

(

)

const

Definition at line 39 of file FitStatus.cpp.

{
    return m_fit_status == COMPLETED;
}

References COMPLETED, and m_fit_status.

isInterrupted()

bool FitStatus::isInterrupted

(

)

const

Definition at line 34 of file FitStatus.cpp.

{
    return m_fit_status == INTERRUPTED;
}

References INTERRUPTED, and m_fit_status.

Referenced by update().

iterationInfo()

IterationInfo FitStatus::iterationInfo

(

)

const

Definition at line 70 of file FitStatus.cpp.

{
    return m_iterationInfo;
}

References m_iterationInfo.

minimizerResult()

mumufit::MinimizerResult FitStatus::minimizerResult

(

)

const

Definition at line 75 of file FitStatus.cpp.

{
    if (!m_minimizer_result)
        throw std::runtime_error("FitStatus::minimizerResult() -> Minimizer result wasn't set. "
                                 "Make sure that FitObjective::finalize() was called.");
 
    return mumufit::MinimizerResult(*m_minimizer_result);
}

References m_minimizer_result.

setInterrupted()

void FitStatus::setInterrupted

(

)

Definition at line 29 of file FitStatus.cpp.

{
    m_fit_status = INTERRUPTED;
}

References INTERRUPTED, and m_fit_status.

update()

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

Definition at line 44 of file FitStatus.cpp.

{
    if (!isInterrupted())
        m_fit_status = RUNNING;
 
    m_iterationInfo.update(params, chi2);
 
    m_observers.notify(*m_fit_objective);
}

References isInterrupted(), m_fit_objective, m_fit_status, m_iterationInfo, m_observers, FitObserver< T >::notify(), RUNNING, and IterationInfo::update().

Here is the call graph for this function:

Member Data Documentation

m_fit_objective

const FitObjective* FitStatus::m_fit_objective

private

Definition at line 66 of file FitStatus.h.

Referenced by finalize(), and update().

m_fit_status

EFitStatus FitStatus::m_fit_status

private

Definition at line 63 of file FitStatus.h.

Referenced by finalize(), isCompleted(), isInterrupted(), setInterrupted(), and update().

m_iterationInfo

IterationInfo FitStatus::m_iterationInfo

private

Definition at line 67 of file FitStatus.h.

Referenced by iterationInfo(), and update().

m_minimizer_result

std::unique_ptr<mumufit::MinimizerResult> FitStatus::m_minimizer_result

private

Definition at line 68 of file FitStatus.h.

Referenced by finalize(), and minimizerResult().

m_observers

FitObserver<FitObjective> FitStatus::m_observers

private

Definition at line 64 of file FitStatus.h.

Referenced by addObserver(), finalize(), and update().

m_print_service

std::unique_ptr<FitPrintService> FitStatus::m_print_service

private

Definition at line 65 of file FitStatus.h.

Referenced by initPrint().

---

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

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