SNAP Library 3.0, User Reference
2016-07-20 17:56:49
SNAP, a general purpose, high performance system for analysis and manipulation of large networks
|
Node Edge Network (directed multigraph, TNEGraph with data on nodes and edges). More...
#include <network.h>
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 TNodeData | TNodeDat |
typedef TEdgeData | TEdgeDat |
typedef TNodeEdgeNet < TNodeData, TEdgeData > | TNet |
typedef TPt< TNet > | PNet |
Public Member Functions | |
TNodeEdgeNet () | |
TNodeEdgeNet (const int &Nodes, const int &Edges) | |
Constructor that reserves enough memory for a network of Nodes nodes and Edges edges. More... | |
TNodeEdgeNet (const TNodeEdgeNet &Net) | |
TNodeEdgeNet (TSIn &SIn) | |
Constructor that loads the network from a (binary) stream SIn. More... | |
virtual | ~TNodeEdgeNet () |
virtual void | Save (TSOut &SOut) const |
Saves the network to a (binary) stream SOut. More... | |
bool | HasFlag (const TGraphFlag &Flag) const |
Allows for run-time checking the type of the network (see the TGraphFlag for flags). More... | |
TNodeEdgeNet & | operator= (const TNodeEdgeNet &Net) |
int | GetNodes () const |
Returns the number of nodes in the network. More... | |
int | AddNode (int NId=-1) |
Adds a node of ID NId to the network. More... | |
int | AddNode (int NId, const TNodeData &NodeDat) |
Adds node data to node with ID NId. More... | |
int | AddNode (const TNodeI &NodeI) |
void | DelNode (const int &NId) |
Deletes node of ID NId from the network. More... | |
void | DelNode (const TNode &NodeI) |
Deletes node of ID NodeI.GetId() from the network. More... | |
bool | IsNode (const int &NId) const |
Tests whether ID NId is a node. More... | |
TNodeI | BegNI () const |
Returns an iterator referring to the first node in the network. More... | |
TNodeI | EndNI () const |
Returns an iterator referring to the past-the-end node in the network. More... | |
TNodeI | GetNI (const int &NId) const |
Returns an iterator referring to the node of ID NId in the network. More... | |
void | SetNDat (const int &NId, const TNodeData &NodeDat) |
Sets node data for the node of ID NId in the network. More... | |
TNodeData & | GetNDat (const int &NId) |
Returns node data for the node of ID NId in the network. More... | |
const TNodeData & | GetNDat (const int &NId) const |
Returns node data for the node of ID NId in the network. More... | |
int | GetMxNId () const |
Returns an ID that is larger than any node ID in the network. More... | |
int | GetEdges () const |
Returns the number of edges in the network. More... | |
int | GetUniqEdges (const bool &IsDir=true) const |
Returns the number of edges in the network with a unique pair of nodes. More... | |
int | AddEdge (const int &SrcNId, const int &DstNId, int EId=-1) |
Adds an edge between node IDs SrcNId and DstNId to the graph. More... | |
int | AddEdge (const int &SrcNId, const int &DstNId, int EId, const TEdgeData &EdgeDat) |
Adds an edge and edge data from node IDs SrcNId to node DstNId. More... | |
int | AddEdge (const TEdgeI &EdgeI) |
Adds an edge from EdgeI.GetSrcNId() to EdgeI.GetDstNId() and its edge data to the network. More... | |
void | DelEdge (const int &EId) |
Deletes an edge with ID EId from the network. More... | |
void | DelEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true) |
Deletes an edge from node IDs SrcNId to DstNId from the network. More... | |
bool | IsEdge (const int &EId) const |
Tests whether an edge with ID EId exists in the network. More... | |
bool | IsEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true) const |
Tests whether an edge from node IDs SrcNId to DstNId exists in the network. More... | |
bool | IsEdge (const int &SrcNId, const int &DstNId, int &EId, const bool &IsDir=true) const |
Tests whether an edge from node IDs SrcNId to DstNId with edge ID EId exists in the network. More... | |
int | GetEId (const int &SrcNId, const int &DstNId) const |
TEdgeI | BegEI () const |
Returns an iterator referring to the first edge in the network. More... | |
TEdgeI | EndEI () const |
Returns an iterator referring to the past-the-end edge in the network. More... | |
TEdgeI | GetEI (const int &EId) const |
Not supported/implemented! More... | |
TEdgeI | GetEI (const int &SrcNId, const int &DstNId) const |
Returns an iterator referring to edge (SrcNId, DstNId) in the graph. More... | |
void | SetEDat (const int &EId, const TEdgeData &EdgeDat) |
Sets edge data for the edge of ID NId in the network. More... | |
TEdgeData & | GetEDat (const int &EId) |
Returns edge data for the edge with ID EId. More... | |
const TEdgeData & | GetEDat (const int &EId) const |
Returns edge data for the edge with ID EId. More... | |
void | SetAllEDat (const TEdgeData &EdgeDat) |
Sets edge data for all the edges in the network to EDat. More... | |
int | GetRndNId (TRnd &Rnd=TInt::Rnd) |
Returns an ID of a random node in the network. More... | |
TNodeI | GetRndNI (TRnd &Rnd=TInt::Rnd) |
Returns an interator referring to a random node in the network. More... | |
int | GetRndEId (TRnd &Rnd=TInt::Rnd) |
Returns an ID of a random edge in the network. More... | |
TEdgeI | GetRndEI (TRnd &Rnd=TInt::Rnd) |
Returns an interator referring to a random edge in the network. More... | |
void | GetNIdV (TIntV &NIdV) const |
Returns a vector of all node IDs in the network. More... | |
void | GetEIdV (TIntV &EIdV) const |
Returns a vector of all edge IDs in the network. More... | |
bool | Empty () const |
Tests whether the network is empty (has zero nodes). More... | |
void | Clr () |
Deletes all nodes and edges from the network. More... | |
void | Reserve (const int &Nodes, const int &Edges) |
Reserves memory for a network of Nodes nodes and Edges edges. More... | |
void | SortNIdById (const bool &Asc=true) |
Sorts nodes by node IDs. More... | |
void | SortNIdByDat (const bool &Asc=true) |
Sorts nodes by node data. More... | |
void | SortEIdById (const bool &Asc=true) |
Sorts edges by edge IDs. More... | |
void | SortEIdByDat (const bool &Asc=true) |
Sorts edges by edge data. More... | |
void | Defrag (const bool &OnlyNodeLinks=false) |
Defragments the network. More... | |
bool | IsOk (const bool &ThrowExcept=true) const |
Checks the network data structure for internal consistency. More... | |
Static Public Member Functions | |
static PNet | New () |
Static constructor that returns a pointer to the network. Call: TPt <TNodeEdgeNet<TNodeData, TEdgeData> > Net = TNodeEdgeNet<TNodeData, TEdgeData>::New(). More... | |
static PNet | Load (TSIn &SIn) |
Static constructor that loads the network from a stream SIn and returns a pointer to it. More... | |
Protected Attributes | |
TCRef | CRef |
TInt | MxNId |
TInt | MxEId |
THash< TInt, TNode > | NodeH |
THash< TInt, TEdge > | EdgeH |
Private Member Functions | |
TNode & | GetNode (const int &NId) |
const TNode & | GetNode (const int &NId) const |
const TNode & | GetNodeKId (const int &NodeKeyId) const |
TEdge & | GetEdge (const int &EId) |
const TEdge & | GetEdge (const int &EId) const |
const TEdge & | GetEdgeKId (const int &EdgeKeyId) const |
Friends | |
class | TCrossNet |
Adds a node NodeI and its node data to the network. More... | |
class | TPt< TNodeEdgeNet< TNodeData, TEdgeData > > |
Node Edge Network (directed multigraph, TNEGraph with data on nodes and edges).
typedef TPt<TNet> TNodeEdgeNet< TNodeData, TEdgeData >::PNet |
typedef TEdgeData TNodeEdgeNet< TNodeData, TEdgeData >::TEdgeDat |
typedef TNodeEdgeNet<TNodeData, TEdgeData> TNodeEdgeNet< TNodeData, TEdgeData >::TNet |
typedef TNodeData TNodeEdgeNet< TNodeData, TEdgeData >::TNodeDat |
|
inline |
|
inlineexplicit |
Constructor that reserves enough memory for a network of Nodes nodes and Edges edges.
Definition at line 1158 of file network.h.
|
inline |
|
inline |
|
inlinevirtual |
int TNodeEdgeNet< TNodeData, TEdgeData >::AddEdge | ( | const int & | SrcNId, |
const int & | DstNId, | ||
int | EId = -1 |
||
) |
Adds an edge 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.
Definition at line 1407 of file network.h.
int TNodeEdgeNet< TNodeData, TEdgeData >::AddEdge | ( | const int & | SrcNId, |
const int & | DstNId, | ||
int | EId, | ||
const TEdgeData & | EdgeDat | ||
) |
Adds an edge and edge data from node IDs SrcNId to node DstNId.
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.
Definition at line 1419 of file network.h.
|
inline |
Adds an edge from EdgeI.GetSrcNId() to EdgeI.GetDstNId() and its edge data to the network.
Definition at line 1234 of file network.h.
int TNodeEdgeNet< TNodeData, TEdgeData >::AddNode | ( | int | NId = -1 | ) |
Adds a node of ID NId to the network.
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.
Definition at line 1345 of file network.h.
int TNodeEdgeNet< TNodeData, TEdgeData >::AddNode | ( | int | NId, |
const TNodeData & | NodeDat | ||
) |
Adds node data to node with ID NId.
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.
Definition at line 1357 of file network.h.
|
inline |
Definition at line 1190 of file network.h.
|
inline |
|
inline |
|
inline |
Deletes all nodes and edges from the network.
Definition at line 1283 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::Defrag | ( | const bool & | OnlyNodeLinks = false | ) |
void TNodeEdgeNet< TNodeData, TEdgeData >::DelEdge | ( | const int & | EId | ) |
Deletes an edge with ID EId from the network.
Definition at line 1431 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::DelEdge | ( | const int & | SrcNId, |
const int & | DstNId, | ||
const bool & | IsDir = true |
||
) |
Deletes an edge from node IDs SrcNId to DstNId from the network.
If the edge (SrcNId, DstNId) does not exist in the network function still completes. But the function aborts if SrcNId or DstNId are not nodes in the network.
Definition at line 1441 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::DelNode | ( | const int & | NId | ) |
|
inline |
Deletes node of ID NodeI.GetId() from the network.
Definition at line 1196 of file network.h.
|
inline |
Tests whether the network is empty (has zero nodes).
Definition at line 1281 of file network.h.
|
inline |
|
inline |
|
inline |
|
inline |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inline |
|
inline |
|
inline |
Returns an iterator referring to edge (SrcNId, DstNId) in the graph.
Definition at line 1257 of file network.h.
|
inline |
Definition at line 1249 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::GetEIdV | ( | TIntV & | EIdV | ) | const |
Returns a vector of all edge IDs in the network.
Definition at line 1492 of file network.h.
|
inline |
|
inline |
|
inline |
|
inline |
void TNodeEdgeNet< TNodeData, TEdgeData >::GetNIdV | ( | TIntV & | NIdV | ) | const |
Returns a vector of all node IDs in the network.
Definition at line 1484 of file network.h.
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inline |
|
inline |
Returns an interator referring to a random edge in the network.
Definition at line 1274 of file network.h.
|
inline |
Returns an ID of a random edge in the network.
Definition at line 1272 of file network.h.
|
inline |
Returns an interator referring to a random node in the network.
Definition at line 1270 of file network.h.
|
inline |
Returns an ID of a random node in the network.
Definition at line 1268 of file network.h.
int TNodeEdgeNet< TNodeData, TEdgeData >::GetUniqEdges | ( | const bool & | IsDir = true | ) | const |
Returns the number of edges in the network with a unique pair of nodes.
Definition at line 1395 of file network.h.
bool TNodeEdgeNet< TNodeData, TEdgeData >::HasFlag | ( | const TGraphFlag & | Flag | ) | const |
Allows for run-time checking the type of the network (see the TGraphFlag for flags).
Definition at line 1320 of file network.h.
|
inline |
|
inline |
Tests whether an edge from node IDs SrcNId to DstNId exists in the network.
Definition at line 1246 of file network.h.
bool TNodeEdgeNet< TNodeData, TEdgeData >::IsEdge | ( | const int & | SrcNId, |
const int & | DstNId, | ||
int & | EId, | ||
const bool & | IsDir = true |
||
) | const |
Tests whether an edge from node IDs SrcNId to DstNId with edge ID EId exists in the network.
Definition at line 1450 of file network.h.
|
inline |
bool TNodeEdgeNet< TNodeData, TEdgeData >::IsOk | ( | const bool & | ThrowExcept = true | ) | const |
Checks the network data structure for internal consistency.
For each node in the network check that its neighbors are also nodes in the network.
Definition at line 1510 of file network.h.
|
inlinestatic |
|
inlinestatic |
Static constructor that returns a pointer to the network. Call: TPt <TNodeEdgeNet<TNodeData, TEdgeData> > Net = TNodeEdgeNet<TNodeData, TEdgeData>::New().
Definition at line 1166 of file network.h.
|
inline |
|
inline |
|
inlinevirtual |
Saves the network to a (binary) stream SOut.
Reimplemented in TTimeNENet.
Definition at line 1164 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::SetAllEDat | ( | const TEdgeData & | EdgeDat | ) |
Sets edge data for all the edges in the network to EDat.
Definition at line 1476 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::SetEDat | ( | const int & | EId, |
const TEdgeData & | EdgeDat | ||
) |
Sets edge data for the edge of ID NId in the network.
Definition at line 1470 of file network.h.
void TNodeEdgeNet< TNodeData, TEdgeData >::SetNDat | ( | const int & | NId, |
const TNodeData & | NodeDat | ||
) |
Sets node data for the node of ID NId in the network.
Definition at line 1389 of file network.h.
|
inline |
|
inline |
|
inline |
|
inline |
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |