Representation of the parameters of the exploration algorithm by layers. More...

#include <Exploration_parameters.hpp>

Classes
class	Is_lower_sample

Public Types
typedef NumberType	FT

typedef T_Exploration_parameters_with_layers< FT, Distance >	Self

typedef SBL::IO::Loader_base	Base

typedef SBL::Models::T_Conformation_traits< typename Distance::Point >	Conformation_traits

Public Member Functions
boost::program_options::options_description	add_options (void) const
	Virtual method for adding options to the module. More...

bool	load (unsigned verbose, std::ostream &out)
	Loads the data. More...

bool	check_options (std::string &message) const
	Checks that the input options' values are coherent. More...

std::string	get_name (void) const
	Return the name of the class itself. More...

std::string	get_output_prefix (void) const
	Returns a prefix that concatains the input line options used when running the module. More...

template<class ExplorationAlgorithm >
void	update_after_selection (ExplorationAlgorithm &explorer, typename ExplorationAlgorithm::EL_sample_rep s)

template<class ExplorationAlgorithm >
void	update_after_insertion (ExplorationAlgorithm &explorer, typename ExplorationAlgorithm::EL_sample_rep s)

template<class ExplorationAlgorithm >
void	update_after_tuning (ExplorationAlgorithm &explorer, typename ExplorationAlgorithm::EL_sample_rep s)

template<class ExplorationAlgorithm >
const FT &	get_initial_temperature (ExplorationAlgorithm &explorer) const

template<class ExplorationAlgorithm >
const FT &	get_initial_displace_delta (ExplorationAlgorithm &explorer) const

template<class ExplorationAlgorithm >
const FT &	get_temperature (ExplorationAlgorithm &explorer) const

template<class ExplorationAlgorithm >
void	set_temperature (ExplorationAlgorithm &explorer, const FT &temperature)

template<class ExplorationAlgorithm >
const FT &	get_displace_delta (ExplorationAlgorithm &explorer) const

template<class ExplorationAlgorithm >
void	set_displace_delta (ExplorationAlgorithm &explorer, const FT &displace_delta)

template<class ExplorationAlgorithm >
const FT &	get_epsilon_height (ExplorationAlgorithm &explorer) const

template<class ExplorationAlgorithm >
const FT &	get_epsilon_distance (ExplorationAlgorithm &explorer) const

Static Public Member Functions
static bool	is_lower (const typename Distance::Point &p, const typename Distance::Point &q)

static bool	are_identical (const typename Distance::Point &p, const typename Distance::Point &q)

static boost::program_options::options_description *&	get_options (void)
	Access to the options' description of the module. More...

static bool	has_options (void)

static void	delete_options (void)

static void	initialize_options (const std::string &caption)

Management
void	set_loader_instance_name (const std::string &loader_instance_name)

const std::string &	get_loader_instance_name (void) const

Detailed Description

template<class NumberType, class Distance>
class T_Exploration_parameters_with_layers< NumberType, Distance >

Representation of the parameters of the exploration algorithm by layers.

It works as the class T_Exploration_parameters_default except that it is possible to initialize different layers of parameters, each layer initializing its own temperature, lambda_T, displace delta and lambda_D. Each layer is defined by a (possibly infinite) interval of energy for which the parameters are adapted and make more sense for the algorithm.

Template Parameters

NumberType	Output number type of the distance.
Distance	Distance functor between two conformations.

Member Typedef Documentation

◆ Base

typedef SBL::IO::Loader_base Base

◆ Conformation_traits

typedef SBL::Models::T_Conformation_traits<typename Distance::Point> Conformation_traits

◆ FT

typedef NumberType FT

◆ Self

typedef T_Exploration_parameters_with_layers<FT, Distance> Self

Member Function Documentation

◆ add_options()

boost::program_options::options_description add_options ( void ) const

inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ are_identical()

static bool are_identical	(	const typename Distance::Point &	p,
		const typename Distance::Point &	q
	)

inlinestatic

◆ check_options()

bool check_options ( std::string & message ) const

inlinevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

◆ delete_options()

static void delete_options ( void )

inlinestaticinherited

◆ get_displace_delta()

const FT& get_displace_delta ( ExplorationAlgorithm & explorer ) const

inline

◆ get_epsilon_distance()

const FT& get_epsilon_distance ( ExplorationAlgorithm & explorer ) const

inline

◆ get_epsilon_height()

const FT& get_epsilon_height ( ExplorationAlgorithm & explorer ) const

inline

◆ get_initial_displace_delta()

const FT& get_initial_displace_delta ( ExplorationAlgorithm & explorer ) const

inline

◆ get_initial_temperature()

const FT& get_initial_temperature ( ExplorationAlgorithm & explorer ) const

inline

◆ get_loader_instance_name()

const std::string& get_loader_instance_name ( void ) const

inlineinherited

◆ get_name()

std::string get_name ( void ) const

inlinevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

◆ get_options()

static boost::program_options::options_description*& get_options ( void )

inlinestaticinherited

Access to the options' description of the module.

◆ get_output_prefix()

std::string get_output_prefix ( void ) const

inlinevirtual

Returns a prefix that concatains the input line options used when running the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ get_temperature()

const FT& get_temperature ( ExplorationAlgorithm & explorer ) const

inline

◆ has_options()

static bool has_options ( void )

inlinestaticinherited

◆ initialize_options()

static void initialize_options ( const std::string & caption )

inlinestaticinherited

◆ is_lower()

static bool is_lower	(	const typename Distance::Point &	p,
		const typename Distance::Point &	q
	)

inlinestatic

◆ load()

bool load	(	unsigned	verbose,
		std::ostream &	out
	)

inlinevirtual

Loads the data.

Reimplemented from Loader_base.

◆ set_displace_delta()

void set_displace_delta	(	ExplorationAlgorithm &	explorer,
		const FT &	displace_delta
	)

inline

◆ set_loader_instance_name()

void set_loader_instance_name ( const std::string & loader_instance_name )

inlineinherited

◆ set_temperature()

void set_temperature	(	ExplorationAlgorithm &	explorer,
		const FT &	temperature
	)

inline

◆ update_after_insertion()

void update_after_insertion	(	ExplorationAlgorithm &	explorer,
		typename ExplorationAlgorithm::EL_sample_rep	s
	)

inline

◆ update_after_selection()

void update_after_selection	(	ExplorationAlgorithm &	explorer,
		typename ExplorationAlgorithm::EL_sample_rep	s
	)

inline

◆ update_after_tuning()

void update_after_tuning	(	ExplorationAlgorithm &	explorer,
		typename ExplorationAlgorithm::EL_sample_rep	s
	)

inline

Classes

Public Types

Public Member Functions

Static Public Member Functions

Management

Detailed Description

template<class NumberType, class Distance> class T_Exploration_parameters_with_layers< NumberType, Distance >

Member Typedef Documentation

◆ Base

◆ Conformation_traits

◆ FT

◆ Self

Member Function Documentation

◆ add_options()

◆ are_identical()

◆ check_options()

◆ delete_options()

◆ get_displace_delta()

◆ get_epsilon_distance()

◆ get_epsilon_height()

◆ get_initial_displace_delta()

◆ get_initial_temperature()

◆ get_loader_instance_name()

◆ get_name()

◆ get_options()

◆ get_output_prefix()

◆ get_temperature()

◆ has_options()

◆ initialize_options()

◆ is_lower()

◆ load()

◆ set_displace_delta()

◆ set_loader_instance_name()

◆ set_temperature()

◆ update_after_insertion()

◆ update_after_selection()

◆ update_after_tuning()

template<class NumberType, class Distance>
class T_Exploration_parameters_with_layers< NumberType, Distance >