Module for selecting a sample to extend during the explorer algorithm. More...

#include <Sample_selector_module.hpp>

Public Types
typedef T_Sample_selector_module< ModuleTraits >	Self

typedef SBL::Modules::Module_base	Base

typedef ModuleTraits::Exploration_parameters	Exploration_parameters

typedef ModuleTraits::Exploration_algorithm	Exploration_algorithm

typedef Exploration_algorithm::Sample_selector	Sample_selector

typedef Exploration_algorithm::EL_sample_rep	EL_sample_rep

typedef ModuleTraits::EL_sample_type	EL_sample_type

typedef SBL::Models::T_Conformation_traits< EL_sample_type >	Conformation_traits

Static Public Member Functions
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)

Attributes
	T_Sample_selector_module (void)

	T_Sample_selector_module (const Self &other)

Accessors
void	set_selector (Sample_selector &selector)

Exploration_parameters *&	get_exploration_parameters (void)

Exploration_algorithm *&	get_exploration_algorithm (void)

EL_sample_rep &	get_selected_sample (void)

Mandatory Requirements
void	run (unsigned verbose=0, std::ostream &out=std::cout)
	Runs the module following the input options. More...

void	statistics (std::ostream &out)
	Reports high-level statistics on the module. More...

std::string	get_name (void) const
	Returns the name of the package. More...

Optional Requirements
boost::program_options::options_description	add_options (void) const
	! More...

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

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

void	report (const std::string &prefix)
	Reports the output and statistics in output files. More...

bool	is_runnable (void) const
	Checks that all the input options were set. More...

Modules Management
void	set_module_instance_name (const std::string &module_instance_name)
	Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules. More...

const std::string &	get_module_instance_name (void) const
	Get the name of this instance of this module. More...

void	set_report_mode (std::ios_base::openmode report_mode)
	Set a report mode, that is open or append modes. More...

void	set_report_mode (std::ios_base::openmode &report_mode)
	Set a report mode, that is open or append modes. More...

const std::ios_base::openmode	get_report_mode (void) const
	Get the report mode to be used when reporting. More...

Others
template<class Self_ >
Self_ *	clone (const Self_ *s) const
	Clones the object using the copy constructor. More...

virtual bool	is_logical_module (void) const
	Checks that this module defines a logical operator. More...

virtual bool	is_condition_module (void) const
	Checks that this module defines a condition operator. More...

virtual bool	operator() (void)
	Only for condition modules, for returning the predicate value. More...

virtual bool	is_modules_collection (void) const
	Checks that this module defines a collection of modules. More...

Detailed Description

template<class ModuleTraits>
class SBL::Modules::T_Sample_selector_module< ModuleTraits >

Module for selecting a sample to extend during the explorer algorithm.

Template Parameters

ModuleTraits Traits class defining the types Exploration_parameters, Exploration_algorithm and EL_sample_type.

Member Typedef Documentation

◆ Base

typedef SBL::Modules::Module_base Base

◆ Conformation_traits

typedef SBL::Models::T_Conformation_traits<EL_sample_type> Conformation_traits

◆ EL_sample_rep

typedef Exploration_algorithm::EL_sample_rep EL_sample_rep

◆ EL_sample_type

typedef ModuleTraits::EL_sample_type EL_sample_type

◆ Exploration_algorithm

typedef ModuleTraits::Exploration_algorithm Exploration_algorithm

◆ Exploration_parameters

typedef ModuleTraits::Exploration_parameters Exploration_parameters

◆ Sample_selector

typedef Exploration_algorithm::Sample_selector Sample_selector

◆ Self

typedef T_Sample_selector_module<ModuleTraits> Self

Constructor & Destructor Documentation

◆ T_Sample_selector_module() [1/2]

T_Sample_selector_module ( void )

inline

◆ T_Sample_selector_module() [2/2]

T_Sample_selector_module ( const Self & other )

inline

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 >.

◆ 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 >.

◆ clone()

Self_* clone ( const Self_ * s ) const

inlineinherited

Clones the object using the copy constructor.

◆ delete_options()

static void delete_options ( void )

inlinestaticinherited

◆ get_exploration_algorithm()

T_Sample_selector_module< ModuleTraits >::Exploration_algorithm *& get_exploration_algorithm ( void )

inline

◆ get_exploration_parameters()

T_Sample_selector_module< ModuleTraits >::Exploration_parameters *& get_exploration_parameters ( void )

inline

◆ get_module_instance_name()

const std::string& get_module_instance_name ( void ) const

inlineinherited

Get the name of this instance of this module.

◆ get_name()

std::string get_name ( void ) const

inlinevirtual

Returns the name of the package.

Reimplemented from Module_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_report_mode()

const std::ios_base::openmode get_report_mode ( void ) const

inlineinherited

Get the report mode to be used when reporting.

◆ get_selected_sample()

T_Sample_selector_module< ModuleTraits >::EL_sample_rep & get_selected_sample ( void )

inline

◆ has_options()

static bool has_options ( void )

inlinestaticinherited

◆ initialize_options()

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

inlinestaticinherited

◆ is_condition_module()

virtual bool is_condition_module ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a condition operator.

◆ is_logical_module()

virtual bool is_logical_module ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a logical operator.

◆ is_modules_collection()

virtual bool is_modules_collection ( void ) const

inlineprotectedvirtualinherited

Checks that this module defines a collection of modules.

◆ is_runnable()

bool is_runnable ( void ) const

inlinevirtual

Checks that all the input options were set.

Reimplemented from Module_base.

◆ operator()()

virtual bool operator() ( void )

inlineprotectedvirtualinherited

Only for condition modules, for returning the predicate value.

◆ report()

void report ( const std::string & prefix )

inlinevirtual

Reports the output and statistics in output files.

Reimplemented from Module_base.

◆ run()

void run	(	unsigned	verbose = `0`,
		std::ostream &	out = `std::cout`
	)

inlinevirtual

Runs the module following the input options.

Implements Module_base.

◆ set_module_instance_name()

void set_module_instance_name ( const std::string & module_instance_name )

inlineinherited

Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules.

◆ set_report_mode() [1/2]

void set_report_mode ( std::ios_base::openmode & report_mode )

inlineinherited

Set a report mode, that is open or append modes.

◆ set_report_mode() [2/2]

void set_report_mode ( std::ios_base::openmode report_mode )

inlineinherited

Set a report mode, that is open or append modes.

◆ set_selector()

void set_selector ( Sample_selector & selector )

inline

◆ statistics()

void statistics ( std::ostream & out )

inlinevirtual

Reports high-level statistics on the module.

Reimplemented from Module_base.

Public Types

Static Public Member Functions

Attributes

Accessors

Mandatory Requirements

Optional Requirements

Modules Management

Others

Detailed Description

template<class ModuleTraits> class SBL::Modules::T_Sample_selector_module< ModuleTraits >

Member Typedef Documentation

◆ Base

◆ Conformation_traits

◆ EL_sample_rep

◆ EL_sample_type

◆ Exploration_algorithm

◆ Exploration_parameters

◆ Sample_selector

◆ Self

Constructor & Destructor Documentation

◆ T_Sample_selector_module() [1/2]

◆ T_Sample_selector_module() [2/2]

Member Function Documentation

◆ add_options()

◆ check_options()

◆ clone()

◆ delete_options()

◆ get_exploration_algorithm()

◆ get_exploration_parameters()

◆ get_module_instance_name()

◆ get_name()

◆ get_options()

◆ get_output_prefix()

◆ get_report_mode()

◆ get_selected_sample()

◆ has_options()

◆ initialize_options()

◆ is_condition_module()

◆ is_logical_module()

◆ is_modules_collection()

◆ is_runnable()

◆ operator()()

◆ report()

◆ run()

◆ set_module_instance_name()

◆ set_report_mode() [1/2]

◆ set_report_mode() [2/2]

◆ set_selector()

◆ statistics()

template<class ModuleTraits>
class SBL::Modules::T_Sample_selector_module< ModuleTraits >