Fit::MinimizerResult Class Reference

Collaboration diagram for Fit::MinimizerResult:

Public Member Functions
	MinimizerResult ()
void	setParameters (const Parameters &parameters)
Parameters	parameters () const
void	setMinValue (double value)
double	minValue () const
std::string	toString () const
void	setReport (const std::string &value)
void	setDuration (double value)
void	setNumberOfCalls (int value)
void	setNumberOfGradientCalls (int value)

Private Attributes
double	m_min_value
int	m_number_of_calls
int	m_number_of_gradient_calls
double	m_duration
std::string	m_minimizer_report
Parameters	m_parameters

Detailed Description

Result of minimization round.

Definition at line 26 of file MinimizerResult.h.

Constructor & Destructor Documentation

MinimizerResult()

MinimizerResult::MinimizerResult

(

)

Definition at line 22 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

setParameters()

void MinimizerResult::setParameters

(

const Parameters &

parameters

)

Definition at line 27 of file MinimizerResult.cpp.

{
    m_parameters = parameters;
}

References m_parameters, and parameters().

Referenced by RootMinimizerAdapter::minimize(), and TestMinimizer::minimize_scalar().

Here is the call graph for this function:

parameters()

Parameters MinimizerResult::parameters

(

)

const

Definition at line 32 of file MinimizerResult.cpp.

{
    return m_parameters;
}

References m_parameters.

Referenced by setParameters().

setMinValue()

void MinimizerResult::setMinValue

(

double

value

)

Definition at line 37 of file MinimizerResult.cpp.

{
    m_min_value = value;
}

References m_min_value.

Referenced by RootMinimizerAdapter::minimize(), and TestMinimizer::minimize_scalar().

minValue()

double MinimizerResult::minValue

(

)

const

Minimum value of objective function found by minimizer.

Definition at line 44 of file MinimizerResult.cpp.

{
    return m_min_value;
}

References m_min_value.

toString()

std::string MinimizerResult::toString

(

)

const

Returns multi-line string representing minimization results.

Definition at line 51 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 << MinimizerUtils::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 << MinimizerResultUtils::reportParameters(m_parameters);
    }
 
    return result.str();
}

References m_duration, m_minimizer_report, m_number_of_calls, m_number_of_gradient_calls, m_parameters, MinimizerResultUtils::reportParameters(), and MinimizerUtils::sectionString().

Referenced by FitPrintService::fitResultString().

Here is the call graph for this function:

setReport()

void MinimizerResult::setReport

(

const std::string &

value

)

Definition at line 70 of file MinimizerResult.cpp.

{
    m_minimizer_report = value;
}

References m_minimizer_report.

Referenced by RootMinimizerAdapter::minimize(), and TestMinimizer::minimize_scalar().

setDuration()

void MinimizerResult::setDuration

(

double

value

)

Definition at line 75 of file MinimizerResult.cpp.

{
    m_duration = value;
}

References m_duration.

setNumberOfCalls()

void MinimizerResult::setNumberOfCalls

(

int

value

)

Definition at line 80 of file MinimizerResult.cpp.

{
    m_number_of_calls = value;
}

References m_number_of_calls.

Referenced by RootMinimizerAdapter::minimize(), and TestMinimizer::minimize_scalar().

setNumberOfGradientCalls()

void MinimizerResult::setNumberOfGradientCalls

(

int

value

)

Definition at line 85 of file MinimizerResult.cpp.

{
    m_number_of_gradient_calls = value;
}

References m_number_of_gradient_calls.

Referenced by RootMinimizerAdapter::minimize().

Member Data Documentation

m_min_value

double Fit::MinimizerResult::m_min_value

private

Found minimum of objective function.

Definition at line 48 of file MinimizerResult.h.

Referenced by minValue(), and setMinValue().

m_number_of_calls

int Fit::MinimizerResult::m_number_of_calls

private

Number of objective function calls.

Definition at line 49 of file MinimizerResult.h.

Referenced by setNumberOfCalls(), and toString().

m_number_of_gradient_calls

int Fit::MinimizerResult::m_number_of_gradient_calls

private

Number of calls to calculate gradients.

Definition at line 50 of file MinimizerResult.h.

Referenced by setNumberOfGradientCalls(), and toString().

m_duration

double Fit::MinimizerResult::m_duration

private

Duration of minimization in sec.msec.

Definition at line 51 of file MinimizerResult.h.

Referenced by setDuration(), and toString().

m_minimizer_report

std::string Fit::MinimizerResult::m_minimizer_report

private

Definition at line 52 of file MinimizerResult.h.

Referenced by setReport(), and toString().

m_parameters

Parameters Fit::MinimizerResult::m_parameters

private

Definition at line 53 of file MinimizerResult.h.

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

---

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

• /home/www/ba/Fit/Kernel/MinimizerResult.h
• /home/www/ba/Fit/Kernel/MinimizerResult.cpp