mumufit::MinimizerResult Class Reference

Description

Result of minimization round.

Definition at line 25 of file MinimizerResult.h.

Collaboration diagram for mumufit::MinimizerResult:

Public Member Functions
	MinimizerResult ()
double	minValue () const
	Minimum value of objective function found by minimizer. More...
Parameters	parameters () const
void	setDuration (double value)
void	setMinValue (double value)
void	setNumberOfCalls (int value)
void	setNumberOfGradientCalls (int value)
void	setParameters (const Parameters &parameters)
void	setReport (const std::string &value)
std::string	toString () const
	Returns multi-line string representing minimization results. More...

Private Attributes
double	m_duration
	Duration of minimization in sec.msec. More...
double	m_min_value
	Found minimum of objective function. More...
std::string	m_minimizer_report
int	m_number_of_calls
	Number of objective function calls. More...
int	m_number_of_gradient_calls
	Number of calls to calculate gradients. More...
Parameters	m_parameters

Constructor & Destructor Documentation

MinimizerResult()

MinimizerResult::MinimizerResult

(

)

Definition at line 58 of file MinimizerResult.cpp.

    : m_min_value(0.0)
    , m_number_of_calls(0)
    , m_number_of_gradient_calls(0)
    , m_duration(0.0)
{
}

Member Function Documentation

minValue()

double MinimizerResult::minValue

(

)

const

Minimum value of objective function found by minimizer.

Definition at line 83 of file MinimizerResult.cpp.

{
    return m_min_value;
}

References m_min_value.

parameters()

Parameters MinimizerResult::parameters

(

)

const

Definition at line 71 of file MinimizerResult.cpp.

{
    return m_parameters;
}

References m_parameters.

Referenced by setParameters().

setDuration()

void MinimizerResult::setDuration

(

double

value

)

Definition at line 113 of file MinimizerResult.cpp.

{
    m_duration = value;
}

References m_duration.

setMinValue()

void MinimizerResult::setMinValue

(

double

value

)

Definition at line 76 of file MinimizerResult.cpp.

{
    m_min_value = value;
}

References m_min_value.

Referenced by MinimizerAdapter::minimize().

setNumberOfCalls()

void MinimizerResult::setNumberOfCalls

(

int

value

)

Definition at line 118 of file MinimizerResult.cpp.

{
    m_number_of_calls = value;
}

References m_number_of_calls.

Referenced by MinimizerAdapter::minimize().

setNumberOfGradientCalls()

void MinimizerResult::setNumberOfGradientCalls

(

int

value

)

Definition at line 123 of file MinimizerResult.cpp.

{
    m_number_of_gradient_calls = value;
}

References m_number_of_gradient_calls.

Referenced by MinimizerAdapter::minimize().

setParameters()

void MinimizerResult::setParameters

(

const Parameters &

parameters

)

Definition at line 66 of file MinimizerResult.cpp.

{
    m_parameters = parameters;
}

References m_parameters, and parameters().

Referenced by MinimizerAdapter::minimize().

Here is the call graph for this function:

setReport()

void MinimizerResult::setReport

(

const std::string &

value

)

Definition at line 108 of file MinimizerResult.cpp.

{
    m_minimizer_report = value;
}

References m_minimizer_report.

Referenced by MinimizerAdapter::minimize().

toString()

std::string MinimizerResult::toString

(

)

const

Returns multi-line string representing minimization results.

Definition at line 90 of file MinimizerResult.cpp.

{
    std::ostringstream result;
    if (m_minimizer_report.empty()) {
        result << "Don't know anything about external minimizer. "
               << "Use minimizer API to get result of minimization.\n";
    } else {
        result << mumufit::utils::sectionString();
        result << "Run time (sec)           : " << m_duration << "\n";
        result << "Objective function calls : " << m_number_of_calls << "\n";
        result << "Gradient calls           : " << m_number_of_gradient_calls << "\n";
        result << m_minimizer_report;
        result << reportParameters(m_parameters);
    }
 
    return result.str();
}

References m_duration, m_minimizer_report, m_number_of_calls, m_number_of_gradient_calls, m_parameters, and mumufit::utils::sectionString().

Referenced by FitPrintService::fitResultString().

Here is the call graph for this function:

Member Data Documentation

m_duration

double mumufit::MinimizerResult::m_duration

private

Duration of minimization in sec.msec.

Definition at line 49 of file MinimizerResult.h.

Referenced by setDuration(), and toString().

m_min_value

double mumufit::MinimizerResult::m_min_value

private

Found minimum of objective function.

Definition at line 46 of file MinimizerResult.h.

Referenced by minValue(), and setMinValue().

m_minimizer_report

std::string mumufit::MinimizerResult::m_minimizer_report

private

Definition at line 50 of file MinimizerResult.h.

Referenced by setReport(), and toString().

m_number_of_calls

int mumufit::MinimizerResult::m_number_of_calls

private

Number of objective function calls.

Definition at line 47 of file MinimizerResult.h.

Referenced by setNumberOfCalls(), and toString().

m_number_of_gradient_calls

int mumufit::MinimizerResult::m_number_of_gradient_calls

private

Number of calls to calculate gradients.

Definition at line 48 of file MinimizerResult.h.

Referenced by setNumberOfGradientCalls(), and toString().

m_parameters

Parameters mumufit::MinimizerResult::m_parameters

private

Definition at line 51 of file MinimizerResult.h.

Referenced by parameters(), setParameters(), and toString().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Minimizer/MinimizerResult.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Minimizer/MinimizerResult.cpp