Contains a summary of the optimization. More...

Collaboration diagram for pallas::Basinhopping::Summary:

Public Attributes
LineSearchDirectionType	line_search_direction_type

TerminationType	termination_type

std::string	message

double	initial_cost

double	final_cost

GradientLocalMinimizer::Summary	local_minimization_summary

unsigned int	num_parameters

unsigned int	num_iterations

double	total_time_in_seconds

double	local_minimization_time_in_seconds

double	step_time_in_seconds

double	cost_evaluation_time_in_seconds

HistorySeries	history

Detailed Description

Contains a summary of the optimization.

This struct contains the result of the optimization and has convenience methods for printing reports of a completed optimization.

Member Function Documentation

std::string pallas::Basinhopping::Summary::BriefReport ( ) const

A brief one line description of the state of the solver after termination.

string pallas::Basinhopping::Summary::FullReport ( ) const

A full multi-line description of the state of the solver after termination.

double pallas::Basinhopping::Summary::cost_evaluation_time_in_seconds

Time spent evaluating cost function (outside local minimization)

double pallas::Basinhopping::Summary::final_cost

Cost of the problem (value of the objective function) after the optimization.

HistorySeries pallas::Basinhopping::Summary::history

History of the system saved on the interval specified by the history_save_frequency option.

double pallas::Basinhopping::Summary::initial_cost

Cost of the problem (value of the objective function) before the optimization.

LineSearchDirectionType pallas::Basinhopping::Summary::line_search_direction_type

Method to find the next search direction. Valid options are STEEPEST_DESCENT, NONLINEAR_CONJUGATE_GRADIENT, LBFGS, or BFGS

GradientLocalMinimizer::Summary pallas::Basinhopping::Summary::local_minimization_summary

Summary from the last local minimization iteration.

double pallas::Basinhopping::Summary::local_minimization_time_in_seconds

Time elapsed in local minimization

std::string pallas::Basinhopping::Summary::message

Message describing why the solver terminated.

unsigned int pallas::Basinhopping::Summary::num_iterations

Number of basinhopping iterations

unsigned int pallas::Basinhopping::Summary::num_parameters

Number of parameters in the problem.

double pallas::Basinhopping::Summary::step_time_in_seconds

Time spent calling the step function

TerminationType pallas::Basinhopping::Summary::termination_type

Reason optimization was terminated

double pallas::Basinhopping::Summary::total_time_in_seconds

Total time elapsed in global minimization

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