MeVisLab Toolbox Reference
boost Namespace Reference

Forward declaration for the boost::mutex class. More...

Classes

struct  graph_traits< ml_graph_ptr >
 Definition of traits for ml::Graph class. More...
 
struct  graph_traits< ml_undirected_graph_ptr >
 Definition of traits for ml::Graph class. More...
 
class  ml_edge_weight_map
 
struct  ml_graph_traversal_tag
 This describes the ways in which the vertices and edges of the graph can be visited. More...
 
class  ml_iterator_map
 This is a helper template to create an external property map for an std random access container. More...
 
class  ml_ug_edge
 Simple wrapper to store an ml::VesselEdge together with a ml::VesselNode, so that the source() function and the out_edge_iterator will always be able to return an edge which points away from a vertex. More...
 
class  ml_ug_edge_weight_map
 
class  ml_ug_vertex_id_map
 Vertex id Maps each vertex to a unique id. More...
 
struct  ml_undirected_graph_traversal_tag
 This describes the ways in which the vertices and edges of the graph can be visited. More...
 
class  ml_vertex_id_map
 Vertex id Maps each vertex to a unique id. More...
 
struct  property_map< ml_graph_ptr, edge_weight_t >
 
struct  property_map< ml_graph_ptr, vertex_index_t >
 
struct  property_map< ml_undirected_graph_ptr, edge_weight_t >
 
struct  property_map< ml_undirected_graph_ptr, vertex_index_t >
 

Functions

boost::graph_traits< ml_graph_ptr >::vertex_descriptor source (graph_traits< ml_graph_ptr >::edge_descriptor e, const ml_graph_ptr)
 Returns the vertex descriptor for u of the edge (u,v) represented by e.
 
boost::graph_traits< ml_graph_ptr >::vertex_descriptor target (graph_traits< ml_graph_ptr >::edge_descriptor e, const ml_graph_ptr)
 Returns the vertex descriptor for v of the edge (u,v) represented by e.
 
std::pair< boost::graph_traits< ml_graph_ptr >::out_edge_iterator, boost::graph_traits< ml_graph_ptr >::out_edge_iterator > out_edges (boost::graph_traits< ml_graph_ptr >::vertex_descriptor vertex, const ml_graph_ptr)
 Returns an iterator-range providing access to the out-edges (for directed graphs) or incident edges (for undirected graphs) of vertex u in graph g.
 
boost::graph_traits< ml_graph_ptr >::degree_size_type out_degree (boost::graph_traits< ml_graph_ptr >::vertex_descriptor vertex, const ml_graph_ptr)
 Returns the number of out-edges (for directed graphs) or the number of incident edges (for undirected graphs) of vertex u in graph g.
 
std::pair< boost::graph_traits< ml_graph_ptr >::vertex_iterator, boost::graph_traits< ml_graph_ptr >::vertex_iterator > vertices (ml_graph_ptr g)
 Returns an iterator-range providing access to all the vertices in the graph g.
 
boost::graph_traits< ml_graph_ptr >::vertices_size_type num_vertices (const ml_graph_ptr g)
 Returns the number of vertices in the graph g.
 
boost::graph_traits< ml_graph_ptr >::vertex_descriptor vertex (boost::graph_traits< ml_graph_ptr >::degree_size_type arrayIndex, const ml_graph_ptr g)
 Returns the vertex at internal index.
 
ml_vertex_id_map get (vertex_index_t, ml_graph_ptr g)
 get() function for vertex id property map vertex_index_t just necessary for overloading
 
ml_edge_weight_map get (edge_weight_t, ml_graph_ptr)
 
template<class IteratorTraits , class IDMap >
IteratorTraits::value_type get (const ml_iterator_map< IteratorTraits, IDMap > &i, typename property_traits< IDMap >::key_type key)
 
template<class IteratorTraits , class IDMap >
void put (const ml_iterator_map< IteratorTraits, IDMap > &i, typename property_traits< IDMap >::key_type key, const typename IteratorTraits::value_type &value)
 
template<class IteratorTraits , class IDMap >
IteratorTraits::value_type & at (const ml_iterator_map< IteratorTraits, IDMap > &i, typename property_traits< IDMap >::key_type key)
 
boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor source (graph_traits< ml_undirected_graph_ptr >::edge_descriptor e, const ml_undirected_graph_ptr)
 Returns the vertex descriptor for u of the edge (u,v) represented by e.
 
boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor target (graph_traits< ml_undirected_graph_ptr >::edge_descriptor e, const ml_undirected_graph_ptr)
 Returns the vertex descriptor for v of the edge (u,v) represented by e.
 
std::pair< boost::graph_traits< ml_undirected_graph_ptr >::out_edge_iterator, boost::graph_traits< ml_undirected_graph_ptr >::out_edge_iterator > out_edges (boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor vertex, const ml_undirected_graph_ptr)
 Returns an iterator-range providing access to the out-edges (for directed graphs) or incident edges (for undirected graphs) of vertex u in graph g.
 
boost::graph_traits< ml_undirected_graph_ptr >::degree_size_type out_degree (boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor vertex, const ml_undirected_graph_ptr)
 Returns the number of out-edges (for directed graphs) or the number of incident edges (for undirected graphs) of vertex u in graph g.
 
std::pair< boost::graph_traits< ml_undirected_graph_ptr >::vertex_iterator, boost::graph_traits< ml_undirected_graph_ptr >::vertex_iterator > vertices (ml_undirected_graph_ptr g)
 Returns an iterator-range providing access to all the vertices in the graph g.
 
boost::graph_traits< ml_undirected_graph_ptr >::vertices_size_type num_vertices (const ml_undirected_graph_ptr g)
 Returns the number of vertices in the graph g.
 
boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor vertex (boost::graph_traits< ml_undirected_graph_ptr >::degree_size_type arrayIndex, const ml_undirected_graph_ptr g)
 Returns the vertex at internal index.
 
ml_ug_vertex_id_map get (vertex_index_t, ml_undirected_graph_ptr g)
 get() function for vertex id property map vertex_index_t just necessary for overloading
 
ml_ug_edge_weight_map get (edge_weight_t, ml_undirected_graph_ptr)
 

Detailed Description

Forward declaration for the boost::mutex class.

Function Documentation

◆ at()

IteratorTraits::value_type & boost::at ( const ml_iterator_map< IteratorTraits, IDMap > & i,
typename property_traits< IDMap >::key_type key )

Definition at line 422 of file mlGraphToBoostGraph.h.

References mlrange_cast().

◆ get() [1/5]

IteratorTraits::value_type boost::get ( const ml_iterator_map< IteratorTraits, IDMap > & i,
typename property_traits< IDMap >::key_type key )

Definition at line 405 of file mlGraphToBoostGraph.h.

References mlrange_cast().

◆ get() [2/5]

ml_edge_weight_map boost::get ( edge_weight_t ,
ml_graph_ptr  )
inline

Definition at line 331 of file mlGraphToBoostGraph.h.

◆ get() [3/5]

◆ get() [4/5]

ml_vertex_id_map boost::get ( vertex_index_t ,
ml_graph_ptr g )
inline

get() function for vertex id property map vertex_index_t just necessary for overloading

Definition at line 298 of file mlGraphToBoostGraph.h.

◆ get() [5/5]

get() function for vertex id property map vertex_index_t just necessary for overloading

Definition at line 337 of file mlGraphToBoostUndirectedGraph.h.

◆ num_vertices() [1/2]

boost::graph_traits< ml_graph_ptr >::vertices_size_type boost::num_vertices ( const ml_graph_ptr g)
inline

Returns the number of vertices in the graph g.

Definition at line 256 of file mlGraphToBoostGraph.h.

◆ num_vertices() [2/2]

boost::graph_traits< ml_undirected_graph_ptr >::vertices_size_type boost::num_vertices ( const ml_undirected_graph_ptr g)
inline

Returns the number of vertices in the graph g.

Definition at line 294 of file mlGraphToBoostUndirectedGraph.h.

◆ out_degree() [1/2]

boost::graph_traits< ml_graph_ptr >::degree_size_type boost::out_degree ( boost::graph_traits< ml_graph_ptr >::vertex_descriptor vertex,
const ml_graph_ptr  )
inline

Returns the number of out-edges (for directed graphs) or the number of incident edges (for undirected graphs) of vertex u in graph g.

Return type: degree_size_type

Definition at line 223 of file mlGraphToBoostGraph.h.

References mlrange_cast(), and vertex().

◆ out_degree() [2/2]

boost::graph_traits< ml_undirected_graph_ptr >::degree_size_type boost::out_degree ( boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor vertex,
const ml_undirected_graph_ptr  )
inline

Returns the number of out-edges (for directed graphs) or the number of incident edges (for undirected graphs) of vertex u in graph g.

Return type: degree_size_type

Definition at line 274 of file mlGraphToBoostUndirectedGraph.h.

References vertex().

◆ out_edges() [1/2]

std::pair< boost::graph_traits< ml_graph_ptr >::out_edge_iterator, boost::graph_traits< ml_graph_ptr >::out_edge_iterator > boost::out_edges ( boost::graph_traits< ml_graph_ptr >::vertex_descriptor vertex,
const ml_graph_ptr  )
inline

Returns an iterator-range providing access to the out-edges (for directed graphs) or incident edges (for undirected graphs) of vertex u in graph g.

The source vertex of an edge obtained via an out edge iterator is guaranteed (for both directed and undirected graphs) to be the vertex u used in the call to out_edges(u, g) and the target vertex must the a vertex adjacent to u. For undirected graphs, the edge (u,v) is the same as edge (v,u), so without some extra guarantee an implementation would be free use any ordering for the pair of vertices in an out-edge. For example, if you call out_edges(u, g), and v is one of the vertices adjacent to u, then the implementation would be free to return (v,u) as an out-edge which would be non-intuitive and cause trouble for algorithms. Therefore, the extra requirement is added that the out-edge connecting u and v must be given as (u,v) and not (v,u). Return type: std::pair<out_edge_iterator, out_edge_iterator>

Definition at line 210 of file mlGraphToBoostGraph.h.

References vertex().

◆ out_edges() [2/2]

std::pair< boost::graph_traits< ml_undirected_graph_ptr >::out_edge_iterator, boost::graph_traits< ml_undirected_graph_ptr >::out_edge_iterator > boost::out_edges ( boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor vertex,
const ml_undirected_graph_ptr  )
inline

Returns an iterator-range providing access to the out-edges (for directed graphs) or incident edges (for undirected graphs) of vertex u in graph g.

The source vertex of an edge obtained via an out edge iterator is guaranteed (for both directed and undirected graphs) to be the vertex u used in the call to out_edges(u, g) and the target vertex must a vertex adjacent to u. For undirected graphs, the edge (u,v) is the same as edge (v,u), so without some extra guarantee an implementation would be free use any ordering for the pair of vertices in an out-edge. For example, if you call out_edges(u, g), and v is one of the vertices adjacent to u, then the implementation would be free to return (v,u) as an out-edge which would be non-intuitive and cause trouble for algorithms. Therefore, the extra requirement is added that the out-edge connecting u and v must be given as (u,v) and not (v,u). Return type: std::pair<out_edge_iterator, out_edge_iterator>

Definition at line 261 of file mlGraphToBoostUndirectedGraph.h.

References vertex().

◆ put()

void boost::put ( const ml_iterator_map< IteratorTraits, IDMap > & i,
typename property_traits< IDMap >::key_type key,
const typename IteratorTraits::value_type & value )

Definition at line 412 of file mlGraphToBoostGraph.h.

References mlrange_cast().

◆ source() [1/2]

boost::graph_traits< ml_graph_ptr >::vertex_descriptor boost::source ( graph_traits< ml_graph_ptr >::edge_descriptor e,
const ml_graph_ptr  )
inline

Returns the vertex descriptor for u of the edge (u,v) represented by e.

Definition at line 182 of file mlGraphToBoostGraph.h.

◆ source() [2/2]

boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor boost::source ( graph_traits< ml_undirected_graph_ptr >::edge_descriptor e,
const ml_undirected_graph_ptr  )
inline

Returns the vertex descriptor for u of the edge (u,v) represented by e.

Definition at line 233 of file mlGraphToBoostUndirectedGraph.h.

◆ target() [1/2]

boost::graph_traits< ml_graph_ptr >::vertex_descriptor boost::target ( graph_traits< ml_graph_ptr >::edge_descriptor e,
const ml_graph_ptr  )
inline

Returns the vertex descriptor for v of the edge (u,v) represented by e.

Definition at line 190 of file mlGraphToBoostGraph.h.

◆ target() [2/2]

boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor boost::target ( graph_traits< ml_undirected_graph_ptr >::edge_descriptor e,
const ml_undirected_graph_ptr  )
inline

Returns the vertex descriptor for v of the edge (u,v) represented by e.

Definition at line 241 of file mlGraphToBoostUndirectedGraph.h.

◆ vertex() [1/2]

boost::graph_traits< ml_graph_ptr >::vertex_descriptor boost::vertex ( boost::graph_traits< ml_graph_ptr >::degree_size_type arrayIndex,
const ml_graph_ptr g )
inline

Returns the vertex at internal index.

Definition at line 264 of file mlGraphToBoostGraph.h.

References mlrange_cast().

Referenced by boost::ml_vertex_id_map::operator[](), boost::ml_ug_vertex_id_map::operator[](), out_degree(), out_degree(), out_edges(), and out_edges().

◆ vertex() [2/2]

boost::graph_traits< ml_undirected_graph_ptr >::vertex_descriptor boost::vertex ( boost::graph_traits< ml_undirected_graph_ptr >::degree_size_type arrayIndex,
const ml_undirected_graph_ptr g )
inline

Returns the vertex at internal index.

Definition at line 302 of file mlGraphToBoostUndirectedGraph.h.

References mlrange_cast().

◆ vertices() [1/2]

std::pair< boost::graph_traits< ml_graph_ptr >::vertex_iterator, boost::graph_traits< ml_graph_ptr >::vertex_iterator > boost::vertices ( ml_graph_ptr g)
inline

Returns an iterator-range providing access to all the vertices in the graph g.

Definition at line 248 of file mlGraphToBoostGraph.h.

◆ vertices() [2/2]

std::pair< boost::graph_traits< ml_undirected_graph_ptr >::vertex_iterator, boost::graph_traits< ml_undirected_graph_ptr >::vertex_iterator > boost::vertices ( ml_undirected_graph_ptr g)
inline

Returns an iterator-range providing access to all the vertices in the graph g.

Definition at line 286 of file mlGraphToBoostUndirectedGraph.h.