Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Earth_mover_distance_vertices_accessor_graph< VertexType, MassType > Class Template Reference

Accessors for weighted vertices stored in a boost graph. More...

#include <Earth_mover_distance_vertices_accessor_graph.hpp>

Public Types

typedef T_Earth_mover_distance_vertices_accessor_graph< VertexType, MassType > Self
 
typedef std::pair< VertexType, MassType > Weighted_vertex
 
typedef boost::adjacency_list< boost::vecS, boost::vecS, boost::undirectedS, Weighted_vertexVertices_container
 
typedef VertexType Vertex_value
 
typedef MassType FT
 
typedef boost::graph_traits< Vertices_containerGraph_traits
 
typedef Graph_traits::vertex_descriptor Vertex_rep
 
typedef Graph_traits::vertex_iterator Vertices_iterator
 
typedef Graph_traits::adjacency_iterator Adjacent_vertices_iterator
 
typedef unsigned Index_type
 

Static Public Member Functions

static unsigned get_number_of_vertices (const Vertices_container &C)
 
static unsigned get_number_of_edges (const Vertices_container &C)
 
static Vertices_iterator vertices_begin (const Vertices_container &C)
 
static Vertices_iterator vertices_end (const Vertices_container &C)
 
static Adjacent_vertices_iterator vertices_begin (const Vertices_container &C, Vertex_rep v)
 
static Adjacent_vertices_iterator vertices_end (const Vertices_container &C, Vertex_rep v)
 
static bool are_adjacent (const Vertices_container &C, Vertex_rep u, Vertex_rep v)
 
static Index_type get_index (const Vertices_container &C, Vertex_rep v)
 
static Vertex_rep get_rep (const Vertices_container &C, Index_type i)
 
static const Vertex_valueget_value (const Vertices_container &C, Vertex_rep v)
 
static void set_mass (Vertices_container &C, Vertex_rep v, const FT &mass)
 
static const FTget_mass (const Vertices_container &C, Vertex_rep v)
 

Detailed Description

template<class VertexType, class MassType>
class SBL::CADS::T_Earth_mover_distance_vertices_accessor_graph< VertexType, MassType >

Accessors for weighted vertices stored in a boost graph.

Accessors for weighted vertices stored in a boost graph.

Template Parameters
VertexTypeRepresentation of a vertex in the algorithm (e.g a 2D point in a geometrical case)
MassTypeRepresentation of the number type used for the weight of the vertex.

Member Typedef Documentation

◆ Adjacent_vertices_iterator

typedef Graph_traits::adjacency_iterator Adjacent_vertices_iterator

◆ FT

typedef MassType FT

◆ Graph_traits

typedef boost::graph_traits<Vertices_container> Graph_traits

◆ Index_type

typedef unsigned Index_type

◆ Self

◆ Vertex_rep

typedef Graph_traits::vertex_descriptor Vertex_rep

◆ Vertex_value

typedef VertexType Vertex_value

◆ Vertices_container

typedef boost::adjacency_list<boost::vecS, boost::vecS, boost::undirectedS, Weighted_vertex> Vertices_container

◆ Vertices_iterator

typedef Graph_traits::vertex_iterator Vertices_iterator

◆ Weighted_vertex

typedef std::pair<VertexType, MassType> Weighted_vertex

Member Function Documentation

◆ are_adjacent()

static bool are_adjacent ( const Vertices_container C,
Vertex_rep  u,
Vertex_rep  v 
)
inlinestatic

◆ get_index()

static Index_type get_index ( const Vertices_container C,
Vertex_rep  v 
)
inlinestatic

◆ get_mass()

static const FT& get_mass ( const Vertices_container C,
Vertex_rep  v 
)
inlinestatic

◆ get_number_of_edges()

static unsigned get_number_of_edges ( const Vertices_container C)
inlinestatic

◆ get_number_of_vertices()

static unsigned get_number_of_vertices ( const Vertices_container C)
inlinestatic

◆ get_rep()

static Vertex_rep get_rep ( const Vertices_container C,
Index_type  i 
)
inlinestatic

◆ get_value()

static const Vertex_value& get_value ( const Vertices_container C,
Vertex_rep  v 
)
inlinestatic

◆ set_mass()

static void set_mass ( Vertices_container C,
Vertex_rep  v,
const FT mass 
)
inlinestatic

◆ vertices_begin() [1/2]

static Vertices_iterator vertices_begin ( const Vertices_container C)
inlinestatic

◆ vertices_begin() [2/2]

static Adjacent_vertices_iterator vertices_begin ( const Vertices_container C,
Vertex_rep  v 
)
inlinestatic

◆ vertices_end() [1/2]

static Vertices_iterator vertices_end ( const Vertices_container C)
inlinestatic

◆ vertices_end() [2/2]

static Adjacent_vertices_iterator vertices_end ( const Vertices_container C,
Vertex_rep  v 
)
inlinestatic