py::VertexView< Graph > Class Template Reference

Vertex view for Boost Graph Library graphs. More...

#include <nx2bgl.hpp>

Inheritance diagram for py::VertexView< Graph >:

Collaboration diagram for py::VertexView< Graph >:

Public Member Functions
	VertexView (Graph &&gra) noexcept
	Construct a new Vertex View object.
auto	begin () const
	Get iterator to the beginning of vertices.
auto	end () const
	Get iterator to the end of vertices.
auto	cbegin () const
	Get const iterator to the beginning of vertices.
auto	cend () const
	Get const iterator to the end of vertices.

Detailed Description

template<typename Graph>
class py::VertexView< Graph >

Vertex view for Boost Graph Library graphs.

Provides iterable access to vertices in a BGL graph. This class wraps a graph and provides iterator interfaces for traversing vertices.

Template Parameters

Graph

The Boost Graph Library graph type

Constructor & Destructor Documentation

VertexView()

template<typename Graph >

py::VertexView< Graph >::VertexView ( Graph &&  gra )

inlineexplicitnoexcept

Construct a new Vertex View object.

Creates a vertex view from an existing graph by moving it into this wrapper.

Parameters

[in]

gra

The graph to wrap (moved into this VertexView)

Member Function Documentation

begin()

template<typename Graph >

auto py::VertexView< Graph >::begin ( ) const

inline

Get iterator to the beginning of vertices.

Returns an iterator to the first vertex in the graph.

Returns

Iterator to the first vertex

cbegin()

template<typename Graph >

auto py::VertexView< Graph >::cbegin ( ) const

inline

Get const iterator to the beginning of vertices.

Returns a const iterator to the first vertex in the graph.

Returns

Const iterator to the first vertex

cend()

template<typename Graph >

auto py::VertexView< Graph >::cend ( ) const

inline

Get const iterator to the end of vertices.

Returns a const iterator past the last vertex in the graph.

Returns

Const iterator past the last vertex

end()

template<typename Graph >

auto py::VertexView< Graph >::end ( ) const

inline

Get iterator to the end of vertices.

Returns an iterator past the last vertex in the graph.

Returns

Iterator past the last vertex

---

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

• py2cpp/nx2bgl.hpp