TUNGraph Class Reference

Undirected graph. More...

#include <graph.h>

Collaboration diagram for TUNGraph:

Classes
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 TUNGraph	TNet
typedef TPt< TUNGraph >	PNet

Public Member Functions
	TUNGraph ()
	TUNGraph (const int &Nodes, const int &Edges)
	Constructor that reserves enough memory for a graph of Nodes nodes and Edges edges. More...
	TUNGraph (const TUNGraph &Graph)
	TUNGraph (TSIn &SIn)
	Constructor that loads the graph from a (binary) stream SIn. More...
void	Save (TSOut &SOut) const
	Saves the graph to a (binary) stream SOut. More...
bool	HasFlag (const TGraphFlag &Flag) const
	Allows for run-time checking the type of the graph (see the TGraphFlag for flags). More...
TUNGraph &	operator= (const TUNGraph &Graph)
int	GetNodes () const
	Returns the number of nodes in the graph. More...
int	AddNode (int NId=-1)
	Adds a node of ID NId to the graph. More...
int	AddNode (const TNodeI &NodeI)
	Adds a node of ID NodeI.GetId() to the graph. More...
int	AddNode (const int &NId, const TIntV &NbrNIdV)
	Adds a node of ID NId to the graph and create edges to all nodes in vector NbrNIdV. More...
int	AddNode (const int &NId, const TVecPool< TInt > &Pool, const int &NIdVId)
	Adds a node of ID NId to the graph and create edges to all nodes in vector NIdVId in the vector pool Pool. More...
void	DelNode (const int &NId)
	Deletes node of ID NId from the graph. More...
void	DelNode (const TNode &NodeI)
	Deletes node of ID NodeI.GetId() from the graph. 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 graph. More...
TNodeI	EndNI () const
	Returns an iterator referring to the past-the-end node in the graph. More...
TNodeI	GetNI (const int &NId) const
	Returns an iterator referring to the node of ID NId in the graph. More...
int	GetMxNId () const
	Returns an ID that is larger than any node ID in the graph. More...
int	GetEdges () const
	Returns the number of edges in the graph. More...
int	AddEdge (const int &SrcNId, const int &DstNId)
	Adds an edge between node IDs SrcNId and DstNId to the graph. More...
int	AddEdge (const TEdgeI &EdgeI)
	Adds an edge between EdgeI.GetSrcNId() and EdgeI.GetDstNId() to the graph. More...
void	DelEdge (const int &SrcNId, const int &DstNId)
	Deletes an edge between node IDs SrcNId and DstNId from the graph. More...
bool	IsEdge (const int &SrcNId, const int &DstNId) const
	Tests whether an edge between node IDs SrcNId and DstNId exists in the graph. More...
TEdgeI	BegEI () const
	Returns an iterator referring to the first edge in the graph. More...
TEdgeI	EndEI () const
	Returns an iterator referring to the past-the-end edge in the graph. 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...
int	GetRndNId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random node in the graph. More...
TNodeI	GetRndNI (TRnd &Rnd=TInt::Rnd)
	Returns an interator referring to a random node in the graph. More...
void	GetNIdV (TIntV &NIdV) const
	Gets a vector IDs of all nodes in the graph. More...
bool	Empty () const
	Tests whether the graph is empty (has zero nodes). More...
void	Clr ()
	Deletes all nodes and edges from the graph. More...
void	Reserve (const int &Nodes, const int &Edges)
	Reserves memory for a graph of Nodes nodes and Edges edges. More...
void	ReserveNIdDeg (const int &NId, const int &Deg)
	Reserves memory for node ID NId having Deg edges. More...
void	Defrag (const bool &OnlyNodeLinks=false)
	Defragments the graph. More...
bool	IsOk (const bool &ThrowExcept=true) const
	Checks the graph data structure for internal consistency. More...
void	Dump (FILE *OutF=stdout) const
	Print the graph in a human readable form to an output stream OutF. More...

Static Public Member Functions
static PUNGraph	New ()
	Static constructor that returns a pointer to the graph. Call: PUNGraph Graph = TUNGraph::New(). More...
static PUNGraph	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. More...
static PUNGraph	Load (TSIn &SIn)
	Static constructor that loads the graph from a stream SIn and returns a pointer to it. More...
static PUNGraph	GetSmallGraph ()
	Returns a small graph on 5 nodes and 5 edges. More...

Private Member Functions
TNode &	GetNode (const int &NId)
const TNode &	GetNode (const int &NId) const

Private Attributes
TCRef	CRef
TInt	MxNId
TInt	NEdges
THash< TInt, TNode >	NodeH

Friends
class	TUNGraphMtx
class	TPt< TUNGraph >

Detailed Description

Undirected graph.

Node IDs can be arbitrary non-negative integers. Nodes and edges have no attributes/data associated with them. There is at most one undirected edge between a pair of nodes. Self loops (one per node) are allowed but multiple (parallel) edges are not. The undirected graph data structure is implemented using sorted adjacency lists. This means adding a node takes constant time, while adding an edge takes linear time (since adjacency list is kept sorted) in the node degree. Accessing arbitrary node takes constant time and accessing any edge takes logarithmic time in the node degree.

Definition at line 32 of file graph.h.

Member Typedef Documentation

typedef TPt<TUNGraph> TUNGraph::PNet

Definition at line 35 of file graph.h.

typedef TUNGraph TUNGraph::TNet

Definition at line 34 of file graph.h.

Constructor & Destructor Documentation

TUNGraph::TUNGraph ( )

inline

Definition at line 143 of file graph.h.

Referenced by Load(), and New().

: CRef(), MxNId(0), NEdges(0), NodeH() { }

Here is the caller graph for this function:

TUNGraph::TUNGraph ( const int &  Nodes, const int &  Edges  )

inlineexplicit

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

Definition at line 145 of file graph.h.

References Reserve().

: MxNId(0), NEdges(0) { Reserve(Nodes, Edges); }

Here is the call graph for this function:

TUNGraph::TUNGraph ( const TUNGraph &  Graph )

inline

Definition at line 146 of file graph.h.

: MxNId(Graph.MxNId), NEdges(Graph.NEdges), NodeH(Graph.NodeH) { }

TUNGraph::TUNGraph ( TSIn &  SIn )

inline

Constructor that loads the graph from a (binary) stream SIn.

Definition at line 148 of file graph.h.

: MxNId(SIn), NEdges(SIn), NodeH(SIn) { }

Member Function Documentation

int TUNGraph::AddEdge	(	const int &	SrcNId,
		const int &	DstNId
	)

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

If the edge already exists return -2. If the edge was successfully added return -1. Normally the function should return an ID of the edge added but since edges in TUNGraph have no IDs we return -1. The function aborts if SrcNId or DstNId are not nodes in the graph.

Definition at line 84 of file graph.cpp.

References TVec< TVal, TSizeTy >::AddSorted(), TStr::Fmt(), GetNode(), IAssertR, IsEdge(), IsNode(), NEdges, and TUNGraph::TNode::NIdV.

Referenced by TUndirFFire::AddNodes(), TCliqueOverlap::CalculateOverlapMtx(), TSnap::GenConfModel(), TSnap::GenDegSeq(), TSnap::GenPrefAttach(), TSnap::GenRewire(), TSnap::GenSmallWorld(), TSnap::GetEgonet(), GetSmallGraph(), TSnap::GetSubGraph(), TTimeNENet::GetTriadEdges(), TAGM::RndConnectInsideCommunity(), and TNetConstraint< PGraph >::Test().

                                                          {
  IAssertR(IsNode(SrcNId) && IsNode(DstNId), TStr::Fmt("%d or %d not a node.", SrcNId, DstNId).CStr());
  if (IsEdge(SrcNId, DstNId)) { return -2; } // edge already exists
  GetNode(SrcNId).NIdV.AddSorted(DstNId);
  if (SrcNId!=DstNId) { // not a self edge
    GetNode(DstNId).NIdV.AddSorted(SrcNId); }
  NEdges++;
  return -1; // edge id
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::AddEdge ( const TEdgeI &  EdgeI )

inline

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

Definition at line 221 of file graph.h.

References AddEdge(), TUNGraph::TEdgeI::GetDstNId(), and TUNGraph::TEdgeI::GetSrcNId().

Referenced by AddEdge().

{ return AddEdge(EdgeI.GetSrcNId(), EdgeI.GetDstNId()); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::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.

Definition at line 8 of file graph.cpp.

References THash< TKey, TDat, THashFunc >::AddDat(), TStr::Fmt(), IAssertR, IsNode(), TMath::Mx(), MxNId, and NodeH.

Referenced by TUndirFFire::AddNodes(), TCliqueOverlap::CalculateOverlapMtx(), TAGM::GenAGM(), TSnap::GenConfModel(), TSnap::GenDegSeq(), TSnap::GenPrefAttach(), TSnap::GenRewire(), TSnap::GenSmallWorld(), TSnap::GetEgonet(), GetSmallGraph(), TSnap::GetSubGraph(), TTimeNENet::GetTriadEdges(), and TNetConstraint< PGraph >::Test().

                             {
  if (NId == -1) {
    NId = MxNId;  MxNId++;
  } else {
    IAssertR(!IsNode(NId), TStr::Fmt("NodeId %d already exists", NId));
    MxNId = TMath::Mx(NId+1, MxNId());
  }
  NodeH.AddDat(NId, TNode(NId));
  return NId;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::AddNode ( const TNodeI &  NodeI )

inline

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

Definition at line 173 of file graph.h.

References AddNode(), and TUNGraph::TNodeI::GetId().

Referenced by AddNode().

{ return AddNode(NodeI.GetId()); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::AddNode	(	const int &	NId,
		const TIntV &	NbrNIdV
	)

Adds a node of ID NId to the graph and create edges to all nodes in vector NbrNIdV.

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.

The operation can create inconsistent graphs when the neighboring nodes in NbrNIdV vector do not exist. Use TUNGraph::IsOk to check that the resulting graph is consistent after the operation.

Definition at line 20 of file graph.cpp.

References THash< TKey, TDat, THashFunc >::AddDat(), TVec< TVal, TSizeTy >::AddSorted(), TStr::Fmt(), TUNGraph::TNode::GetDeg(), GetNode(), IAssertR, TUNGraph::TNode::Id, IsNode(), TVec< TVal, TSizeTy >::Len(), TMath::Mx(), MxNId, NEdges, TUNGraph::TNode::NIdV, NodeH, and TVec< TVal, TSizeTy >::Sort().

                                                          {
  int NewNId;
  if (NId == -1) {
    NewNId = MxNId;  MxNId++;
  } else {
    IAssertR(! IsNode(NId), TStr::Fmt("NodeId %d already exists", NId));
    NewNId = NId;
    MxNId = TMath::Mx(NewNId+1, MxNId());
  }
  TNode& Node = NodeH.AddDat(NewNId);
  Node.Id = NewNId;
  Node.NIdV = NbrNIdV;
  Node.NIdV.Sort();
  NEdges += Node.GetDeg();
  for (int i = 0; i < NbrNIdV.Len(); i++) {
    GetNode(NbrNIdV[i]).NIdV.AddSorted(NewNId);
  }
  return NewNId;
}

Here is the call graph for this function:

int TUNGraph::AddNode	(	const int &	NId,
		const TVecPool< TInt > &	Pool,
		const int &	NIdVId
	)

Adds a node of ID NId to the graph and create edges to all nodes in vector NIdVId in the vector pool Pool.

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.

The operation can create inconsistent graphs when the neighboring nodes stored in the Pool vector are not explicitly added to the graph. Use TUNGraph::IsOk to check that the resulting graph is consistent.

Definition at line 41 of file graph.cpp.

References THash< TKey, TDat, THashFunc >::AddDat(), TStr::Fmt(), TVec< TVal, TSizeTy >::GenExt(), TUNGraph::TNode::GetDeg(), TVecPool< TVal, TSizeTy >::GetValVPt(), TVecPool< TVal, TSizeTy >::GetVLen(), IAssertR, TUNGraph::TNode::Id, IsNode(), TMath::Mx(), MxNId, NEdges, TUNGraph::TNode::NIdV, NodeH, and TVec< TVal, TSizeTy >::Sort().

                                                                                   {
  int NewNId;
  if (NId == -1) {
    NewNId = MxNId;  MxNId++;
  } else {
    IAssertR(!IsNode(NId), TStr::Fmt("NodeId %d already exists", NId));
    NewNId = NId;
    MxNId = TMath::Mx(NewNId+1, MxNId()); 
  }
  TNode& Node = NodeH.AddDat(NewNId);
  Node.Id = NewNId;
  Node.NIdV.GenExt(Pool.GetValVPt(NIdVId), Pool.GetVLen(NIdVId));
  Node.NIdV.Sort();
  NEdges += Node.GetDeg();
  return NewNId;
}

Here is the call graph for this function:

TEdgeI TUNGraph::BegEI ( ) const

inline

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

Definition at line 230 of file graph.h.

References BegNI(), EndNI(), TUNGraph::TNodeI::GetId(), GetNodes(), TUNGraph::TNodeI::GetOutDeg(), and TUNGraph::TNodeI::GetOutNId().

Referenced by TAGMFast::FindComsByCV(), IsOk(), and TAGMUtil::SaveGephi().

{ TNodeI NI = BegNI(); TEdgeI EI(NI, EndNI(), 0); if (GetNodes() != 0 && (NI.GetOutDeg()==0 || NI.GetId()>NI.GetOutNId(0))) { EI++; } return EI; }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TUNGraph::BegNI ( ) const

inline

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

Definition at line 204 of file graph.h.

References THash< TKey, TDat, THashFunc >::BegI(), and NodeH.

Referenced by BegEI(), TSnap::TSnapDetail::TCNMQMatrix::CmtyCMN(), TLocClust::DrawWhiskers(), TAGMFit::GetEdgeJointCom(), TCliqueOverlap::GetMaximalCliques(), TSnap::TSnapDetail::TCNMQMatrix::Init(), TAGMFit::InitNodeData(), TTimeNet::PlotEffDiam(), TTimeNet::PlotMedianDegOverTm(), TTimeNet::PlotMissingPast(), TAGMUtil::SaveGephi(), TLocClust::SavePajek(), and TKronMomentsFit::TKronMomentsFit().

{ return TNodeI(NodeH.BegI()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::Clr ( )

inline

Deletes all nodes and edges from the graph.

Definition at line 250 of file graph.h.

References THash< TKey, TDat, THashFunc >::Clr(), MxNId, NEdges, and NodeH.

{ MxNId=0; NEdges=0; NodeH.Clr(); }

Here is the call graph for this function:

void TUNGraph::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.

Definition at line 132 of file graph.cpp.

References THash< TKey, TDat, THashFunc >::Defrag(), THash< TKey, TDat, THashFunc >::FFirstKeyId(), THash< TKey, TDat, THashFunc >::FNextKeyId(), THash< TKey, TDat, THashFunc >::IsKeyIdEqKeyN(), NodeH, and THash< TKey, TDat, THashFunc >::Pack().

Referenced by TAGM::GenAGM(), TSnap::GenSmallWorld(), and TTimeNet::PlotMissingPast().

                                               {
  for (int n = NodeH.FFirstKeyId(); NodeH.FNextKeyId(n); ) {
    NodeH[n].NIdV.Pack();
  }
  if (! OnlyNodeLinks && ! NodeH.IsKeyIdEqKeyN()) {
    NodeH.Defrag();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::DelEdge	(	const int &	SrcNId,
		const int &	DstNId
	)

Deletes an edge 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.

Definition at line 95 of file graph.cpp.

References TVec< TVal, TSizeTy >::Del(), TStr::Fmt(), GetNode(), IAssertR, IsNode(), NEdges, TUNGraph::TNode::NIdV, and TVec< TVal, TSizeTy >::SearchBin().

Referenced by TSnap::GenDegSeq(), and TTimeNet::PlotMissingPast().

                                                           {
  IAssertR(IsNode(SrcNId) && IsNode(DstNId), TStr::Fmt("%d or %d not a node.", SrcNId, DstNId).CStr());
  { TNode& N = GetNode(SrcNId);
  const int n = N.NIdV.SearchBin(DstNId);
  if (n!= -1) { N.NIdV.Del(n);  NEdges--; } }
  if (SrcNId != DstNId) { // not a self edge
    TNode& N = GetNode(DstNId);
    const int n = N.NIdV.SearchBin(SrcNId);
    if (n!= -1) { N.NIdV.Del(n); }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::DelNode

(

const int &

NId

)

Deletes node of ID NId from the graph.

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

Definition at line 59 of file graph.cpp.

References AssertR, TVec< TVal, TSizeTy >::Del(), THash< TKey, TDat, THashFunc >::DelKey(), TStr::Fmt(), TUNGraph::TNode::GetDeg(), TUNGraph::TNode::GetNbrNId(), GetNode(), IAssert, IsNode(), NEdges, TUNGraph::TNode::NIdV, NodeH, and TVec< TVal, TSizeTy >::SearchBin().

                                     {
  { AssertR(IsNode(NId), TStr::Fmt("NodeId %d does not exist", NId));
  TNode& Node = GetNode(NId);
  NEdges -= Node.GetDeg();
  for (int e = 0; e < Node.GetDeg(); e++) {
    const int nbr = Node.GetNbrNId(e);
    if (nbr == NId) { continue; }
    TNode& N = GetNode(nbr);
    const int n = N.NIdV.SearchBin(NId);
    IAssert(n != -1); // if NId points to N, then N also should point back
    if (n!= -1) { N.NIdV.Del(n); }
  } }
  NodeH.DelKey(NId);
}

Here is the call graph for this function:

void TUNGraph::DelNode ( const TNode &  NodeI )

inline

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

Definition at line 200 of file graph.h.

References DelNode(), and TUNGraph::TNode::GetId().

Referenced by DelNode().

{ DelNode(NodeI.GetId()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::Dump

(

FILE *

OutF = stdout

)

const

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

Definition at line 179 of file graph.cpp.

References THash< TKey, TDat, THashFunc >::FFirstKeyId(), THash< TKey, TDat, THashFunc >::FNextKeyId(), TUNGraph::TNode::GetDeg(), GetEdges(), TUNGraph::TNode::GetId(), TUNGraph::TNode::GetNbrNId(), GetNodes(), and NodeH.

                                    {
  const int NodePlaces = (int) ceil(log10((double) GetNodes()));
  fprintf(OutF, "-------------------------------------------------\nUndirected Node Graph: nodes: %d, edges: %d\n", GetNodes(), GetEdges());
  for (int N = NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
    const TNode& Node = NodeH[N];
    fprintf(OutF, "  %*d [%d] ", NodePlaces, Node.GetId(), Node.GetDeg());
    for (int edge = 0; edge < Node.GetDeg(); edge++) {
      fprintf(OutF, " %*d", NodePlaces, Node.GetNbrNId(edge)); }
    fprintf(OutF, "\n");
  }
  fprintf(OutF, "\n");
}

Here is the call graph for this function:

bool TUNGraph::Empty ( ) const

inline

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

Definition at line 248 of file graph.h.

References GetNodes().

{ return GetNodes()==0; }

Here is the call graph for this function:

TEdgeI TUNGraph::EndEI ( ) const

inline

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

Definition at line 232 of file graph.h.

References EndNI().

Referenced by TAGMFast::FindComsByCV(), IsOk(), and TAGMUtil::SaveGephi().

{ return TEdgeI(EndNI(), EndNI()); }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TUNGraph::EndNI ( ) const

inline

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

Definition at line 206 of file graph.h.

References THash< TKey, TDat, THashFunc >::EndI(), and NodeH.

Referenced by BegEI(), TSnap::TSnapDetail::TCNMQMatrix::CmtyCMN(), TLocClust::DrawWhiskers(), EndEI(), TAGMFit::GetEdgeJointCom(), GetEI(), TCliqueOverlap::GetMaximalCliques(), TSnap::TSnapDetail::TCNMQMatrix::Init(), TAGMFit::InitNodeData(), TTimeNet::PlotEffDiam(), TTimeNet::PlotMedianDegOverTm(), TTimeNet::PlotMissingPast(), TAGMUtil::SaveGephi(), TLocClust::SavePajek(), and TKronMomentsFit::TKronMomentsFit().

{ return TNodeI(NodeH.EndI()); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::GetEdges

(

)

const

Returns the number of edges in the graph.

Definition at line 74 of file graph.cpp.

References NEdges.

Referenced by TLocClustStat::AddCut(), TUndirFFire::AddNodes(), TLocClustStat::AddToBestCutH(), TLocClust::DrawWhiskers(), Dump(), TAGMUtil::FindComsByAGM(), TAGMFast::FindComsByCV(), TAGM::GenAGM(), TAGMFast::GetCmtyVV(), TCesna::GetCmtyVV(), TCesna::GetCmtyVVUnSorted(), TAGMUtil::GetConductance(), TCliqueOverlap::GetCPMCommunities(), TLocClust::GetCutStat(), TAGMFit::GetEdgeJointCom(), TTimeNENet::GetTriadEdges(), TLocClustStat::ImposeNCP(), TSnap::TSnapDetail::TCNMQMatrix::Init(), IsOk(), TAGMFit::MLEGradAscentGivenCAG(), TAGMFast::NeighborComInit(), TAGMFit::NeighborComInit(), TLocClustStat::ParamStr(), TLocClustStat::PlotBoltzmanCurve(), TTimeNet::PlotCCfOverTm(), TTimeNet::PlotEffDiam(), TTimeNet::PlotMedianDegOverTm(), TLocClustStat::PlotNCPModul(), TLocClustStat::Run(), TAGMFit::RunMCMC(), TLocClust::SavePajek(), TLocClustStat::SaveTxtInfo(), and TGStat::TakeStat().

                             {
  //int Edges = 0;
  //for (int N=NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
  //  Edges += NodeH[N].GetDeg();
  //}
  //return Edges/2;
  return NEdges;
}

Here is the caller graph for this function:

TEdgeI TUNGraph::GetEI

(

const int &

EId

)

const

Not supported/implemented!

TUNGraph::TEdgeI TUNGraph::GetEI	(	const int &	SrcNId,
		const int &	DstNId
	)		const

Returns an iterator referring to edge (SrcNId, DstNId) in the graph.

Note that since this is an undirected graph GetEI(SrcNId, DstNId) has the same effect as GetEI(DstNId, SrcNId).

Definition at line 114 of file graph.cpp.

References EndNI(), GetNI(), IAssert, TMath::Mn(), TMath::Mx(), MxNId, and TUNGraph::TNodeI::NodeHI.

                                                                         {
  const int MnNId = TMath::Mn(SrcNId, DstNId);
  const int MxNId = TMath::Mx(SrcNId, DstNId);
  const TNodeI SrcNI = GetNI(MnNId);
  const int NodeN = SrcNI.NodeHI.GetDat().NIdV.SearchBin(MxNId);
  IAssert(NodeN != -1);
  return TEdgeI(SrcNI, EndNI(), NodeN);
}

Here is the call graph for this function:

int TUNGraph::GetMxNId ( ) const

inline

Returns an ID that is larger than any node ID in the graph.

Definition at line 210 of file graph.h.

References MxNId.

{ return MxNId; }

TNodeI TUNGraph::GetNI ( const int &  NId ) const

inline

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

Definition at line 208 of file graph.h.

References THash< TKey, TDat, THashFunc >::GetI(), and NodeH.

Referenced by TLocClust::ApproxPageRank(), TLocClustStat::BagOfWhiskers(), TLocClustStat::BagOfWhiskers2(), TUndirFFire::BurnGeoFire(), TLocClust::DrawWhiskers(), TLocClust::FindBestCut(), TAGMUtil::GetConductance(), TLocClust::GetCutStat(), GetEI(), TLocClustStat::TCutInfo::GetFracDegOut(), TAGMUtil::GetNbhCom(), TCliqueOverlap::GetNbrs(), TCliqueOverlap::GetNodeIdWithMaxDeg(), GetRndNI(), TAGMFast::GradientForOneVar(), TAGMFast::GradientForRow(), TCesna::GradientForRow(), TAGMFast::HessianForOneVar(), TSnap::TSnapDetail::TCNMQMatrix::Init(), TAGMFit::JoinCom(), TAGMFit::LeaveCom(), TAGMFast::LikelihoodForOneVar(), TAGMFast::LikelihoodForRow(), TCesna::LikelihoodForRow(), TCliqueOverlap::MaxNbrsInCANDNodeId(), TAGMFast::MLEGradAscent(), TAGMFast::MLEGradAscentParallel(), TCesna::MLEGradAscentParallel(), TAGMFast::MLENewton(), TAGMFast::NeighborComInit(), TAGMFit::NeighborComInit(), TCesna::NeighborComInit(), TAGMFast::RandomInit(), TAGMFit::RandomInit(), TCesna::RandomInit(), TAGMFit::SeekJoin(), TAGMFit::SeekLeave(), TAGMFit::SeekSwitch(), and TLocClust::SupportSweep().

{ return TNodeI(NodeH.GetI(NId)); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::GetNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all nodes in the graph.

Definition at line 125 of file graph.cpp.

References TVec< TVal, TSizeTy >::Add(), THash< TKey, TDat, THashFunc >::FFirstKeyId(), THash< TKey, TDat, THashFunc >::FNextKeyId(), TVec< TVal, TSizeTy >::Gen(), THash< TKey, TDat, THashFunc >::GetKey(), GetNodes(), and NodeH.

Referenced by TAGMFit::AddBaseCmty(), TAGMFit::CalcPNoComByCmtyVV(), TAGMFast::FindComsByCV(), TAGMUtil::GenCmtyVVFromPL(), TAGMFast::MLENewton(), TAGMFit::NeighborComInit(), TAGMFast::SetGraph(), and TCesna::SetGraph().

                                        {
  NIdV.Gen(GetNodes(), 0);
  for (int N=NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
    NIdV.Add(NodeH.GetKey(N)); }
}

Here is the call graph for this function:

Here is the caller graph for this function:

TNode& TUNGraph::GetNode ( const int &  NId )

inlineprivate

Definition at line 140 of file graph.h.

References THash< TKey, TDat, THashFunc >::GetDat(), and NodeH.

Referenced by AddEdge(), AddNode(), DelEdge(), DelNode(), IsEdge(), and ReserveNIdDeg().

{ return NodeH.GetDat(NId); }

Here is the call graph for this function:

Here is the caller graph for this function:

const TNode& TUNGraph::GetNode ( const int &  NId ) const

inlineprivate

Definition at line 141 of file graph.h.

References THash< TKey, TDat, THashFunc >::GetDat(), and NodeH.

{ return NodeH.GetDat(NId); }

Here is the call graph for this function:

int TUNGraph::GetNodes ( ) const

inline

Returns the number of nodes in the graph.

Definition at line 165 of file graph.h.

References THash< TKey, TDat, THashFunc >::Len(), and NodeH.

Referenced by TGStatVec::Add(), TUndirFFire::AddNodes(), TLocClust::ApproxPageRank(), BegEI(), TAGMFit::CalcPNoComByCmtyVV(), TUNGraphMtx::CheckNodeIds(), TLocClust::DrawWhiskers(), Dump(), Empty(), TCesna::FindComs(), TAGMUtil::FindComsByAGM(), TAGMFast::FindComsByCV(), TAGM::GenAGM(), TCesna::GenHoldOutAttr(), TAGMFast::GetCmtyVV(), TAGMFit::GetCmtyVV(), TCesna::GetCmtyVV(), TCesna::GetCmtyVVUnSorted(), TCliqueOverlap::GetCPMCommunities(), TCliqueOverlap::GetMaximalCliques(), GetNIdV(), TLocClustStat::ImposeNCP(), TAGMFit::InitNodeData(), TAGMFast::MLEGradAscent(), TCesna::MLEGradAscent(), TAGMFast::MLEGradAscentParallel(), TCesna::MLEGradAscentParallel(), TAGMFast::MLENewton(), TAGMFast::NeighborComInit(), TAGMFit::NeighborComInit(), TCesna::NeighborComInit(), TLocClustStat::ParamStr(), TUNGraphMtx::PGetCols(), TUNGraphMtx::PGetRows(), TLocClustStat::PlotBoltzmanCurve(), TTimeNet::PlotCCfOverTm(), TTimeNet::PlotEffDiam(), TTimeNet::PlotMedianDegOverTm(), TLocClustStat::PlotNCP(), TLocClustStat::PlotNCPModul(), TLocClustStat::PlotNCPScatter(), TLocClustStat::PlotNcpTop10(), TLocClustStat::PlotPhiInOut(), TAGMFast::RandomInit(), TCesna::RandomInit(), TAGMFit::RandomInitCmtyVV(), TLocClustStat::Run(), TAGMFit::RunMCMC(), TAGMFit::SampleTransition(), TLocClust::SavePajek(), TLocClustStat::SaveTxtInfo(), TAGMFast::SetCmtyVV(), TCesna::SetCmtyVV(), TAGMFit::SetDefaultPNoCom(), TAGMFast::SetGraph(), TCesna::SetGraph(), TGStat::TakeStat(), TKronMomentsFit::Test(), and TUNGraphMtx::TUNGraphMtx().

{ return NodeH.Len(); }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TUNGraph::GetRndNI ( TRnd &  Rnd = TInt::Rnd )

inline

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

Definition at line 243 of file graph.h.

References GetNI(), and GetRndNId().

Referenced by TAGMFit::NeighborComInit().

{ return GetNI(GetRndNId(Rnd)); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TUNGraph::GetRndNId ( TRnd &  Rnd = TInt::Rnd )

inline

Returns an ID of a random node in the graph.

Definition at line 241 of file graph.h.

References THash< TKey, TDat, THashFunc >::GetKey(), THash< TKey, TDat, THashFunc >::GetRndKeyId(), and NodeH.

Referenced by GetRndNI(), TLocClustStat::Run(), and TAGMFit::SampleTransition().

{ return NodeH.GetKey(NodeH.GetRndKeyId(Rnd, 0.8)); }

Here is the call graph for this function:

Here is the caller graph for this function:

PUNGraph TUNGraph::GetSmallGraph ( )

static

Returns a small graph on 5 nodes and 5 edges.

/// Graph:   3--0--4
///            /|
///           1-2
/// 

Definition at line 193 of file graph.cpp.

References AddEdge(), AddNode(), and New().

                                 {
  PUNGraph Graph = TUNGraph::New();
  for (int i = 0; i < 5; i++) { Graph->AddNode(i); }
  Graph->AddEdge(0,1);  Graph->AddEdge(0,2);
  Graph->AddEdge(0,3);  Graph->AddEdge(0,4);
  Graph->AddEdge(1,2);
  return Graph;
}

Here is the call graph for this function:

bool TUNGraph::HasFlag

(

const TGraphFlag &

Flag

)

const

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

Definition at line 3 of file graph.cpp.

References HasGraphFlag.

                                                   {
  return HasGraphFlag(TUNGraph::TNet, Flag);
}

bool TUNGraph::IsEdge	(	const int &	SrcNId,
		const int &	DstNId
	)		const

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

Definition at line 108 of file graph.cpp.

References GetNode(), TUNGraph::TNode::IsNbrNId(), and IsNode().

Referenced by AddEdge(), TAGMFit::CalcPNoComByCmtyVV(), TSnap::GenDegSeq(), TSnap::GetEgonet(), TTimeNENet::GetTriadEdges(), TCluster::Gradient(), TAGMFast::LikelihoodHoldOut(), TCesna::LikelihoodHoldOut(), TCluster::LogLikelihood(), and TCluster::MCMC().

                                                                {
  if (! IsNode(SrcNId) || ! IsNode(DstNId)) return false;
  return GetNode(SrcNId).IsNbrNId(DstNId);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool TUNGraph::IsNode ( const int &  NId ) const

inline

Tests whether ID NId is a node.

Definition at line 202 of file graph.h.

References THash< TKey, TDat, THashFunc >::IsKey(), and NodeH.

Referenced by AddEdge(), AddNode(), TUNGraphMtx::CheckNodeIds(), DelEdge(), DelNode(), TAGM::GenAGM(), TAGMUtil::GetConductance(), TLocClust::GetCutStat(), TSnap::GetEgonet(), TTimeNENet::GetTriadEdges(), IsEdge(), IsOk(), TTimeNet::PlotMissingPast(), TAGMFit::SeekLeave(), TAGMFast::SetCmtyVV(), TAGMFit::SetCmtyVV(), TAGMFast::SetGraph(), TCesna::SetGraph(), and TGraphAttributes::TGraphAttributes().

{ return NodeH.IsKey(NId); }

Here is the call graph for this function:

Here is the caller graph for this function:

bool TUNGraph::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.

Definition at line 142 of file graph.cpp.

References BegEI(), TStr::CStr(), EAssertR, EndEI(), ErrNotify(), THash< TKey, TDat, THashFunc >::FFirstKeyId(), TStr::Fmt(), THash< TKey, TDat, THashFunc >::FNextKeyId(), TUNGraph::TNode::GetDeg(), GetEdges(), TUNGraph::TNode::GetId(), TUNGraph::TNode::GetNbrNId(), IsNode(), TVec< TVal, TSizeTy >::IsSorted(), TUNGraph::TNode::NIdV, and NodeH.

                                                 {
  bool RetVal = true;
  for (int N = NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
    const TNode& Node = NodeH[N];
    if (! Node.NIdV.IsSorted()) {
      const TStr Msg = TStr::Fmt("Neighbor list of node %d is not sorted.", Node.GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); }
      RetVal=false;
    }
    int prevNId = -1;
    for (int e = 0; e < Node.GetDeg(); e++) {
      if (! IsNode(Node.GetNbrNId(e))) {
        const TStr Msg = TStr::Fmt("Edge %d --> %d: node %d does not exist.",
          Node.GetId(), Node.GetNbrNId(e), Node.GetNbrNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); }
        RetVal=false;
      }
      if (e > 0 && prevNId == Node.GetNbrNId(e)) {
        const TStr Msg = TStr::Fmt("Node %d has duplicate edge %d --> %d.",
          Node.GetId(), Node.GetId(), Node.GetNbrNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); }
        RetVal=false;
      }
      prevNId = Node.GetNbrNId(e);
    }
  }
  int EdgeCnt = 0;
  for (TEdgeI EI = BegEI(); EI < EndEI(); EI++) { EdgeCnt++; }
  if (EdgeCnt != GetEdges()) {
    const TStr Msg = TStr::Fmt("Number of edges counter is corrupted: GetEdges():%d, EdgeCount:%d.", GetEdges(), EdgeCnt);
    if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); }
    RetVal=false;
  }
  return RetVal;
}

Here is the call graph for this function:

static PUNGraph TUNGraph::Load ( TSIn &  SIn )

inlinestatic

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

Definition at line 158 of file graph.h.

References TUNGraph().

Referenced by TAGMFit::Load(), TAGMFast::Load(), and TCesna::Load().

{ return PUNGraph(new TUNGraph(SIn)); }

Here is the call graph for this function:

Here is the caller graph for this function:

static PUNGraph TUNGraph::New ( )

inlinestatic

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

Definition at line 152 of file graph.h.

References TUNGraph().

Referenced by TCliqueOverlap::CalculateOverlapMtx(), TSnap::CmtyEvolutionFileBatch(), TAGM::GenAGM(), TSnap::GenConfModel(), TSnap::GenDegSeq(), TSnap::GenGeoPrefAttach(), TSnap::GenRewire(), TSnap::GenSmallWorld(), TSnap::Get1CnCom(), TSnap::Get1CnComSzCnt(), TSnap::GetEgonet(), GetSmallGraph(), TSnap::GetSubGraph(), TTimeNENet::GetTriadEdges(), TCesna::TCesna(), and TNetConstraint< PGraph >::Test().

{ return new TUNGraph(); }

Here is the call graph for this function:

Here is the caller graph for this function:

static PUNGraph TUNGraph::New ( const int &  Nodes, const int &  Edges  )

inlinestatic

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

Call: PUNGraph Graph = TUNGraph::New(Nodes, Edges).

Definition at line 156 of file graph.h.

References TUNGraph().

{ return new TUNGraph(Nodes, Edges); }

Here is the call graph for this function:

TUNGraph& TUNGraph::operator= ( const TUNGraph &  Graph )

inline

Definition at line 161 of file graph.h.

References MxNId, NEdges, and NodeH.

                                               {
    if (this!=&Graph) { MxNId=Graph.MxNId; NEdges=Graph.NEdges; NodeH=Graph.NodeH; } return *this; }

void TUNGraph::Reserve ( const int &  Nodes, const int &  Edges  )

inline

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

Definition at line 252 of file graph.h.

References THash< TKey, TDat, THashFunc >::Gen(), and NodeH.

Referenced by TSnap::GenConfModel(), TSnap::GenDegSeq(), TSnap::GenPrefAttach(), TSnap::GenRewire(), TSnap::GenSmallWorld(), TSnap::GetSubGraph(), and TUNGraph().

{ if (Nodes>0) NodeH.Gen(Nodes/2); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TUNGraph::ReserveNIdDeg ( const int &  NId, const int &  Deg  )

inline

Reserves memory for node ID NId having Deg edges.

Definition at line 254 of file graph.h.

References GetNode(), TUNGraph::TNode::NIdV, and TVec< TVal, TSizeTy >::Reserve().

{ GetNode(NId).NIdV.Reserve(Deg); }

Here is the call graph for this function:

void TUNGraph::Save ( TSOut &  SOut ) const

inline

Saves the graph to a (binary) stream SOut.

Definition at line 150 of file graph.h.

References MxNId, NEdges, NodeH, THash< TKey, TDat, THashFunc >::Save(), and TInt::Save().

Referenced by TAGMFit::Save(), TAGMFast::Save(), and TCesna::Save().

{ MxNId.Save(SOut); NEdges.Save(SOut); NodeH.Save(SOut); }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class TPt< TUNGraph >

friend

Definition at line 277 of file graph.h.

friend class TUNGraphMtx

friend

Definition at line 276 of file graph.h.

Member Data Documentation

TCRef TUNGraph::CRef

private

Definition at line 136 of file graph.h.

TInt TUNGraph::MxNId

private

Definition at line 137 of file graph.h.

Referenced by AddNode(), Clr(), GetEI(), GetMxNId(), operator=(), and Save().

TInt TUNGraph::NEdges

private

Definition at line 137 of file graph.h.

Referenced by AddEdge(), AddNode(), Clr(), DelEdge(), DelNode(), GetEdges(), operator=(), and Save().

THash<TInt, TNode> TUNGraph::NodeH

private

Definition at line 138 of file graph.h.

Referenced by AddNode(), BegNI(), Clr(), Defrag(), DelNode(), Dump(), EndNI(), GetNI(), GetNIdV(), GetNode(), GetNodes(), GetRndNId(), IsNode(), IsOk(), operator=(), TUNGraphMtx::PMultiply(), TUNGraphMtx::PMultiplyT(), Reserve(), and Save().

---

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

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