Generic manager for reading arguments of the program and run the calculations. More...

#include <Nearest_neighbors_graph_builder_module.hpp>

Classes
class	Distance

Public Types
typedef T_Nearest_neighbors_graph_builder_module< ModuleTraits >	Self

typedef SBL::Modules::Module_base	Base

typedef ModuleTraits::Nearest_neighbors_graph	Nearest_neighbors_graph

typedef ModuleTraits::Nearest_neighbors_distance	Nearest_neighbors_distance

typedef Nearest_neighbors_distance::Point	Point

typedef Nearest_neighbors_distance::FT	FT

typedef std::vector< Point >	Points_vector

typedef ModuleTraits::template Nearest_neighbors_query< Distance >	Nearest_neighbors_query

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)

Constructors / Destructors
	T_Nearest_neighbors_graph_builder_module (void)

	T_Nearest_neighbors_graph_builder_module (const Self &other)

	~T_Nearest_neighbors_graph_builder_module (void)

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

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

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

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

void	run (unsigned verbose, std::ostream &out)
	run the model following the input options. More...

void	reset (void)

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

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

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

Access
Points_vector *&	get_points (void)

Nearest_neighbors_graph &	get_nearest_neighbors_graph (void)

const Nearest_neighbors_graph &	get_nearest_neighbors_graph (void) const

Nearest_neighbors_query &	get_nearest_neighbors_query (void)

const Nearest_neighbors_query &	get_nearest_neighbors_query (void) const

bool	is_nng_connected (void) const

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

Optional Requirements
void	check_filesystem_directory_exists (const std::string &output_prefix)
	To avoid later crash: check filesystem / existence of directory / directory exists. 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_Nearest_neighbors_graph_builder_module< ModuleTraits >

Generic manager for reading arguments of the program and run the calculations.

Template Parameters

ModuleTraits	Model of a traits class defining the types used in the manager (see T_Conformational_clustering_traits).
ModuleInput	should define points_begin and points_end

Member Typedef Documentation

◆ Base

typedef SBL::Modules::Module_base Base

◆ FT

typedef Nearest_neighbors_distance::FT FT

◆ Nearest_neighbors_distance

typedef ModuleTraits::Nearest_neighbors_distance Nearest_neighbors_distance

◆ Nearest_neighbors_graph

typedef ModuleTraits::Nearest_neighbors_graph Nearest_neighbors_graph

◆ Nearest_neighbors_query

typedef ModuleTraits::template Nearest_neighbors_query<Distance> Nearest_neighbors_query

◆ Point

typedef Nearest_neighbors_distance::Point Point

◆ Points_vector

typedef std::vector<Point> Points_vector

◆ Self

typedef T_Nearest_neighbors_graph_builder_module<ModuleTraits> Self

Constructor & Destructor Documentation

◆ T_Nearest_neighbors_graph_builder_module() [1/2]

T_Nearest_neighbors_graph_builder_module ( void )

inline

◆ T_Nearest_neighbors_graph_builder_module() [2/2]

T_Nearest_neighbors_graph_builder_module ( const Self & other )

inline

◆ ~T_Nearest_neighbors_graph_builder_module()

~T_Nearest_neighbors_graph_builder_module ( void )

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_filesystem_directory_exists()

void check_filesystem_directory_exists ( const std::string & output_prefix )

inlineinherited

To avoid later crash: check filesystem / existence of directory / directory exists.

◆ check_options()

bool check_options ( std::string & message ) const

inlinevirtual

Check 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_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_nearest_neighbors_graph() [1/2]

T_Nearest_neighbors_graph_builder_module< ModuleTraits >::Nearest_neighbors_graph & get_nearest_neighbors_graph ( void )

inline

◆ get_nearest_neighbors_graph() [2/2]

const T_Nearest_neighbors_graph_builder_module< ModuleTraits >::Nearest_neighbors_graph & get_nearest_neighbors_graph ( void ) const

inline

◆ get_nearest_neighbors_query() [1/2]

T_Nearest_neighbors_graph_builder_module< ModuleTraits >::Nearest_neighbors_query & get_nearest_neighbors_query ( void )

inline

◆ get_nearest_neighbors_query() [2/2]

const T_Nearest_neighbors_graph_builder_module< ModuleTraits >::Nearest_neighbors_query & get_nearest_neighbors_query ( void ) const

inline

◆ 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_points()

T_Nearest_neighbors_graph_builder_module< ModuleTraits >::Points_vector *& get_points ( void )

inline

◆ get_report_mode()

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

inlineinherited

Get the report mode to be used when reporting.

◆ 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_nng_connected()

bool is_nng_connected ( void ) const

inline

◆ 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

Report the output and statistics in output files.

Reimplemented from Module_base.

◆ reset()

void reset ( void )

inline

◆ run()

void run	(	unsigned	verbose,
		std::ostream &	out
	)

inlinevirtual

run the model 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.

◆ statistics()

void statistics ( std::ostream & out )

inlinevirtual

Report high-level statistics on the module.

Reimplemented from Module_base.

Classes

Public Types

Static Public Member Functions

Constructors / Destructors

Requirements

Access

Modules Management

Optional Requirements

Others

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ FT

◆ Nearest_neighbors_distance

◆ Nearest_neighbors_graph

◆ Nearest_neighbors_query

◆ Point

◆ Points_vector

◆ Self

Constructor & Destructor Documentation

◆ T_Nearest_neighbors_graph_builder_module() [1/2]

◆ T_Nearest_neighbors_graph_builder_module() [2/2]

◆ ~T_Nearest_neighbors_graph_builder_module()

Member Function Documentation

◆ add_options()

◆ check_filesystem_directory_exists()

◆ check_options()

◆ clone()

◆ delete_options()

◆ get_module_instance_name()

◆ get_name()

◆ get_nearest_neighbors_graph() [1/2]

◆ get_nearest_neighbors_graph() [2/2]

◆ get_nearest_neighbors_query() [1/2]

◆ get_nearest_neighbors_query() [2/2]

◆ get_options()

◆ get_output_prefix()

◆ get_points()

◆ get_report_mode()

◆ has_options()

◆ initialize_options()

◆ is_condition_module()

◆ is_logical_module()

◆ is_modules_collection()

◆ is_nng_connected()

◆ is_runnable()

◆ operator()()

◆ report()

◆ reset()

◆ run()

◆ set_module_instance_name()

◆ set_report_mode() [1/2]

◆ set_report_mode() [2/2]

◆ statistics()

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