GraphIterators

Collaboration diagram for GraphIterators:

Namespaces
namespace	Utopia::GraphUtils

Enumerations
enum class	Utopia::IterateOver {   Utopia::IterateOver::vertices , Utopia::IterateOver::edges , Utopia::IterateOver::neighbors , Utopia::IterateOver::inv_neighbors ,   Utopia::IterateOver::in_edges , Utopia::IterateOver::out_edges }
	Over which graph entity to iterate. More...

Functions
template<IterateOver iterate_over, typename Graph >
decltype(auto)	Utopia::range (const Graph &g)
	Get the iterator range over selected graph entities.
template<IterateOver iterate_over, typename Graph , typename EntityDesc >
decltype(auto)	Utopia::range (EntityDesc e, const Graph &g)
	Get the iterator range over selected graph entities.

Detailed Description

Enumeration Type Documentation

IterateOver

enum class Utopia::IterateOver

strong

Over which graph entity to iterate.

Enumerator
vertices	Iterate over vertices.
edges	Iterate over edges.
neighbors	Iterate over neighbors (adjacent_vertices). This iteration requires a vertex descriptor whose neighbors to iterate over.
inv_neighbors	Iterate inversely over neighbors (adjacent_vertices). This iteration requires a vertex descriptor whose neighbors to iterate over.
in_edges	Iterate over the in edges of a vertex. This iteration requires a vertex descriptor whose neighbors to iterate over.
out_edges	Iterate over the out edges of a vertex. This iteration requires a vertex descriptor whose neighbors to iterate over.

                       {
    vertices,
 
    edges,
 
 
    neighbors,
 
 
    inv_neighbors,
 
 
    in_edges,
 
 
    out_edges
};

Function Documentation

range() [1/2]

template<IterateOver iterate_over, typename Graph >

decltype(auto) Utopia::range

(

const Graph &

g

)

Get the iterator range over selected graph entities.

Template Parameters

iterate_over	Specify over which graph entities to iterate over Valid options: IterateOver::vertices IterateOver::edges
Graph	The graph type

Parameters

g

The graph

Returns

decltype(auto) The iterator range

                                    {
    return boost::make_iterator_range(
                GraphUtils::iterator_pair<iterate_over>(g));
}

range() [2/2]

template<IterateOver iterate_over, typename Graph , typename EntityDesc >

decltype(auto) Utopia::range	(	EntityDesc	e,
		const Graph &	g
	)

Get the iterator range over selected graph entities.

This function returns the iterator range wrt. another graph entity. For example iterating of the neighbors (adjacent_vertices) of a vertex requires a vertex descriptor as reference.

Template Parameters

iterate_over	Specify over which graph entities to iterate over Valid options: IterateOver::neighbors IterateOver::inv_neighbors IterateOver::in_edges IterateOver::out_egdes
Graph	The graph type
EntityDesc	The graph entity descriptor that is the reference point for the iteration.

Parameters

e	The graph entity that serves as reference
g	The graph

Returns

decltype(auto) The iterator range

                                                  {
    return boost::make_iterator_range(
                GraphUtils::iterator_pair<iterate_over>(e, g));
}