TNEGraph Class Reference

Directed multigraph. More...

List of all members.

Classes
class	TEdge
class	TEdgeI
	Edge iterator. Only forward iteration (operator++) is supported. More...
class	TNode
class	TNodeI
	Node iterator. Only forward iteration (operator++) is supported. More...
Public Types
typedef TNEGraph	TNet
typedef TPt< TNEGraph >	PNet
Public Member Functions
	TNEGraph ()
	TNEGraph (const int &Nodes, const int &Edges)
	Constructor that reserves enough memory for a graph of Nodes nodes and Edges edges.
	TNEGraph (const TNEGraph &Graph)
	TNEGraph (TSIn &SIn)
	Constructor for loading the graph from a (binary) stream SIn.
void	Save (TSOut &SOut) const
	Saves the graph to a (binary) stream SOut.
bool	HasFlag (const TGraphFlag &Flag) const
	Allows for run-time checking the type of the graph (see the TGraphFlag for flags).
TNEGraph &	operator= (const TNEGraph &Graph)
int	GetNodes () const
	Returns the number of nodes in the graph.
int	AddNode (int NId=-1)
	Adds a node of ID NId to the graph.
int	AddNode (const TNodeI &NodeId)
	Adds a node of ID NodeI.GetId() to the graph.
void	DelNode (const int &NId)
	Deletes node of ID NId from the graph.
void	DelNode (const TNode &NodeI)
	Deletes node of ID NodeI.GetId() from the graph.
bool	IsNode (const int &NId) const
	Tests whether ID NId is a node.
TNodeI	BegNI () const
	Returns an iterator referring to the first node in the graph.
TNodeI	EndNI () const
	Returns an iterator referring to the past-the-end node in the graph.
TNodeI	GetNI (const int &NId) const
	Returns an iterator referring to the node of ID NId in the graph.
int	GetMxNId () const
	Returns the maximum id of a any node in the graph.
int	GetEdges () const
	Returns the number of edges in the graph.
int	AddEdge (const int &SrcNId, const int &DstNId, int EId=-1)
	Adds an edge with ID EId between node IDs SrcNId and DstNId to the graph.
int	AddEdge (const TEdgeI &EdgeI)
	Adds an edge between EdgeI.GetSrcNId() and EdgeI.GetDstNId() to the graph.
void	DelEdge (const int &EId)
	Deletes an edge with edge ID EId from the graph.
void	DelEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true)
	Deletes all edges between node IDs SrcNId and DstNId from the graph.
bool	IsEdge (const int &EId) const
	Tests whether an edge with edge ID EId exists in the graph.
bool	IsEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true) const
	Tests whether an edge between node IDs SrcNId and DstNId exists in the graph.
bool	IsEdge (const int &SrcNId, const int &DstNId, int &EId, const bool &IsDir=true) const
	Tests whether an edge between node IDs SrcNId and DstNId exists in the graph. if an edge exists, return its edge ID in EId.
int	GetEId (const int &SrcNId, const int &DstNId) const
	Returns an edge ID between node IDs SrcNId and DstNId, if such an edge exists. Otherwise, return -1.
TEdgeI	BegEI () const
	Returns an iterator referring to the first edge in the graph.
TEdgeI	EndEI () const
	Returns an iterator referring to the past-the-end edge in the graph.
TEdgeI	GetEI (const int &EId) const
TEdgeI	GetEI (const int &SrcNId, const int &DstNId) const
int	GetRndNId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random node in the graph.
TNodeI	GetRndNI (TRnd &Rnd=TInt::Rnd)
	Returns an interator referring to a random node in the graph.
int	GetRndEId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random edge in the graph.
TEdgeI	GetRndEI (TRnd &Rnd=TInt::Rnd)
	Returns an interator referring to a random edge in the graph.
void	GetNIdV (TIntV &NIdV) const
	Gets a vector IDs of all nodes in the graph.
void	GetEIdV (TIntV &EIdV) const
	Gets a vector IDs of all edges in the graph.
bool	Empty () const
	Tests whether the graph is empty (has zero nodes).
void	Clr ()
	Deletes all nodes and edges from the graph.
void	Reserve (const int &Nodes, const int &Edges)
	Reserves memory for a graph of Nodes nodes and Edges edges.
void	Defrag (const bool &OnlyNodeLinks=false)
	Defragments the graph.
bool	IsOk (const bool &ThrowExcept=true) const
	Checks the graph data structure for internal consistency.
void	Dump (FILE *OutF=stdout) const
	Print the graph in a human readable form to an output stream OutF.
Static Public Member Functions
static PNEGraph	New ()
	Static constructor that returns a pointer to the graph. Call: PNEGraph Graph = TNEGraph::New().
static PNEGraph	New (const int &Nodes, const int &Edges)
	Static constructor that returns a pointer to the graph and reserves enough memory for Nodes nodes and Edges edges.
static PNEGraph	Load (TSIn &SIn)
	Static constructor that loads the graph from a stream SIn and returns a pointer to it.
static PNEGraph	GetSmallGraph ()
Friends
class	TPt< TNEGraph >

---

Detailed Description

Directed multigraph.

Node IDs can be arbitrary non-negative integers. Nodes and edges have no attributes/data associated with them. There can be more than one directed edge from one source node to a destination node. Self loops (one per node) are allowed as well as multiple (parallel) edges.

---

Member Typedef Documentation

typedef TPt<TNEGraph> TNEGraph::PNet

typedef TNEGraph TNEGraph::TNet

---

Constructor & Destructor Documentation

TNEGraph::TNEGraph

(

)

[inline]

TNEGraph::TNEGraph	(	const int &	Nodes,
		const int &	Edges
	)		[inline, explicit]

Constructor that reserves enough memory for a graph of Nodes nodes and Edges edges.

TNEGraph::TNEGraph

(

const TNEGraph &

Graph

)

[inline]

TNEGraph::TNEGraph

(

TSIn &

SIn

)

[inline]

Constructor for loading the graph from a (binary) stream SIn.

---

Member Function Documentation

int TNEGraph::AddEdge	(	const int &	SrcNId,
		const int &	DstNId,
		int	EId = -1
	)

Adds an edge with ID EId between node IDs SrcNId and DstNId to the graph.

Returns the ID of the edge being added. If EId is -1, edge ID is automatically assigned. Aborts, if an edge with ID EId already exists. Aborts, if SrcNId or DstNId are not nodes in the graph.

int TNEGraph::AddEdge

(

const TEdgeI &

EdgeI

)

[inline]

Adds an edge between EdgeI.GetSrcNId() and EdgeI.GetDstNId() to the graph.

int TNEGraph::AddNode

(

int

NId = -1

)

Adds a node of ID NId to the graph.

Returns the ID of the node being added. If NId is -1, node ID is automatically assigned. Aborts, if a node with ID NId already exists.

int TNEGraph::AddNode

(

const TNodeI &

NodeId

)

[inline]

Adds a node of ID NodeI.GetId() to the graph.

TEdgeI TNEGraph::BegEI

(

)

const [inline]

Returns an iterator referring to the first edge in the graph.

TNodeI TNEGraph::BegNI

(

)

const [inline]

Returns an iterator referring to the first node in the graph.

void TNEGraph::Clr

(

)

[inline]

Deletes all nodes and edges from the graph.

void TNEGraph::Defrag

(

const bool &

OnlyNodeLinks = false

)

Defragments the graph.

After performing many node and edge insertions and deletions to a graph, the graph data structure will be fragmented in memory. This function compacts down the graph data structure and frees unneeded memory.

void TNEGraph::DelEdge

(

const int &

EId

)

Deletes an edge with edge ID EId from the graph.

void TNEGraph::DelEdge	(	const int &	SrcNId,
		const int &	DstNId,
		const bool &	IsDir = true
	)

Deletes all edges between node IDs SrcNId and DstNId from the graph.

If the edge (SrcNId, DstNId) does not exist in the graph function still completes. But the function aborts if SrcNId or DstNId are not nodes in the graph.

void TNEGraph::DelNode

(

const int &

NId

)

Deletes node of ID NId from the graph.

If the node of ID NId does not exist the function aborts.

void TNEGraph::DelNode

(

const TNode &

NodeI

)

[inline]

Deletes node of ID NodeI.GetId() from the graph.

void TNEGraph::Dump

(

FILE *

OutF = stdout

)

const

Print the graph in a human readable form to an output stream OutF.

bool TNEGraph::Empty

(

)

const [inline]

Tests whether the graph is empty (has zero nodes).

TEdgeI TNEGraph::EndEI

(

)

const [inline]

Returns an iterator referring to the past-the-end edge in the graph.

TNodeI TNEGraph::EndNI

(

)

const [inline]

Returns an iterator referring to the past-the-end node in the graph.

int TNEGraph::GetEdges

(

)

const [inline]

Returns the number of edges in the graph.

TEdgeI TNEGraph::GetEI

(

const int &

EId

)

const [inline]

TEdgeI TNEGraph::GetEI	(	const int &	SrcNId,
		const int &	DstNId
	)		const [inline]

int TNEGraph::GetEId	(	const int &	SrcNId,
		const int &	DstNId
	)		const [inline]

Returns an edge ID between node IDs SrcNId and DstNId, if such an edge exists. Otherwise, return -1.

void TNEGraph::GetEIdV

(

TIntV &

EIdV

)

const

Gets a vector IDs of all edges in the graph.

int TNEGraph::GetMxNId

(

)

const [inline]

Returns the maximum id of a any node in the graph.

TNodeI TNEGraph::GetNI

(

const int &

NId

)

const [inline]

Returns an iterator referring to the node of ID NId in the graph.

void TNEGraph::GetNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all nodes in the graph.

int TNEGraph::GetNodes

(

)

const [inline]

Returns the number of nodes in the graph.

TEdgeI TNEGraph::GetRndEI

(

TRnd &

Rnd = TInt::Rnd

)

[inline]

Returns an interator referring to a random edge in the graph.

int TNEGraph::GetRndEId

(

TRnd &

Rnd = TInt::Rnd

)

[inline]

Returns an ID of a random edge in the graph.

TNodeI TNEGraph::GetRndNI

(

TRnd &

Rnd = TInt::Rnd

)

[inline]

Returns an interator referring to a random node in the graph.

int TNEGraph::GetRndNId

(

TRnd &

Rnd = TInt::Rnd

)

[inline]

Returns an ID of a random node in the graph.

static PNEGraph TNEGraph::GetSmallGraph

(

)

[static]

bool TNEGraph::HasFlag

(

const TGraphFlag &

Flag

)

const

Allows for run-time checking the type of the graph (see the TGraphFlag for flags).

bool TNEGraph::IsEdge

(

const int &

EId

)

const [inline]

Tests whether an edge with edge ID EId exists in the graph.

bool TNEGraph::IsEdge	(	const int &	SrcNId,
		const int &	DstNId,
		const bool &	IsDir = true
	)		const [inline]

Tests whether an edge between node IDs SrcNId and DstNId exists in the graph.

bool TNEGraph::IsEdge	(	const int &	SrcNId,
		const int &	DstNId,
		int &	EId,
		const bool &	IsDir = true
	)		const

Tests whether an edge between node IDs SrcNId and DstNId exists in the graph. if an edge exists, return its edge ID in EId.

bool TNEGraph::IsNode

(

const int &

NId

)

const [inline]

Tests whether ID NId is a node.

bool TNEGraph::IsOk

(

const bool &

ThrowExcept = true

)

const

Checks the graph data structure for internal consistency.

For each node in the graph check that its neighbors are also nodes in the graph.

static PNEGraph TNEGraph::Load

(

TSIn &

SIn

)

[inline, static]

Static constructor that loads the graph from a stream SIn and returns a pointer to it.

static PNEGraph TNEGraph::New

(

)

[inline, static]

Static constructor that returns a pointer to the graph. Call: PNEGraph Graph = TNEGraph::New().

static PNEGraph TNEGraph::New	(	const int &	Nodes,
		const int &	Edges
	)		[inline, static]

Static constructor that returns a pointer to the graph and reserves enough memory for Nodes nodes and Edges edges.

Call: PNEGraph Graph = TNEGraph::New(Nodes, Edges).

TNEGraph& TNEGraph::operator=

(

const TNEGraph &

Graph

)

[inline]

void TNEGraph::Reserve	(	const int &	Nodes,
		const int &	Edges
	)		[inline]

Reserves memory for a graph of Nodes nodes and Edges edges.

void TNEGraph::Save

(

TSOut &

SOut

)

const [inline]

Saves the graph to a (binary) stream SOut.

---

Friends And Related Function Documentation

friend class TPt< TNEGraph > [friend]

---

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

• snap-core/graph.h
• snap-core/graph.cpp