py::AtlasView< Vertex, Graph > Class Template Reference

Atlas view for vertex adjacency in Boost Graph Library graphs. More...

#include <nx2bgl.hpp>

Public Member Functions
	AtlasView (Vertex v, const Graph &gra)
	Construct a new Atlas View object.
auto	begin () const
	Get iterator to the beginning of adjacent edges.
auto	end () const
	Get iterator to the end of adjacent edges.
auto	cbegin () const
	Get const iterator to the beginning of adjacent edges.
auto	cend () const
	Get const iterator to the end of adjacent edges.

Detailed Description

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

Atlas view for vertex adjacency in Boost Graph Library graphs.

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.

Template Parameters

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

Constructor & Destructor Documentation

AtlasView()

template<typename Vertex , typename Graph >

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

inline

Construct a new Atlas View object.

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

Parameters

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

Member Function Documentation

begin()

template<typename Vertex , typename Graph >

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

inline

Get iterator to the beginning of adjacent edges.

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

Returns

Iterator to the first adjacent edge

cbegin()

template<typename Vertex , typename Graph >

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

inline

Get const iterator to the beginning of adjacent edges.

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

Returns

Const iterator to the first adjacent edge

cend()

template<typename Vertex , typename Graph >

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

inline

Get const iterator to the end of adjacent edges.

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

Returns

Const iterator past the last adjacent edge

end()

template<typename Vertex , typename Graph >

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

inline

Get iterator to the end of adjacent edges.

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

Returns

Iterator past the last adjacent edge

---

The documentation for this class was generated from the following file:

• py2cpp/nx2bgl.hpp