pallas::Basinhopping::Options Struct Reference

#include <basinhopping.h>

Collaboration diagram for pallas::Basinhopping::Options:

Public Member Functions
	Options ()
	Default constructor. More...
void	set_step_function (scoped_ptr< StepFunction > &user_step_function)
	Convenience function for changing the default step function. More...

Public Attributes
GradientLocalMinimizer::Options	local_minimizer_options
scoped_ptr< StepFunction >	step_function
unsigned int	max_iterations
unsigned int	max_stagnant_iterations
double	minimum_cost
bool	is_silent
unsigned int	history_save_frequency

Detailed Description

Configurable options for modifying the default behaviour of the basinhopping algorithm.

Constructor & Destructor Documentation

pallas::Basinhopping::Options::Options ( )

inline

Default constructor.

This tries to set up reasonable defaults for optimization. It is highly recommended that the user read and overwrite the defaults based on the cost function.

Member Function Documentation

void pallas::Basinhopping::Options::set_step_function ( scoped_ptr< StepFunction > &  user_step_function )

inline

Convenience function for changing the default step function.

This function simply swaps the scoped_ptr to the user defined StepFunction with the scoped_ptr to the StepFunction held within the pallas::Basinhopping::Options struct.

Parameters

user_step_function

pallas::scoped_ptr<pallas::StepFunction>. This function generates randomized candidate solutions based on the current position.

Member Data Documentation

unsigned int pallas::Basinhopping::Options::history_save_frequency

Frequency to save the state of the system. Values will be appended to a HistorySeries contained in the optimization summary. Default is 0. If 0 then history is not saved. Otherwise, the state of the system will be appended to the series when i % history_save_frequency == 0. If there are a large number of iterations this can lead to a lot of data being stored in memory.

bool pallas::Basinhopping::Options::is_silent

Whether to log failure information relating the to global optimization algorithm using glog.

GradientLocalMinimizer::Options pallas::Basinhopping::Options::local_minimizer_options

Contains any changes to the default options for the local minimization algorithm. See the documentation for ceres::GradientProblemSolver::Options for relevant options

unsigned int pallas::Basinhopping::Options::max_iterations

Maximum number of basinhopping iterations.

unsigned int pallas::Basinhopping::Options::max_stagnant_iterations

Maximum number sequential basinhopping iterations allowed without finding a new global minimum.

double pallas::Basinhopping::Options::minimum_cost

User specified minimum cost. Minimization will halt if minimum_cost is reached.

scoped_ptr<StepFunction> pallas::Basinhopping::Options::step_function

Function that produces randomized candidate solutions.

---

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

• include/pallas/basinhopping.h