stapl::dpg_view< Graph, VAdaptor, EAdaptor > Class Template Reference

View providing predecessor info for graphs. Specialization when the underlying view/graph is DPG.In general there are two cases; one where this view is defined over a DPG graph, in which case the view is just a wrapper; and second where the underlying graph/view is not DPG and then we have to keep extra storage to keep track of predecessors in the view separate from the graph. These two cases are implemented using different partial specializations. More...

Public Member Functions
	dpg_view (Graph &g)
	Create a dpg view over a dpg graph.
void	set_async_update (void)
	Set the graph for the lazy-update mode.
void	set_sync_update (void)
	Set the graph for the always update mode.
void	set_predecessors (void)
	When in the lazy update mode this method should be called to update all predecessors.
vertex_descriptor	add_vertex (void)
	Add a vertex with the default property. The descriptor of this is generated automatically. More...
vertex_descriptor	add_vertex (vertex_property &vp)
	Add a vertex with the specified property. The descriptor of this is generated automatically. More...
vertex_descriptor	add_vertex (vertex_descriptor vd, vertex_property &vp)
	Add a vertex with the specified descriptor and property. More...
bool	add_edge (edge_descriptor &ed)
	Adds an edge with given descriptor and default edge property. More...
void	erase (void)
	Clear this graph, deleting all its vertices and edges.
bool	delete_vertex (vertex_descriptor const &vd)
	Delete the specified vertex. More...
bool	delete_edge (edge_descriptor const &ed)
	Delete the specified edge. More...
edge_iterator	edges_begin ()
	Returns an iterator over all the edges of the graph.
const_edge_iterator	edges_begin () const
	Returns an iterator over all the edges of the graph.
edge_iterator	edges_end ()
	Returns an iterator over all the edges of the graph.
const_edge_iterator	edges_end () const
	Returns an iterator over all the edges of the graph.
size_t	get_max_descriptor () const
	Returns the maximum descriptor for the vertex.
size_t	get_num_vertices () const
	Returns the number of vertices in this graph.
size_t	get_num_edges () const
	Returns the number of edges in this graph.
vertex_iterator	find_vertex (vertex_descriptor const &vd)
	Finds the vertex with the specified descriptor, and returns a vertex_iterator pointing to it. If not found, the end of the graph is returned. More...
const_vertex_iterator	find_vertex (vertex_descriptor const &vd) const
	Finds the vertex with the specified descriptor, and returns a vertex_iterator pointing to it. If not found, the end of the graph is returned. More...
bool	find_edge (edge_descriptor const &ed, vertex_iterator &vi, adj_edge_iterator &ei)
	Finds the edge with the specified descriptor, and returns an iterator to its source vertex and an adj_edge_iterator pointing to the edge. More...
bool	find_edge (const edge_descriptor &ed, const_vertex_iterator &vi, const_adj_edge_iterator &ei) const
	Finds the edge with the specified descriptor, and returns an iterator to its source vertex and an adj_edge_iterator pointing to the edge. More...
vertex_iterator	begin ()
const_vertex_iterator	begin () const
vertex_iterator	end ()
const_vertex_iterator	end () const

Public Types
typedef base_type::vertex_descriptor	vertex_descriptor
typedef base_type::edge_descriptor	edge_descriptor
typedef base_type::vertex_iterator	vertex_iterator
typedef base_type::const_vertex_iterator	const_vertex_iterator
typedef base_type::adj_edge_iterator	adj_edge_iterator
typedef base_type::const_adj_edge_iterator	const_adj_edge_iterator
typedef base_type::edge_iterator	edge_iterator
typedef base_type::const_edge_iterator	const_edge_iterator
typedef vertex_iterator::property_type	vertex_property
typedef adj_edge_iterator::property_type	edge_property
typedef Graph::preds_iterator	preds_iterator
typedef Graph::const_preds_iterator	const_preds_iterator
typedef base_type::vertex_reference	vertex_reference
typedef const_vertex_iterator::value_type	const_vertex_reference

Protected Attributes
Graph &	m_g
VAdaptor	m_vadapt

Detailed Description

template<class Graph, class VAdaptor = use_default, class EAdaptor = use_default>
class stapl::dpg_view< Graph, VAdaptor, EAdaptor >

View providing predecessor info for graphs. Specialization when the underlying view/graph is DPG.

In general there are two cases; one where this view is defined over a DPG graph, in which case the view is just a wrapper; and second where the underlying graph/view is not DPG and then we have to keep extra storage to keep track of predecessors in the view separate from the graph. These two cases are implemented using different partial specializations.

Member Function Documentation

add_vertex() [1/3]

vertex_descriptor stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::add_vertex ( void  )

inherited

Add a vertex with the default property. The descriptor of this is generated automatically.

Returns

The descriptor for the new vertex.

add_vertex() [2/3]

vertex_descriptor stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::add_vertex ( vertex_property &  vp )

inherited

Add a vertex with the specified property. The descriptor of this is generated automatically.

Returns

The descriptor for the new vertex.

add_vertex() [3/3]

vertex_descriptor stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::add_vertex ( vertex_descriptor  vd, vertex_property &  vp  )

inherited

Add a vertex with the specified descriptor and property.

Returns

The descriptor for the new vertex.

add_edge()

bool stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::add_edge ( edge_descriptor &  ed )

inherited

Adds an edge with given descriptor and default edge property.

Parameters

ed	Descriptor of the desired edge.

Returns

True if the edge was added, or false otherwise.

delete_vertex()

bool stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::delete_vertex ( vertex_descriptor const &  vd )

inherited

Delete the specified vertex.

Parameters

vd	The vertex to be deleted.

Returns

True if vertex was deleted, or false otherwise.

delete_edge()

bool stapl::dynamic_graph_view< Graph , VAdaptor, EAdaptor >::delete_edge ( edge_descriptor const &  ed )

inherited

Delete the specified edge.

Parameters

ed	The edge to be deleted.

Returns

True if edge was deleted, or false otherwise.

find_vertex() [1/2]

vertex_iterator stapl::static_graph_view< Graph , VAdaptor, EAdaptor >::find_vertex ( vertex_descriptor const &  vd )

inherited

Finds the vertex with the specified descriptor, and returns a vertex_iterator pointing to it. If not found, the end of the graph is returned.

Parameters

vd	Descriptor of the vertex.

Returns

A vertex_iterator to the specified vertex, if found, or a vertex_iterator to the end of the graph otherwise.

find_vertex() [2/2]

const_vertex_iterator stapl::static_graph_view< Graph , VAdaptor, EAdaptor >::find_vertex ( vertex_descriptor const &  vd ) const

inherited

Finds the vertex with the specified descriptor, and returns a vertex_iterator pointing to it. If not found, the end of the graph is returned.

Parameters

vd	Descriptor of the vertex.

Returns

A vertex_iterator to the specified vertex, if found, or a vertex_iterator to the end of the graph otherwise.

find_edge() [1/2]

bool stapl::static_graph_view< Graph , VAdaptor, EAdaptor >::find_edge ( edge_descriptor const &  ed, vertex_iterator &  vi, adj_edge_iterator &  ei  )

inherited

Finds the edge with the specified descriptor, and returns an iterator to its source vertex and an adj_edge_iterator pointing to the edge.

Parameters

ed	Descriptor of the edge.
vi	vertex_iterator pointing to the source vertex of the edge, populated by the method.
aei	adj_edge_iterator pointing to the specified edge, populated by the method.

Returns

Whether or not the edge was found.

find_edge() [2/2]

bool stapl::static_graph_view< Graph , VAdaptor, EAdaptor >::find_edge ( const edge_descriptor &  ed, const_vertex_iterator &  vi, const_adj_edge_iterator &  ei  ) const

inherited

Finds the edge with the specified descriptor, and returns an iterator to its source vertex and an adj_edge_iterator pointing to the edge.

Parameters

ed	Descriptor of the edge.
vi	vertex_iterator pointing to the source vertex of the edge, populated by the method.
aei	adj_edge_iterator pointing to the specified edge, populated by the method.

Returns

Whether or not the edge was found.

---

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

• directed_preds_graph_view.h