Contains a summary of the optimization. More...

Collaboration diagram for pallas::SimulatedAnnealing::Summary:

Public Attributes
TerminationType	termination_type

CoolingScheduleType	cooling_schedule

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

bool	was_polished

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::SimulatedAnnealing::Summary::BriefReport ( ) const

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

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

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

CoolingScheduleType pallas::SimulatedAnnealing::Summary::cooling_schedule

The annealing schedule to used. Must be one of ‘FAST’, ‘CAUCHY’ or ‘BOLTZMANN’. see pallas::CoolingSchedule.

double pallas::SimulatedAnnealing::Summary::cost_evaluation_time_in_seconds

time spent evaluating cost function (outside local minimization)

double pallas::SimulatedAnnealing::Summary::final_cost

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

HistorySeries pallas::SimulatedAnnealing::Summary::history

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

double pallas::SimulatedAnnealing::Summary::initial_cost

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

GradientLocalMinimizer::Summary pallas::SimulatedAnnealing::Summary::local_minimization_summary

Summary from the local minimization polishing step (if performed).

double pallas::SimulatedAnnealing::Summary::local_minimization_time_in_seconds

time spent in local minimizer (if polishing was done).

std::string pallas::SimulatedAnnealing::Summary::message

Message describing why the solver terminated.

unsigned int pallas::SimulatedAnnealing::Summary::num_iterations

Number of iterations

unsigned int pallas::SimulatedAnnealing::Summary::num_parameters

Number of parameters in the problem.

double pallas::SimulatedAnnealing::Summary::step_time_in_seconds

time spent calling step function

TerminationType pallas::SimulatedAnnealing::Summary::termination_type

Reason optimization was terminated

double pallas::SimulatedAnnealing::Summary::total_time_in_seconds

total time elapsed in global minimizer

bool pallas::SimulatedAnnealing::Summary::was_polished

whether global minimum was polished after differential evolution completed

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