template<typename Vertex, typename Graph>
py::AtlasView class

Atlas view for vertex adjacency in Boost Graph Library graphs.

Template parameters
Vertex The vertex descriptor type
Graph The Boost Graph Library graph type

Provides iterable access to edges adjacent to a specific vertex in a BGL graph. This class holds a vertex and a reference to a graph and provides iterator interfaces for traversing edges connected to that vertex.

Constructors, destructors, conversion operators

AtlasView(Vertex v, const Graph& gra)
Construct a new Atlas View object.

Public functions

auto begin() const -> auto
Get iterator to the beginning of adjacent edges.
auto end() const -> auto
Get iterator to the end of adjacent edges.
auto cbegin() const -> auto
Get const iterator to the beginning of adjacent edges.
auto cend() const -> auto
Get const iterator to the end of adjacent edges.

Function documentation

template<typename Vertex, typename Graph>
py::AtlasView<Vertex, Graph>::AtlasView(Vertex v, const Graph& gra)

Construct a new Atlas View object.

Parameters
v in The vertex to view adjacency from
gra in Reference to the graph containing the vertex

Creates an atlas view for a specific vertex in a graph.

template<typename Vertex, typename Graph>
auto py::AtlasView<Vertex, Graph>::begin() const

Get iterator to the beginning of adjacent edges.

Returns Iterator to the first adjacent edge

Returns an iterator to the first edge adjacent to the vertex.

template<typename Vertex, typename Graph>
auto py::AtlasView<Vertex, Graph>::end() const

Get iterator to the end of adjacent edges.

Returns Iterator past the last adjacent edge

Returns an iterator past the last edge adjacent to the vertex.

template<typename Vertex, typename Graph>
auto py::AtlasView<Vertex, Graph>::cbegin() const

Get const iterator to the beginning of adjacent edges.

Returns Const iterator to the first adjacent edge

Returns a const iterator to the first edge adjacent to the vertex.

template<typename Vertex, typename Graph>
auto py::AtlasView<Vertex, Graph>::cend() const

Get const iterator to the end of adjacent edges.

Returns Const iterator past the last adjacent edge

Returns a const iterator past the last edge adjacent to the vertex.