fpmas 1.6
Public Member Functions | List of all members
fpmas::api::graph::GraphBuilder< T > Class Template Referenceabstract

#include <graph_builder.h>

Inheritance diagram for fpmas::api::graph::GraphBuilder< T >:
Inheritance graph
[legend]

Public Member Functions

virtual std::vector< api::graph::DistributedNode< T > * > build (NodeBuilder< T > &node_builder, LayerId layer, DistributedGraph< T > &graph)=0
 

Detailed Description

template<typename T>
class fpmas::api::graph::GraphBuilder< T >

An utility interface used to automatically generate some graphs on a single process.

Template Parameters
Tgraph datatype

Member Function Documentation

◆ build()

template<typename T >
virtual std::vector< api::graph::DistributedNode< T > * > fpmas::api::graph::GraphBuilder< T >::build ( NodeBuilder< T > &  node_builder,
LayerId  layer,
DistributedGraph< T > &  graph 
)
pure virtual

Automatically builds the specified graph according to the current implementation.

Nodes are generated using the specified NodeBuilder. More precisely, NodeBuilder::nodeCount() nodes will be inserted in the graph. Generated nodes can then be linked on the specified layer, according to rules defined by the implemented algorithm.

Notice that the specified graph is not required to be empty.

Parameters
node_builderNodeBuilder instance used to generate nodes
layerlayer on which nodes will be linked
graphgraph in which nodes and edges will be inserted
Returns
built nodes

Implemented in fpmas::graph::ClusteredGraphBuilder< T >, fpmas::graph::BipartiteGraphBuilder< T >, and fpmas::graph::UniformGraphBuilder< T >.


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