TUndirNet Class Reference

Undirected network. More...

#include <network.h>

Classes
class	LoadTNodeFunctor
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 TUndirNet	TNet
typedef TPt< TUndirNet >	PNet

Public Member Functions
	TUndirNet ()
	TUndirNet (const int &Nodes, const int &Edges)
	Constructor that reserves enough memory for a network of Nodes nodes and Edges edges. More...
	TUndirNet (const TUndirNet &Graph)
	TUndirNet (TSIn &SIn)
	Constructor that loads the network from a (binary) stream SIn. More...
void	Save (TSOut &SOut) const
	Saves the network to a (binary) stream SOut. Expects data structures for sparse attributes. More...
void	Save_V1 (TSOut &SOut) const
	Saves the network to a (binary) stream SOut. Available for backwards compatibility. More...
bool	HasFlag (const TGraphFlag &Flag) const
	Allows for run-time checking the type of the network (see the TGraphFlag for flags). More...
TUndirNet &	operator= (const TUndirNet &Graph)
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	AddNodeUnchecked (int NId=-1)
	Adds a node of ID NId to the network, noop if the node already exists. More...
int	AddNode (const TNodeI &NodeI)
	Adds a node of ID NodeI.GetId() to the network. More...
int	AddNode (const int &NId, const TIntV &NbrNIdV)
	Adds a node of ID NId to the network 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 network 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 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...
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	AddEdge (const int &SrcNId, const int &DstNId)
	Adds an edge between node IDs SrcNId and DstNId to the network. More...
int	AddEdgeUnchecked (const int &SrcNId, const int &DstNId)
	Adds an edge between node IDs SrcNId and DstNId to the network. More...
int	AddEdge (const TEdgeI &EdgeI)
	Adds an edge between EdgeI.GetSrcNId() and EdgeI.GetDstNId() to the network. More...
void	DelEdge (const int &SrcNId, const int &DstNId)
	Deletes an edge between node IDs SrcNId and DstNId from the network. More...
bool	IsEdge (const int &SrcNId, const int &DstNId) const
	Tests whether an edge between node IDs SrcNId and DstNId exists in the network. More...
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 network. 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...
void	GetNIdV (TIntV &NIdV) const
	Gets a vector IDs of all nodes 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	ReserveNIdDeg (const int &NId, const int &Deg)
	Reserves memory for node ID NId having Deg edges. More...
void	SortNodeAdjV ()
	Sorts the adjacency lists of each node. 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...
void	Dump (FILE *OutF=stdout) const
	Print the network in a human readable form to an output stream OutF. More...
int	AddSAttrDatN (const TInt &NId, const TStr &AttrName, const TInt &Val)
	Adds Int sparse attribute with name AttrName to the given node with id NId. More...
int	AddSAttrDatN (const TInt &NId, const TInt &AttrId, const TInt &Val)
	Adds Int sparse attribute with id AttrId to the given node with id NId. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, const TInt &Val)
	Adds Int sparse attribute with name AttrName to NodeI. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, const TInt &Val)
	Adds Int sparse attribute with id AttrId to NodeI. More...
int	AddSAttrDatN (const TInt &NId, const TStr &AttrName, const TFlt &Val)
	Adds Flt sparse attribute with name AttrName to the given node with id NId. More...
int	AddSAttrDatN (const TInt &NId, const TInt &AttrId, const TFlt &Val)
	Adds Flt sparse attribute with id AttrId to the given node with id NId. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, const TFlt &Val)
	Adds Flt sparse attribute with name AttrName to NodeI. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, const TFlt &Val)
	Adds Flt sparse attribute with id AttrId to NodeI. More...
int	AddSAttrDatN (const TInt &NId, const TStr &AttrName, const TStr &Val)
	Adds Str sparse attribute with name AttrName to the given node with id NId. More...
int	AddSAttrDatN (const TInt &NId, const TInt &AttrId, const TStr &Val)
	Adds Str sparse attribute with id AttrId to the given node with id NId. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, const TStr &Val)
	Adds Str sparse attribute with name AttrName to NodeI. More...
int	AddSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, const TStr &Val)
	Adds Str sparse attribute with id AttrId to NodeI. More...
int	GetSAttrDatN (const TInt &NId, const TStr &AttrName, TInt &ValX) const
	Gets Int sparse attribute with name AttrName from node with id NId. More...
int	GetSAttrDatN (const TInt &NId, const TInt &AttrId, TInt &ValX) const
	Gets Int sparse attribute with id AttrId from node with id NId. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, TInt &ValX) const
	Gets Int sparse attribute with name AttrName from NodeI. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, TInt &ValX) const
	Gets Int sparse attribute with id AttrId from NodeI. More...
int	GetSAttrDatN (const TInt &NId, const TStr &AttrName, TFlt &ValX) const
	Gets Flt sparse attribute with name AttrName from node with id NId. More...
int	GetSAttrDatN (const TInt &NId, const TInt &AttrId, TFlt &ValX) const
	Gets Flt sparse attribute with id AttrId from node with id NId. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, TFlt &ValX) const
	Gets Flt sparse attribute with name AttrName from NodeI. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, TFlt &ValX) const
	Gets Flt sparse attribute with id AttrId from NodeI. More...
int	GetSAttrDatN (const TInt &NId, const TStr &AttrName, TStr &ValX) const
	Gets Str sparse attribute with name AttrName from node with id NId. More...
int	GetSAttrDatN (const TInt &NId, const TInt &AttrId, TStr &ValX) const
	Gets Str sparse attribute with id AttrId from node with id NId. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TStr &AttrName, TStr &ValX) const
	Gets Str sparse attribute with name AttrName from NodeI. More...
int	GetSAttrDatN (const TNodeI &NodeI, const TInt &AttrId, TStr &ValX) const
	Gets Str sparse attribute with id AttrId from NodeI. More...
int	DelSAttrDatN (const TInt &NId, const TStr &AttrName)
	Deletes sparse attribute with name AttrName from node with id NId. More...
int	DelSAttrDatN (const TInt &NId, const TInt &AttrId)
	Deletes sparse attribute with id AttrId from node with id NId. More...
int	DelSAttrDatN (const TNodeI &NodeI, const TStr &AttrName)
	Deletes sparse attribute with name AttrName from NodeI. More...
int	DelSAttrDatN (const TNodeI &NodeI, const TInt &AttrId)
	Deletes sparse attribute with id AttrId from NodeI. More...
int	GetSAttrVN (const TInt &NId, const TAttrType AttrType, TAttrPrV &AttrV) const
	Gets a list of all sparse attributes of type AttrType for node with id NId. More...
int	GetSAttrVN (const TNodeI &NodeI, const TAttrType AttrType, TAttrPrV &AttrV) const
	Gets a list of all sparse attributes of type AttrType for NodeI. More...
int	GetIdVSAttrN (const TStr &AttrName, TIntV &IdV) const
	Gets a list of all nodes that have a sparse attribute with name AttrName. More...
int	GetIdVSAttrN (const TInt &AttrId, TIntV &IdV) const
	Gets a list of all nodes that have a sparse attribute with id AttrId. More...
int	AddSAttrN (const TStr &Name, const TAttrType &AttrType, TInt &AttrId)
	Adds mapping for sparse attribute with name Name and type AttrType. More...
int	GetSAttrIdN (const TStr &Name, TInt &AttrIdX, TAttrType &AttrTypeX) const
	Gets id and type for attribute with name Name. More...
int	GetSAttrNameN (const TInt &AttrId, TStr &NameX, TAttrType &AttrTypeX) const
	Gets name and type for attribute with id AttrId. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, const TInt &Val)
	Adds Int sparse attribute with name AttrName to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, const TInt &Val)
	Adds Int sparse attribute with id AttrId to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, const TInt &Val)
	Adds Int sparse attribute with name AttrName to EdgeI. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, const TInt &Val)
	Adds Int sparse attribute with id AttrId to EdgeI. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, const TFlt &Val)
	Adds Flt sparse attribute with name AttrName to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, const TFlt &Val)
	Adds Flt sparse attribute with id AttrId to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, const TFlt &Val)
	Adds Flt sparse attribute with name AttrName to EdgeI. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, const TFlt &Val)
	Adds Flt sparse attribute with id AttrId to EdgeI. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, const TStr &Val)
	Adds Str sparse attribute with name AttrName to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, const TStr &Val)
	Adds Str sparse attribute with id AttrId to the given edge with ids SrcId and DstId. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, const TStr &Val)
	Adds Str sparse attribute with name AttrName to EdgeI. More...
int	AddSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, const TStr &Val)
	Adds Str sparse attribute with id AttrId to EdgeI. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, TInt &ValX) const
	Gets Int sparse attribute with name AttrName from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, TInt &ValX) const
	Gets Int sparse attribute with id AttrId from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, TInt &ValX) const
	Gets Int sparse attribute with name AttrName from EdgeI. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, TInt &ValX) const
	Gets Int sparse attribute with id AttrId from EdgeI. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, TFlt &ValX) const
	Gets Flt sparse attribute with name AttrName from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, TFlt &ValX) const
	Gets Flt sparse attribute with id AttrId from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, TFlt &ValX) const
	Gets Flt sparse attribute with name AttrName from EdgeI. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, TFlt &ValX) const
	Gets Flt sparse attribute with id AttrId from EdgeI. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName, TStr &ValX) const
	Gets Str sparse attribute with name AttrName from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId, TStr &ValX) const
	Gets Str sparse attribute with id AttrId from edge with ids SrcId and DstId. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName, TStr &ValX) const
	Gets Str sparse attribute with name AttrName from EdgeI. More...
int	GetSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId, TStr &ValX) const
	Gets Str sparse attribute with id AttrId from EdgeI. More...
int	DelSAttrDatE (const int &SrcNId, const int &DstNId, const TStr &AttrName)
	Deletes sparse attribute with name AttrName from edge with ids SrcId and DstId. More...
int	DelSAttrDatE (const int &SrcNId, const int &DstNId, const TInt &AttrId)
	Deletes sparse attribute with id AttrId from edge with ids SrcId and DstId. More...
int	DelSAttrDatE (const TEdgeI &EdgeI, const TStr &AttrName)
	Deletes sparse attribute with name AttrName from EdgeI. More...
int	DelSAttrDatE (const TEdgeI &EdgeI, const TInt &AttrId)
	Deletes sparse attribute with id AttrId from EdgeI. More...
int	GetSAttrVE (const int &SrcNId, const int &DstNId, const TAttrType AttrType, TAttrPrV &AttrV) const
	Gets a list of all sparse attributes of type AttrType for edge with ids SrcId and DstId. More...
int	GetSAttrVE (const TEdgeI &EdgeI, const TAttrType AttrType, TAttrPrV &AttrV) const
	Gets a list of all sparse attributes of type AttrType for EdgeI. More...
int	GetIdVSAttrE (const TStr &AttrName, TIntPrV &IdV) const
	Gets a list of all edges that have a sparse attribute with name AttrName. More...
int	GetIdVSAttrE (const TInt &AttrId, TIntPrV &IdV) const
	Gets a list of all edges that have a sparse attribute with id AttrId. More...
int	AddSAttrE (const TStr &Name, const TAttrType &AttrType, TInt &AttrId)
	Adds mapping for sparse attribute with name Name and type AttrType. More...
int	GetSAttrIdE (const TStr &Name, TInt &AttrIdX, TAttrType &AttrTypeX) const
	Gets id and type for attribute with name Name. More...
int	GetSAttrNameE (const TInt &AttrId, TStr &NameX, TAttrType &AttrTypeX) const
	Gets name and type for attribute with id AttrId. More...

Static Public Member Functions
static PUndirNet	New ()
	Static constructor that returns a pointer to the network. Call: PUndirNet Graph = TUndirNet::New(). More...
static PUndirNet	New (const int &Nodes, const int &Edges)
	Static constructor that returns a pointer to the network and reserves enough memory for Nodes nodes and Edges edges. More...
static PUndirNet	Load (TSIn &SIn)
	Static constructor that loads the network from a stream SIn and returns a pointer to it. More...
static PUndirNet	Load_V1 (TSIn &SIn)
	Static constructor that loads the network from a stream SIn and returns a pointer to it. Backwards compatible. More...
static PUndirNet	LoadShM (TShMIn &ShMIn)
	Static constructor that loads the network from memory. More...
static PUndirNet	GetSmallGraph ()
	Returns a small network on 5 nodes and 5 edges. More...

Private Member Functions
TNode &	GetNode (const int &NId)
const TNode &	GetNode (const int &NId) const
TIntPr	OrderEdgeNodes (const int &SrcNId, const int &DstNId) const
void	LoadNetworkShM (TShMIn &ShMIn)

Private Attributes
TCRef	CRef
TInt	MxNId
TInt	NEdges
THash< TInt, TNode >	NodeH
TAttr	SAttrN
TAttrPair	SAttrE

Friends
class	TUndirNetMtx
class	TPt< TUndirNet >

Detailed Description

Undirected network.

Node IDs can be arbitrary non-negative integers. Nodes and edges can have sparse 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 3145 of file network.h.

Member Typedef Documentation

typedef TPt<TUndirNet> TUndirNet::PNet

Definition at line 3148 of file network.h.

typedef TUndirNet TUndirNet::TNet

Definition at line 3147 of file network.h.

Constructor & Destructor Documentation

TUndirNet::TUndirNet ( )

inline

Definition at line 3282 of file network.h.

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

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

inlineexplicit

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

Definition at line 3284 of file network.h.

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

TUndirNet::TUndirNet ( const TUndirNet &  Graph )

inline

Definition at line 3285 of file network.h.

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

TUndirNet::TUndirNet ( TSIn &  SIn )

inline

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

Definition at line 3288 of file network.h.

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

Member Function Documentation

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

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

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 TUndirNet have no IDs we return -1. The function aborts if SrcNId or DstNId are not nodes in the graph.

Definition at line 1891 of file network.cpp.

                                                           {
  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; // no edge id
}

int TUndirNet::AddEdge ( const TEdgeI &  EdgeI )

inline

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

Definition at line 3398 of file network.h.

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

int TUndirNet::AddEdgeUnchecked	(	const int &	SrcNId,
		const int &	DstNId
	)

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

Returns -1. The method assumes that SrcNId and DstNId are existing nodes in the graph and adds new neighbor values at the end of their adjacency vectors. No checks are performed to verify these assumptions. Adjacency vectors must be sorted and have duplicates removed after a sequence of these operations to assure consistency of data structures.

Definition at line 1902 of file network.cpp.

                                                                    {
  GetNode(SrcNId).NIdV.Add(DstNId);
  if (SrcNId!=DstNId) { // not a self edge
    GetNode(DstNId).NIdV.Add(SrcNId); }
  NEdges++;
  return -1; // no edge id
}

int TUndirNet::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 1802 of file network.cpp.

                              {
  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;
}

int TUndirNet::AddNode ( const TNodeI &  NodeI )

inline

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

Definition at line 3338 of file network.h.

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

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

Adds a node of ID NId to the network 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 TUndirNet::IsOk to check that the resulting graph is consistent after the operation.

Definition at line 1825 of file network.cpp.

                                                           {
  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;
}

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

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

//int& NIdVId) 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 TUndirNet::IsOk to check that the resulting graph is consistent.

Definition at line 1846 of file network.cpp.

                                                                                    {
  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;
}

int TUndirNet::AddNodeUnchecked

(

int

NId = -1

)

Adds a node of ID NId to the network, noop if the node already exists.

Returns -1, if the node NId already exists. Otherwise, it returns the ID of the node being added. If NId is -1, node ID is automatically assigned.

Definition at line 1813 of file network.cpp.

                                       {
  if (NId == -1) {
    NId = MxNId;  MxNId++;
  } else {
    if (IsNode(NId)) { return -1;}
    MxNId = TMath::Mx(NId+1, MxNId());
  }
  NodeH.AddDat(NId, TNode(NId));
  return NId;
}

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		const TInt &	Val
	)

Adds Int sparse attribute with name AttrName to the given edge with ids SrcId and DstId.

Definition at line 2153 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrName, Val);
}

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		const TInt &	Val
	)

Adds Int sparse attribute with id AttrId to the given edge with ids SrcId and DstId.

Definition at line 2161 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrId, Val);
}

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, const TInt &  Val  )

inline

Adds Int sparse attribute with name AttrName to EdgeI.

Definition at line 3583 of file network.h.

                                                                               {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, const TInt &  Val  )

inline

Adds Int sparse attribute with id AttrId to EdgeI.

Definition at line 3587 of file network.h.

                                                                             {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, Val);
  }

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		const TFlt &	Val
	)

Adds Flt sparse attribute with name AttrName to the given edge with ids SrcId and DstId.

Definition at line 2169 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrName, Val);
}

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		const TFlt &	Val
	)

Adds Flt sparse attribute with id AttrId to the given edge with ids SrcId and DstId.

Definition at line 2177 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrId, Val);
}

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, const TFlt &  Val  )

inline

Adds Flt sparse attribute with name AttrName to EdgeI.

Definition at line 3597 of file network.h.

                                                                               {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, const TFlt &  Val  )

inline

Adds Flt sparse attribute with id AttrId to EdgeI.

Definition at line 3601 of file network.h.

                                                                            {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, Val);
  }

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		const TStr &	Val
	)

Adds Str sparse attribute with name AttrName to the given edge with ids SrcId and DstId.

Definition at line 2185 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrName, Val);
}

int TUndirNet::AddSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		const TStr &	Val
	)

Adds Str sparse attribute with id AttrId to the given edge with ids SrcId and DstId.

Definition at line 2193 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.AddSAttrDat(EId, AttrId, Val);
}

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, const TStr &  Val  )

inline

Adds Str sparse attribute with name AttrName to EdgeI.

Definition at line 3611 of file network.h.

                                                                               {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, const TStr &  Val  )

inline

Adds Str sparse attribute with id AttrId to EdgeI.

Definition at line 3615 of file network.h.

                                                                             {
    return AddSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, Val);
  }

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		const TInt &	Val
	)

Adds Int sparse attribute with name AttrName to the given node with id NId.

Definition at line 2020 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrName, Val);
}

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		const TInt &	Val
	)

Adds Int sparse attribute with id AttrId to the given node with id NId.

Definition at line 2027 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrId, Val);
}

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, const TInt &  Val  )

inline

Adds Int sparse attribute with name AttrName to NodeI.

Definition at line 3465 of file network.h.

                                                                               {
    return AddSAttrDatN(NodeI.GetId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, const TInt &  Val  )

inline

Adds Int sparse attribute with id AttrId to NodeI.

Definition at line 3469 of file network.h.

                                                                             {
    return AddSAttrDatN(NodeI.GetId(), AttrId, Val);
  }

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		const TFlt &	Val
	)

Adds Flt sparse attribute with name AttrName to the given node with id NId.

Definition at line 2034 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrName, Val);
}

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		const TFlt &	Val
	)

Adds Flt sparse attribute with id AttrId to the given node with id NId.

Definition at line 2041 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrId, Val);
}

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, const TFlt &  Val  )

inline

Adds Flt sparse attribute with name AttrName to NodeI.

Definition at line 3479 of file network.h.

                                                                               {
    return AddSAttrDatN(NodeI.GetId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, const TFlt &  Val  )

inline

Adds Flt sparse attribute with id AttrId to NodeI.

Definition at line 3483 of file network.h.

                                                                             {
    return AddSAttrDatN(NodeI.GetId(), AttrId, Val);
  }

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		const TStr &	Val
	)

Adds Str sparse attribute with name AttrName to the given node with id NId.

Definition at line 2048 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrName, Val);
}

int TUndirNet::AddSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		const TStr &	Val
	)

Adds Str sparse attribute with id AttrId to the given node with id NId.

Definition at line 2055 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.AddSAttrDat(NId, AttrId, Val);
}

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, const TStr &  Val  )

inline

Adds Str sparse attribute with name AttrName to NodeI.

Definition at line 3493 of file network.h.

                                                                               {
    return AddSAttrDatN(NodeI.GetId(), AttrName, Val);
  }

int TUndirNet::AddSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, const TStr &  Val  )

inline

Adds Str sparse attribute with id AttrId to NodeI.

Definition at line 3497 of file network.h.

                                                                             {
    return AddSAttrDatN(NodeI.GetId(), AttrId, Val);
  }

int TUndirNet::AddSAttrE	(	const TStr &	Name,
		const TAttrType &	AttrType,
		TInt &	AttrId
	)

Adds mapping for sparse attribute with name Name and type AttrType.

Definition at line 2282 of file network.cpp.

                                                                                  {
  return SAttrE.AddSAttr(Name, AttrType, AttrId);
}

int TUndirNet::AddSAttrN	(	const TStr &	Name,
		const TAttrType &	AttrType,
		TInt &	AttrId
	)

Adds mapping for sparse attribute with name Name and type AttrType.

Definition at line 2134 of file network.cpp.

                                                                                  {
  return SAttrN.AddSAttr(Name, AttrType, AttrId);
}

TEdgeI TUndirNet::BegEI ( ) const

inline

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

Definition at line 3408 of file network.h.

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

TNodeI TUndirNet::BegNI ( ) const

inline

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

Definition at line 3370 of file network.h.

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

void TUndirNet::Clr ( )

inline

Deletes all nodes and edges from the network.

Definition at line 3429 of file network.h.

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

void TUndirNet::Defrag

(

const bool &

OnlyNodeLinks = false

)

Defragments the network.

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 1950 of file network.cpp.

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

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

Deletes an edge between node IDs SrcNId and DstNId from the network.

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 1911 of file network.cpp.

                                                            {
  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);
  TIntPr Id(SrcNId, DstNId);
  SAttrE.DelSAttrId(Id);
  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); }
  }
}

void TUndirNet::DelNode

(

const int &

NId

)

Deletes node of ID NId from the network.

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

Definition at line 1864 of file network.cpp.

                                      {
  { AssertR(IsNode(NId), TStr::Fmt("NodeId %d does not exist", NId));
  TInt Id(NId);
  SAttrN.DelSAttrId(Id);
  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);
}

void TUndirNet::DelNode ( const TNode &  NodeI )

inline

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

Definition at line 3366 of file network.h.

{ DelNode(NodeI.GetId()); }

int TUndirNet::DelSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName
	)

Deletes sparse attribute with name AttrName from edge with ids SrcId and DstId.

Definition at line 2249 of file network.cpp.

                                                                                      {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.DelSAttrDat(EId, AttrName);
}

int TUndirNet::DelSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId
	)

Deletes sparse attribute with id AttrId from edge with ids SrcId and DstId.

Definition at line 2257 of file network.cpp.

                                                                                    {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.DelSAttrDat(EId, AttrId);
}

int TUndirNet::DelSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName  )

inline

Deletes sparse attribute with name AttrName from EdgeI.

Definition at line 3667 of file network.h.

                                                              {
    return DelSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName);
  }

int TUndirNet::DelSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId  )

inline

Deletes sparse attribute with id AttrId from EdgeI.

Definition at line 3671 of file network.h.

                                                            {
    return DelSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId);
  } 

int TUndirNet::DelSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName
	)

Deletes sparse attribute with name AttrName from node with id NId.

Definition at line 2104 of file network.cpp.

                                                                 {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.DelSAttrDat(NId, AttrName);
}

int TUndirNet::DelSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId
	)

Deletes sparse attribute with id AttrId from node with id NId.

Definition at line 2111 of file network.cpp.

                                                               {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.DelSAttrDat(NId, AttrId);
}

int TUndirNet::DelSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName  )

inline

Deletes sparse attribute with name AttrName from NodeI.

Definition at line 3549 of file network.h.

                                                              {
    return DelSAttrDatN(NodeI.GetId(), AttrName);
  }

int TUndirNet::DelSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId  )

inline

Deletes sparse attribute with id AttrId from NodeI.

Definition at line 3553 of file network.h.

                                                            {
    return DelSAttrDatN(NodeI.GetId(), AttrId);
  }

void TUndirNet::Dump

(

FILE *

OutF = stdout

)

const

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

Definition at line 1997 of file network.cpp.

                                     {
  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");
}

bool TUndirNet::Empty ( ) const

inline

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

Definition at line 3427 of file network.h.

{ return GetNodes()==0; }

TEdgeI TUndirNet::EndEI ( ) const

inline

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

Definition at line 3410 of file network.h.

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

TNodeI TUndirNet::EndNI ( ) const

inline

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

Definition at line 3372 of file network.h.

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

int TUndirNet::GetEdges

(

)

const

Returns the number of edges in the network.

Definition at line 1881 of file network.cpp.

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

TEdgeI TUndirNet::GetEI

(

const int &

EId

)

const

Not supported/implemented!

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

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

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

Definition at line 1932 of file network.cpp.

                                                                           {
  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);
}

int TUndirNet::GetIdVSAttrE	(	const TStr &	AttrName,
		TIntPrV &	IdV
	)		const

Gets a list of all edges that have a sparse attribute with name AttrName.

Definition at line 2274 of file network.cpp.

                                                                    {
  return SAttrE.GetIdVSAttr(AttrName, IdV);
}

int TUndirNet::GetIdVSAttrE	(	const TInt &	AttrId,
		TIntPrV &	IdV
	)		const

Gets a list of all edges that have a sparse attribute with id AttrId.

Definition at line 2278 of file network.cpp.

                                                                  {
  return SAttrE.GetIdVSAttr(AttrId, IdV);
}

int TUndirNet::GetIdVSAttrN	(	const TStr &	AttrName,
		TIntV &	IdV
	)		const

Gets a list of all nodes that have a sparse attribute with name AttrName.

Definition at line 2126 of file network.cpp.

                                                                  {
  return SAttrN.GetIdVSAttr(AttrName, IdV);
}

int TUndirNet::GetIdVSAttrN	(	const TInt &	AttrId,
		TIntV &	IdV
	)		const

Gets a list of all nodes that have a sparse attribute with id AttrId.

Definition at line 2130 of file network.cpp.

                                                                {
  return SAttrN.GetIdVSAttr(AttrId, IdV);
}

int TUndirNet::GetMxNId ( ) const

inline

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

Definition at line 3376 of file network.h.

{ return MxNId; }

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

inline

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

Definition at line 3374 of file network.h.

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

void TUndirNet::GetNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all nodes in the network.

Definition at line 1943 of file network.cpp.

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

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

inlineprivate

Definition at line 3263 of file network.h.

{ return NodeH.GetDat(NId); }

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

inlineprivate

Definition at line 3264 of file network.h.

{ return NodeH.GetDat(NId); }

int TUndirNet::GetNodes ( ) const

inline

Returns the number of nodes in the network.

Definition at line 3324 of file network.h.

{ return NodeH.Len(); }

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

inline

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

Definition at line 3422 of file network.h.

{ return GetNI(GetRndNId(Rnd)); }

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

inline

Returns an ID of a random node in the network.

Definition at line 3420 of file network.h.

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

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		TInt &	ValX
	)		const

Gets Int sparse attribute with name AttrName from edge with ids SrcId and DstId.

Definition at line 2201 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrName, Val);
}

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		TInt &	ValX
	)		const

Gets Int sparse attribute with id AttrId from edge with ids SrcId and DstId.

Definition at line 2209 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrId, Val);
}

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, TInt &  ValX  ) const

inline

Gets Int sparse attribute with name AttrName from EdgeI.

Definition at line 3625 of file network.h.

                                                                                {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, ValX);
  }

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, TInt &  ValX  ) const

inline

Gets Int sparse attribute with id AttrId from EdgeI.

Definition at line 3629 of file network.h.

                                                                              {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, ValX);
  } 

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		TFlt &	ValX
	)		const

Gets Flt sparse attribute with name AttrName from edge with ids SrcId and DstId.

Definition at line 2217 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrName, Val);
}

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		TFlt &	ValX
	)		const

Gets Flt sparse attribute with id AttrId from edge with ids SrcId and DstId.

Definition at line 2225 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrId, Val);
}

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, TFlt &  ValX  ) const

inline

Gets Flt sparse attribute with name AttrName from EdgeI.

Definition at line 3639 of file network.h.

                                                                                {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, ValX);
  }

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, TFlt &  ValX  ) const

inline

Gets Flt sparse attribute with id AttrId from EdgeI.

Definition at line 3643 of file network.h.

                                                                              {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, ValX);
  } 

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TStr &	AttrName,
		TStr &	ValX
	)		const

Gets Str sparse attribute with name AttrName from edge with ids SrcId and DstId.

Definition at line 2233 of file network.cpp.

                                                                                                       {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrName, Val);
}

int TUndirNet::GetSAttrDatE	(	const int &	SrcNId,
		const int &	DstNId,
		const TInt &	AttrId,
		TStr &	ValX
	)		const

Gets Str sparse attribute with id AttrId from edge with ids SrcId and DstId.

Definition at line 2241 of file network.cpp.

                                                                                                     {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  return SAttrE.GetSAttrDat(EId, AttrId, Val);
}

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TStr &  AttrName, TStr &  ValX  ) const

inline

Gets Str sparse attribute with name AttrName from EdgeI.

Definition at line 3653 of file network.h.

                                                                                {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrName, ValX);
  }

int TUndirNet::GetSAttrDatE ( const TEdgeI &  EdgeI, const TInt &  AttrId, TStr &  ValX  ) const

inline

Gets Str sparse attribute with id AttrId from EdgeI.

Definition at line 3657 of file network.h.

                                                                              {
    return GetSAttrDatE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrId, ValX);
  }

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		TInt &	ValX
	)		const

Gets Int sparse attribute with name AttrName from node with id NId.

Definition at line 2062 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrName, Val);
}

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		TInt &	ValX
	)		const

Gets Int sparse attribute with id AttrId from node with id NId.

Definition at line 2069 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrId, Val);
}

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, TInt &  ValX  ) const

inline

Gets Int sparse attribute with name AttrName from NodeI.

Definition at line 3507 of file network.h.

                                                                                {
    return GetSAttrDatN(NodeI.GetId(), AttrName, ValX);
  }

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, TInt &  ValX  ) const

inline

Gets Int sparse attribute with id AttrId from NodeI.

Definition at line 3511 of file network.h.

                                                                              {
    return GetSAttrDatN(NodeI.GetId(), AttrId, ValX);
  }

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		TFlt &	ValX
	)		const

Gets Flt sparse attribute with name AttrName from node with id NId.

Definition at line 2076 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrName, Val);
}

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		TFlt &	ValX
	)		const

Gets Flt sparse attribute with id AttrId from node with id NId.

Definition at line 2083 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrId, Val);
}

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, TFlt &  ValX  ) const

inline

Gets Flt sparse attribute with name AttrName from NodeI.

Definition at line 3521 of file network.h.

                                                                                {
    return GetSAttrDatN(NodeI.GetId(), AttrName, ValX);
  } 

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, TFlt &  ValX  ) const

inline

Gets Flt sparse attribute with id AttrId from NodeI.

Definition at line 3525 of file network.h.

                                                                              {
    return GetSAttrDatN(NodeI.GetId(), AttrId, ValX);
  }

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TStr &	AttrName,
		TStr &	ValX
	)		const

Gets Str sparse attribute with name AttrName from node with id NId.

Definition at line 2090 of file network.cpp.

                                                                                  {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrName, Val);
}

int TUndirNet::GetSAttrDatN	(	const TInt &	NId,
		const TInt &	AttrId,
		TStr &	ValX
	)		const

Gets Str sparse attribute with id AttrId from node with id NId.

Definition at line 2097 of file network.cpp.

                                                                                {
  if (!IsNode(NId)) {
    return -1;
  }
  return SAttrN.GetSAttrDat(NId, AttrId, Val);
}

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TStr &  AttrName, TStr &  ValX  ) const

inline

Gets Str sparse attribute with name AttrName from NodeI.

Definition at line 3535 of file network.h.

                                                                                {
    return GetSAttrDatN(NodeI.GetId(), AttrName, ValX);
  }

int TUndirNet::GetSAttrDatN ( const TNodeI &  NodeI, const TInt &  AttrId, TStr &  ValX  ) const

inline

Gets Str sparse attribute with id AttrId from NodeI.

Definition at line 3539 of file network.h.

                                                                              {
    return GetSAttrDatN(NodeI.GetId(), AttrId, ValX);
  }

int TUndirNet::GetSAttrIdE	(	const TStr &	Name,
		TInt &	AttrIdX,
		TAttrType &	AttrTypeX
	)		const

Gets id and type for attribute with name Name.

Definition at line 2286 of file network.cpp.

                                                                                    {
  return SAttrE.GetSAttrId(Name, AttrId, AttrType);
}

int TUndirNet::GetSAttrIdN	(	const TStr &	Name,
		TInt &	AttrIdX,
		TAttrType &	AttrTypeX
	)		const

Gets id and type for attribute with name Name.

Definition at line 2138 of file network.cpp.

                                                                                    {
  return SAttrN.GetSAttrId(Name, AttrId, AttrType);
}

int TUndirNet::GetSAttrNameE	(	const TInt &	AttrId,
		TStr &	NameX,
		TAttrType &	AttrTypeX
	)		const

Gets name and type for attribute with id AttrId.

Definition at line 2290 of file network.cpp.

                                                                                      {
  return SAttrE.GetSAttrName(AttrId, Name, AttrType);
}

int TUndirNet::GetSAttrNameN	(	const TInt &	AttrId,
		TStr &	NameX,
		TAttrType &	AttrTypeX
	)		const

Gets name and type for attribute with id AttrId.

Definition at line 2142 of file network.cpp.

                                                                                      {
  return SAttrN.GetSAttrName(AttrId, Name, AttrType);
}

int TUndirNet::GetSAttrVE	(	const int &	SrcNId,
		const int &	DstNId,
		const TAttrType	AttrType,
		TAttrPrV &	AttrV
	)		const

Gets a list of all sparse attributes of type AttrType for edge with ids SrcId and DstId.

Definition at line 2265 of file network.cpp.

                                                                                                               {
  if (!IsEdge(SrcNId, DstNId)) {
    return -1;
  }
  TIntPr EId = OrderEdgeNodes(SrcNId, DstNId);
  SAttrE.GetSAttrV(EId, AttrType, AttrV);
  return 0;
}

int TUndirNet::GetSAttrVE ( const TEdgeI &  EdgeI, const TAttrType  AttrType, TAttrPrV &  AttrV  ) const

inline

Gets a list of all sparse attributes of type AttrType for EdgeI.

Definition at line 3677 of file network.h.

                                                                                       {
    return GetSAttrVE(EdgeI.GetSrcNId(), EdgeI.GetDstNId(), AttrType, AttrV);
  }

int TUndirNet::GetSAttrVN	(	const TInt &	NId,
		const TAttrType	AttrType,
		TAttrPrV &	AttrV
	)		const

Gets a list of all sparse attributes of type AttrType for node with id NId.

Definition at line 2118 of file network.cpp.

                                                                                          {
  if (!IsNode(NId)) {
    return -1;
  }
  SAttrN.GetSAttrV(NId, AttrType, AttrV);
  return 0;
}

int TUndirNet::GetSAttrVN ( const TNodeI &  NodeI, const TAttrType  AttrType, TAttrPrV &  AttrV  ) const

inline

Gets a list of all sparse attributes of type AttrType for NodeI.

Definition at line 3560 of file network.h.

                                                                                       {
    return GetSAttrVN(NodeI.GetId(), AttrType, AttrV);
  }

PUndirNet TUndirNet::GetSmallGraph ( )

static

Returns a small network on 5 nodes and 5 edges.

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

Definition at line 2011 of file network.cpp.

                                   {
  PUndirNet Graph = TUndirNet::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;
}

bool TUndirNet::HasFlag

(

const TGraphFlag &

Flag

)

const

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

Definition at line 1797 of file network.cpp.

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

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

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

Definition at line 1926 of file network.cpp.

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

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

inline

Tests whether ID NId is a node.

Definition at line 3368 of file network.h.

{ return NodeH.IsKey(NId); }

bool TUndirNet::IsOk

(

const bool &

ThrowExcept = true

)

const

Checks the network data structure for internal consistency.

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

Definition at line 1960 of file network.cpp.

                                                  {
  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;
}

static PUndirNet TUndirNet::Load ( TSIn &  SIn )

inlinestatic

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

Definition at line 3301 of file network.h.

{ return PUndirNet(new TUndirNet(SIn)); }

static PUndirNet TUndirNet::Load_V1 ( TSIn &  SIn )

inlinestatic

Static constructor that loads the network from a stream SIn and returns a pointer to it. Backwards compatible.

Definition at line 3303 of file network.h.

                                      { PUndirNet Graph = PUndirNet(new TUndirNet());
    Graph->MxNId.Load(SIn); Graph->NEdges.Load(SIn); Graph->NodeH.Load(SIn); return Graph;
  }

void TUndirNet::LoadNetworkShM ( TShMIn &  ShMIn )

inlineprivate

Definition at line 3273 of file network.h.

                                     {
    MxNId = TInt(ShMIn);
    NEdges = TInt(ShMIn);
    LoadTNodeFunctor NodeFn;
    NodeH.LoadShM(ShMIn, NodeFn);
    SAttrN.Load(ShMIn);
    SAttrE = TAttrPair(ShMIn);
  }

static PUndirNet TUndirNet::LoadShM ( TShMIn &  ShMIn )

inlinestatic

Static constructor that loads the network from memory.

The object is read-only. It does not support operations that edit the edge vectors of nodes or perform illegal operations on the NodeH, EdgeH (deletion or swapping keys).

Definition at line 3312 of file network.h.

                                          {
    TUndirNet* Network = new TUndirNet();
    Network->LoadNetworkShM(ShMIn);
    return PUndirNet(Network);
  }

static PUndirNet TUndirNet::New ( )

inlinestatic

Static constructor that returns a pointer to the network. Call: PUndirNet Graph = TUndirNet::New().

Definition at line 3295 of file network.h.

{ return new TUndirNet(); }

static PUndirNet TUndirNet::New ( const int &  Nodes, const int &  Edges  )

inlinestatic

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

Call: PUndirNet Net = TUndirNet::New(Nodes, Edges).

Definition at line 3299 of file network.h.

{ return new TUndirNet(Nodes, Edges); }

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

inline

Definition at line 3320 of file network.h.

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

TIntPr TUndirNet::OrderEdgeNodes ( const int &  SrcNId, const int &  DstNId  ) const

private

Definition at line 2146 of file network.cpp.

                                                                          {
  if (SrcNId < DstNId) {
    return TIntPr(SrcNId, DstNId);
  }
  return TIntPr(DstNId, SrcNId);
}

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

inline

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

Definition at line 3431 of file network.h.

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

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

inline

Reserves memory for node ID NId having Deg edges.

Definition at line 3433 of file network.h.

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

void TUndirNet::Save ( TSOut &  SOut ) const

inline

Saves the network to a (binary) stream SOut. Expects data structures for sparse attributes.

Definition at line 3290 of file network.h.

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

void TUndirNet::Save_V1 ( TSOut &  SOut ) const

inline

Saves the network to a (binary) stream SOut. Available for backwards compatibility.

Definition at line 3293 of file network.h.

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

void TUndirNet::SortNodeAdjV ( )

inline

Sorts the adjacency lists of each node.

Definition at line 3435 of file network.h.

{ for (TNodeI NI = BegNI(); NI < EndNI(); NI++) { NI.SortNIdV();} }

Friends And Related Function Documentation

friend class TPt< TUndirNet >

friend

Definition at line 3695 of file network.h.

friend class TUndirNetMtx

friend

Definition at line 3694 of file network.h.

Member Data Documentation

TCRef TUndirNet::CRef

private

Definition at line 3256 of file network.h.

TInt TUndirNet::MxNId

private

Definition at line 3257 of file network.h.

TInt TUndirNet::NEdges

private

Definition at line 3257 of file network.h.

THash<TInt, TNode> TUndirNet::NodeH

private

Definition at line 3258 of file network.h.

TAttrPair TUndirNet::SAttrE

private

Definition at line 3261 of file network.h.

TAttr TUndirNet::SAttrN

private

Definition at line 3260 of file network.h.

---

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

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