PandA-2024.02
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
ugraph Struct Reference

General class used to describe a graph in PandA. More...

#include <graph.hpp>

Inheritance diagram for ugraph:
Inheritance graph
[legend]
Collaboration diagram for ugraph:
Collaboration graph
[legend]

Public Member Functions

 ~ugraph ()=default
 Destructor. More...
 
bool is_in_subset (const boost::graph_traits< ugraph >::vertex_descriptor v) const
 return true in case the vertex is a vertex of the subgraph. More...
 
int GetSelector () const
 Return the selector of this graph. More...
 
int GetSelector (const edge_descriptor e) const
 Return the selectors associated with an edge. More...
 
graph constructors
 ugraph (undirected_graphs_collection *g, const int _selector)
 Standard constructor. More...
 
 ugraph (undirected_graphs_collection *g, const int _selector, const CustomUnorderedSet< boost::graph_traits< undirected_boost_graphs_collection >::vertex_descriptor > &vertices)
 Sub-graph constructor. More...
 

Protected Member Functions

template<typename UVertexWriterTemplate , typename UEdgeWriterTemplate >
void InternalWriteDot (const std::string &file_name, const UVertexWriterConstRef uvertex_writer, const UEdgeWriterConstRef uedge_writer) const
 Print the graph in dot format. More...
 

Protected Attributes

undirected_graphs_collectioncollection
 The graph collection. More...
 
const int selector
 selector More...
 

Friends

boost::graph_traits< ugraph >::vertex_descriptor VERTEX (const boost::graph_traits< ugraph >::vertices_size_type, const ugraph &)
 this function can access the bulk graph More...
 

Detailed Description

General class used to describe a graph in PandA.

Definition at line 1159 of file graph.hpp.

Constructor & Destructor Documentation

◆ ugraph() [1/2]

ugraph::ugraph ( undirected_graphs_collection g,
const int  _selector 
)
inline

Standard constructor.

Parameters
gis the bulk graph.
_selectoris the selector used to filter the bulk graph.

Definition at line 1193 of file graph.hpp.

◆ ugraph() [2/2]

ugraph::ugraph ( undirected_graphs_collection g,
const int  _selector,
const CustomUnorderedSet< boost::graph_traits< undirected_boost_graphs_collection >::vertex_descriptor > &  vertices 
)
inline

Sub-graph constructor.

Parameters
gis the bulk graph.
_selectoris the selector used to filter the bulk graph.
verticesis the set of vertexes on which the graph is filtered.

Definition at line 1209 of file graph.hpp.

References VERTEX().

Here is the call graph for this function:

◆ ~ugraph()

ugraph::~ugraph ( )
default

Destructor.

Member Function Documentation

◆ GetSelector() [1/2]

int ugraph::GetSelector ( ) const
inline

Return the selector of this graph.

Returns
the selector of the graph

Definition at line 1242 of file graph.hpp.

◆ GetSelector() [2/2]

int ugraph::GetSelector ( const edge_descriptor  e) const
inline

Return the selectors associated with an edge.

Parameters
eis the edge
Returns
the associated selector

Definition at line 1252 of file graph.hpp.

References undirected_graphs_collection::GetSelector(), and test_panda::type.

Here is the call graph for this function:

◆ InternalWriteDot()

template<typename UVertexWriterTemplate , typename UEdgeWriterTemplate >
void ugraph::InternalWriteDot ( const std::string &  file_name,
const UVertexWriterConstRef  uvertex_writer,
const UEdgeWriterConstRef  uedge_writer 
) const
inlineprotected

Print the graph in dot format.

Parameters
file_nameis the name of the file to be created
node_writeris the functor used to print the node labels
edge_writeris the functor used to print the edge labels

Definition at line 1177 of file graph.hpp.

◆ is_in_subset()

bool ugraph::is_in_subset ( const boost::graph_traits< ugraph >::vertex_descriptor  v) const
inline

return true in case the vertex is a vertex of the subgraph.

Definition at line 1233 of file graph.hpp.

Friends And Related Function Documentation

◆ VERTEX

boost::graph_traits<ugraph>::vertex_descriptor VERTEX ( const boost::graph_traits< ugraph >::vertices_size_type  i,
const ugraph g 
)
friend

this function can access the bulk graph

Parameters
iis the index of the vertex.
gis the ugraph for which the vertex is asked.
Returns
the vertex with the index i of the graph g.

Definition at line 1380 of file graph.hpp.

Field Documentation

◆ collection

undirected_graphs_collection* ugraph::collection
protected

The graph collection.

Definition at line 1165 of file graph.hpp.

◆ selector

const int ugraph::selector
protected

selector

Definition at line 1168 of file graph.hpp.


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

Generated on Mon Feb 12 2024 13:04:09 for PandA-2024.02 by doxygen 1.8.13