STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Protected Member Functions | Protected Attributes
stapl::generators::binary_tree_network< G > Struct Template Reference

Graph generator for a binary tree network graph. More...

Public Member Functions

 binary_tree_network (size_t levels)
 
 binary_tree_network (G &g, size_t levels)
 
virtual void add_vertices ()
 Function which is called to add vertices to the graph.
 
virtual void add_edges ()
 Function which is called to add edges to the graph.
 
graph_type operator() ()
 Calls add_vertices and add_edges on the derived class. More...
 

Public Types

typedef generator_base< binary_tree_network< G > > base_type
 

Protected Member Functions

void add_vertices_top ()
 Function to add vertices for the first tree.
 
void add_vertices_bottom ()
 Function to add vertices for the second tree.
 
void add_edges_top ()
 Function to add edges for the first tree.
 
void add_edges_bottom ()
 Function to add edges for the second tree.
 
void add_edges_middle ()
 Function to add edges to link the two trees.
 
graph_type & graph ()
 
void add_vertices (VF const &vf)
 Function which is called to add vertices to the graph using the provided vertex addition functor. More...
 
void add_edges (EF const &ef)
 Function which is called to add edges to the graph using the provided edge addition functor. More...
 

Protected Attributes

size_t m_levels
 
size_t m_n
 

Detailed Description

template<typename G>
struct stapl::generators::binary_tree_network< G >

Graph generator for a binary tree network graph.

Template Parameters
GType of the graph view used to construct the graph.
See also
make_binary_tree_network

Constructor & Destructor Documentation

◆ binary_tree_network() [1/2]

template<typename G >
stapl::generators::binary_tree_network< G >::binary_tree_network ( size_t  levels)
Parameters
levelsNumber of levels in each generated tree.

◆ binary_tree_network() [2/2]

template<typename G >
stapl::generators::binary_tree_network< G >::binary_tree_network ( G &  g,
size_t  levels 
)
Parameters
gView over the graph to generate.
levelsNumber of levels in each generated tree.

Member Function Documentation

◆ add_vertices()

void stapl::generators::generator_base< binary_tree_network< G > >::add_vertices ( VF const &  vf)
protectedinherited

Function which is called to add vertices to the graph using the provided vertex addition functor.

Parameters
vfFunctor which is used to add vertices.

◆ add_edges()

void stapl::generators::generator_base< binary_tree_network< G > >::add_edges ( EF const &  ef)
protectedinherited

Function which is called to add edges to the graph using the provided edge addition functor.

Parameters
efFunctor which is used to add edges.

◆ operator()()

graph_type stapl::generators::generator_base< binary_tree_network< G > >::operator() ( void  )
inherited

Calls add_vertices and add_edges on the derived class.

Returns
A view over the generated graph.

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