T_Clustering_loader< Graph, Clustering > Class Template Reference

#include <Clustering_loader_with_graph.hpp>

Public Types
typedef T_Clustering_loader< Clustering >	Self
typedef SBL::IO::Loader_base	Base
typedef Clustering::value_type	Cluster
typedef T_Clustering_loader< Graph, Clustering >	Self
typedef SBL::IO::Loader_base	Base
typedef Clustering::value_type	Cluster
typedef boost::graph_traits< Graph >::vertex_descriptor	Graph_vertex
typedef std::vector< Graph_vertex >	Graph_part

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_Clustering_loader (void)
	T_Clustering_loader (const Self &other)
	T_Clustering_loader (void)
	T_Clustering_loader (const Self &other)

Mandatory Requirements
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_output_prefix (void) const
	Returns a prefix that concatains the input line options used when running the module. More...
std::string	get_name (void) const
	Return the name of the class itself. More...
Clustering &	get_clustering (unsigned index)
bool	build ()
bool	read_one_clustering_per_file ()
void	read_clustering_from_file (std::string filename, Clustering &c)
bool	read_two_clusterings_one_file ()
void	statistics (std::ostream &out)
	Print high level statistics on the loaded files. More...
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_output_prefix (void) const
	Returns a prefix that concatains the input line options used when running the module. More...
std::string	get_name (void) const
	Return the name of the class itself. More...
void	statistics (std::ostream &out)
	Print high level statistics on the loaded files. More...
Clustering &	get_clustering (unsigned index)
Graph *	get_graph ()
void	add_file_name (const std::string &file_name)
bool	build ()
bool	read_one_clustering_per_file ()
void	read_clustering_from_file (std::string filename, Clustering &c)
bool	read_two_clusterings_one_file ()
void	build_graph (Clustering &clustering_one, Clustering &clustering_two)
unsigned	get_weight (const Cluster *struct_one, const Cluster *struct_two) const

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

Member Typedef Documentation

Base [1/2]

typedef SBL::IO::Loader_base Base

Base [2/2]

typedef SBL::IO::Loader_base Base

Cluster [1/2]

typedef Clustering::value_type Cluster

Cluster [2/2]

typedef Clustering::value_type Cluster

Graph_part

typedef std::vector<Graph_vertex> Graph_part

Graph_vertex

typedef boost::graph_traits<Graph>::vertex_descriptor Graph_vertex

Self [1/2]

typedef T_Clustering_loader<Clustering> Self

Self [2/2]

typedef T_Clustering_loader<Graph, Clustering> Self

Constructor & Destructor Documentation

T_Clustering_loader() [1/4]

T_Clustering_loader

(

void

)

T_Clustering_loader() [2/4]

T_Clustering_loader

(

const Self &

other

)

T_Clustering_loader() [3/4]

T_Clustering_loader

(

void

)

T_Clustering_loader() [4/4]

T_Clustering_loader

(

const Self &

other

)

Member Function Documentation

add_file_name()

void add_file_name ( const std::string &  file_name )

inline

add_options() [1/2]

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

add_options() [2/2]

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

build() [1/2]

bool build

inline

build() [2/2]

bool build ( )

inline

build_graph()

void build_graph ( Clustering &  clustering_one, Clustering &  clustering_two  )

inline

check_options() [1/2]

bool check_options ( std::string &  message ) const

inlinevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

check_options() [2/2]

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_clustering() [1/2]

Clustering& get_clustering ( unsigned  index )

inline

get_clustering() [2/2]

Clustering& get_clustering ( unsigned  index )

inline

get_graph()

Graph* get_graph ( )

inline

get_loader_instance_name()

const std::string& get_loader_instance_name ( void  ) const

inlineinherited

get_name() [1/2]

std::string get_name ( void  ) const

inlinevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_name() [2/2]

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

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_output_prefix() [2/2]

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

unsigned get_weight ( const Cluster *  struct_one, const Cluster *  struct_two  ) const

inline

has_options()

static bool has_options ( void  )

inlinestaticinherited

initialize_options()

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

inlinestaticinherited

load() [1/2]

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

inlinevirtual

Loads the data.

Reimplemented from Loader_base.

load() [2/2]

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

inlinevirtual

Loads the data.

Reimplemented from Loader_base.

read_clustering_from_file() [1/2]

void read_clustering_from_file ( std::string  filename, Clustering &  c  )

inline

read_clustering_from_file() [2/2]

void read_clustering_from_file ( std::string  filename, Clustering &  c  )

inline

read_one_clustering_per_file() [1/2]

bool read_one_clustering_per_file

inline

read_one_clustering_per_file() [2/2]

bool read_one_clustering_per_file ( )

inline

read_two_clusterings_one_file() [1/2]

bool read_two_clusterings_one_file

inline

read_two_clusterings_one_file() [2/2]

bool read_two_clusterings_one_file ( )

inline

set_loader_instance_name()

void set_loader_instance_name ( const std::string &  loader_instance_name )

inlineinherited

statistics() [1/2]

void statistics ( std::ostream &  out )

inline

Print high level statistics on the loaded files.

statistics() [2/2]

void statistics ( std::ostream &  out )

inline

Print high level statistics on the loaded files.