LLVM: llvm::xray::Graph< VertexAttribute, EdgeAttribute, VI (original) (raw)

A Graph object represents a Directed Graph and is used in XRay to compute and store function call graphs and associated statistical information. More...

#include "[llvm/XRay/Graph.h](XRay%5F2Graph%5F8h%5Fsource.html)"

Classes
class	EdgeView
	A class for ranging over all the edges in the graph. More...
class	InOutEdgeView
	A class for ranging over the incoming edges incident to a vertex. More...
class	VertexView
	A class for ranging over the vertices in the graph. More...

Public Types
typedef VI	VertexIdentifier
	These objects are used to name edges and vertices in the graph.
typedef std::pair< VI, VI >	EdgeIdentifier
using	VertexValueType
	This type is the value_type of all iterators which range over vertices, Determined by the Vertices DenseMap.
using	EdgeValueType = detail::DenseMapPair<EdgeIdentifier, EdgeAttribute>
	This type is the value_type of all iterators which range over edges, Determined by the Edges DenseMap.
using	size_type = std::size_t
using	ConstInEdgeIterator = NeighborEdgeIteratorT<true, false>
	A const iterator type for iterating through the set of edges entering a vertex.
using	InEdgeIterator = NeighborEdgeIteratorT<false, false>
	An iterator type for iterating through the set of edges leaving a vertex.
using	ConstOutEdgeIterator = NeighborEdgeIteratorT<true, true>
	A const iterator type for iterating through the set of edges entering a vertex.
using	OutEdgeIterator = NeighborEdgeIteratorT<false, true>
	An iterator type for iterating through the set of edges leaving a vertex.
using	ConstVertexIterator = typename VertexMapT::const_iterator
	A const iterator type for iterating through the whole vertex set of the graph.
using	VertexIterator = typename VertexMapT::iterator
	An iterator type for iterating through the whole vertex set of the graph.
using	ConstEdgeIterator = typename EdgeMapT::const_iterator
	A const iterator for iterating through the entire edge set of the graph.
using	EdgeIterator = typename EdgeMapT::iterator
	An iterator for iterating through the entire edge set of the graph.

Public Member Functions
void	clear ()
	Empty the Graph.
VertexView< false >	vertices ()
	Returns a view object allowing iteration over the vertices of the graph.
VertexView< true >	vertices () const
EdgeView< false >	edges ()
	Returns a view object allowing iteration over the edges of the graph.
EdgeView< true >	edges () const
InOutEdgeView< false, true >	outEdges (const VertexIdentifier I)
	Returns a view object allowing iteration over the edges which start at a vertex I.
InOutEdgeView< true, true >	outEdges (const VertexIdentifier I) const
InOutEdgeView< false, false >	inEdges (const VertexIdentifier I)
	Returns a view object allowing iteration over the edges which point to a vertex I.
InOutEdgeView< true, false >	inEdges (const VertexIdentifier I) const
VertexAttribute &	operator[] (const VertexIdentifier &I)
	Looks up the vertex with identifier I, if it does not exist it default constructs it.
EdgeAttribute &	operator[] (const EdgeIdentifier &I)
	Looks up the edge with identifier I, if it does not exist it default constructs it, if it's endpoints do not exist it also default constructs them.
Expected< VertexAttribute & >	at (const VertexIdentifier &I)
	Looks up a vertex with Identifier I, or an error if it does not exist.
Expected< const VertexAttribute & >	at (const VertexIdentifier &I) const
Expected< EdgeAttribute & >	at (const EdgeIdentifier &I)
	Looks up an edge with Identifier I, or an error if it does not exist.
Expected< const EdgeAttribute & >	at (const EdgeIdentifier &I) const
size_type	count (const VertexIdentifier &I) const
	Looks for a vertex with identifier I, returns 1 if one exists, and 0 otherwise.
size_type	count (const EdgeIdentifier &I) const
	Looks for an edge with Identifier I, returns 1 if one exists and 0 otherwise.
std::pair< VertexIterator, bool >	insert (const std::pair< VertexIdentifier, VertexAttribute > &Val)
	Inserts a vertex into the graph with Identifier Val.first, and Attribute Val.second.
std::pair< VertexIterator, bool >	insert (std::pair< VertexIdentifier, VertexAttribute > &&Val)
std::pair< EdgeIterator, bool >	insert (const std::pair< EdgeIdentifier, EdgeAttribute > &Val)
	Inserts an edge into the graph with Identifier Val.first, and Attribute Val.second.
std::pair< EdgeIterator, bool >	insert (std::pair< EdgeIdentifier, EdgeAttribute > &&Val)
	Inserts an edge into the graph with Identifier Val.first, and Attribute Val.second.

template<typename VertexAttribute, typename EdgeAttribute, typename VI = int32_t>
class llvm::xray::Graph< VertexAttribute, EdgeAttribute, VI >

A Graph object represents a Directed Graph and is used in XRay to compute and store function call graphs and associated statistical information.

The graph takes in four template parameters, these are:

VertexAttribute, this is a structure which is stored for each vertex. Must be DefaultConstructible, CopyConstructible, CopyAssignable and Destructible.
EdgeAttribute, this is a structure which is stored for each edge Must be DefaultConstructible, CopyConstructible, CopyAssignable and Destructible.
EdgeAttribute, this is a structure which is stored for each variable
VI, this is a type over which DenseMapInfo is defined and is the type used look up strings, available as VertexIdentifier.
If the built in DenseMapInfo is not defined, provide a specialization class type here.

Graph is CopyConstructible, CopyAssignable, MoveConstructible and MoveAssignable but is not EqualityComparible or LessThanComparible.

Usage Example Graph with weighted edges and vertices: Graph<int, int, int> G;

G[1] = 0; G[2] = 2; G[{1,2}] = 1; G[{2,1}] = -1; for(const auto &v : G.vertices()){ // Do something with the vertices in the graph; } for(const auto &e : G.edges()){ // Do something with the edges in the graph; }

Usage Example with StrRef keys. Graph<int, double, StrRef> StrG; char va[] = "Vertex A"; char vaa[] = "Vertex A"; char vb[] = "Vertex B"; // Vertices are referenced by String Refs. G[va] = 0; G[vb] = 1; G[{va, vb}] = 1.0; cout() << G[vaa] << " " << G[{vaa, vb}]; //prints "0 1.0".

Definition at line 73 of file Graph.h.