TDirNet Class Reference

Directed network. More...

#include <network.h>

Classes
class	TEdgeI
	Edge iterator. Only forward iteration (operator++) is supported. More...
class	TNode
class	TNodeFunctor
class	TNodeI
	Node iterator. Only forward iteration (operator++) is supported. More...

Public Types
typedef TDirNet	TNet
typedef TPt< TDirNet >	PNet

Public Member Functions
	TDirNet ()
	TDirNet (const int &Nodes, const int &Edges)
	Constructor that reserves enough memory for a network of Nodes nodes and Edges edges. More...
	TDirNet (const TDirNet &Graph)
	TDirNet (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...
TDirNet &	operator= (const TDirNet &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 &NodeId)
	Adds a node of ID NodeI.GetId() to the network. More...
int	AddNode (const int &NId, const TIntV &InNIdV, const TIntV &OutNIdV)
	Adds a node of ID NId to the network, creates edges to the node from all nodes in vector InNIdV, creates edges from the node to all nodes in vector OutNIdV. More...
int	AddNode (const int &NId, const TVecPool< TInt > &Pool, const int &SrcVId, const int &DstVId)
	Adds a node of ID NId to the network, creates edges to the node from all nodes in vector InNIdV in the vector pool Pool, creates edges from the node to all nodes in vector OutNIdVin 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 from node SrcNId to node DstNId to the network. More...
int	AddEdgeUnchecked (const int &SrcNId, const int &DstNId)
	Adds an edge from node SrcNId to node DstNId to the network. More...
int	AddEdge (const TEdgeI &EdgeI)
void	DelEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true)
	Deletes an edge from node IDs SrcNId to DstNId from the network. More...
bool	IsEdge (const int &SrcNId, const int &DstNId, const bool &IsDir=true) const
	Tests whether an edge from node IDs SrcNId to 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	ReserveNIdInDeg (const int &NId, const int &InDeg)
	Reserves memory for node ID NId having InDeg in-edges. More...
void	ReserveNIdOutDeg (const int &NId, const int &OutDeg)
	Reserves memory for node ID NId having OutDeg out-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 PDirNet	New ()
	Static constructor that returns a pointer to the network. Call: PDirNet Graph = TDirNet::New(). More...
static PDirNet	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 PDirNet	Load (TSIn &SIn)
	Static constructor that loads the network from a stream SIn and returns a pointer to it. More...
static PDirNet	Load_V1 (TSIn &SIn)
	Static constructor that loads the network from a stream SIn and returns a pointer to it. Backwards compatible. More...
static PDirNet	LoadShM (TShMIn &ShMIn)
	Static constructor that loads the network from memory. More...
static PDirNet	GetSmallGraph ()
	Returns a small network on 5 nodes and 6 edges. More...

Private Member Functions
TNode &	GetNode (const int &NId)
const TNode &	GetNode (const int &NId) const
void	LoadNetworkShM (TShMIn &ShMIn)

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

Friends
class	TPt< TDirNet >
class	TDirNetMtx

Detailed Description

Directed 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 directed edge from one source node to a destination node. There can be an edge between the same pair of nodes in the opposite direction. Self loops (one per node) are allowed but multiple (parallel) edges are not. The directed 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 3966 of file network.h.

Member Typedef Documentation

typedef TPt<TDirNet> TDirNet::PNet

Definition at line 3969 of file network.h.

typedef TDirNet TDirNet::TNet

Definition at line 3968 of file network.h.

Constructor & Destructor Documentation

TDirNet::TDirNet ( )

inline

Definition at line 4096 of file network.h.

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

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

inlineexplicit

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

Definition at line 4098 of file network.h.

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

TDirNet::TDirNet ( const TDirNet &  Graph )

inline

Definition at line 4099 of file network.h.

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

TDirNet::TDirNet ( TSIn &  SIn )

inline

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

Definition at line 4101 of file network.h.

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

Member Function Documentation

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

Adds an edge from node SrcNId to node 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 TDirNet have no IDs we return -1. Function aborts if SrcNId or DstNId are not nodes in the graph.

Definition at line 2713 of file network.cpp.

                                                         {
  IAssertR(IsNode(SrcNId) && IsNode(DstNId), TStr::Fmt("%d or %d not a node.", SrcNId, DstNId).CStr());
  //IAssert(! IsEdge(SrcNId, DstNId));
  if (IsEdge(SrcNId, DstNId)) { return -2; }
  GetNode(SrcNId).OutNIdV.AddSorted(DstNId);
  GetNode(DstNId).InNIdV.AddSorted(SrcNId);
  return -1; // no edge id
}

int TDirNet::AddEdge ( const TEdgeI &  EdgeI )

inline

Definition at line 4211 of file network.h.

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

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

Adds an edge from node SrcNId to node 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 2722 of file network.cpp.

                                                                  {
  GetNode(SrcNId).OutNIdV.Add(DstNId);
  GetNode(DstNId).InNIdV.Add(SrcNId);
  return -1; // no edge id
}

int TDirNet::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 2622 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 TDirNet::AddNode ( const TNodeI &  NodeId )

inline

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

Definition at line 4148 of file network.h.

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

int TDirNet::AddNode	(	const int &	NId,
		const TIntV &	InNIdV,
		const TIntV &	OutNIdV
	)

Adds a node of ID NId to the network, creates edges to the node from all nodes in vector InNIdV, creates edges from the node to all nodes in vector OutNIdV.

//OutNIdV) 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 vectors InNIdV and OutNIdV do not exist. Use TDirNet::IsOk to check that the resulting graph is consistent after the operation.

Definition at line 2646 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.InNIdV = InNIdV;
  Node.OutNIdV = OutNIdV;
  Node.InNIdV.Sort();
  Node.OutNIdV.Sort();
  return NewNId;
}

int TDirNet::AddNode	(	const int &	NId,
		const TVecPool< TInt > &	Pool,
		const int &	SrcVId,
		const int &	DstVId
	)

Adds a node of ID NId to the network, creates edges to the node from all nodes in vector InNIdV in the vector pool Pool, creates edges from the node to all nodes in vector OutNIdVin the vector pool Pool .

//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 TDirNet::IsOk to check that the resulting graph is consistent.

Definition at line 2666 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.InNIdV.GenExt(Pool.GetValVPt(SrcVId), Pool.GetVLen(SrcVId));
  Node.OutNIdV.GenExt(Pool.GetValVPt(DstVId), Pool.GetVLen(DstVId));
  Node.InNIdV.Sort();
  Node.OutNIdV.Sort();
  return NewNId;
}

int TDirNet::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 2633 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 TDirNet::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 2973 of file network.cpp.

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

int TDirNet::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 2981 of file network.cpp.

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

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

inline

Adds Int sparse attribute with name AttrName to EdgeI.

Definition at line 4393 of file network.h.

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

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

inline

Adds Int sparse attribute with id AttrId to EdgeI.

Definition at line 4397 of file network.h.

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

int TDirNet::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 2989 of file network.cpp.

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

int TDirNet::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 2997 of file network.cpp.

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

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

inline

Adds Flt sparse attribute with name AttrName to EdgeI.

Definition at line 4407 of file network.h.

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

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

inline

Adds Flt sparse attribute with id AttrId to EdgeI.

Definition at line 4411 of file network.h.

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

int TDirNet::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 3005 of file network.cpp.

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

int TDirNet::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 3013 of file network.cpp.

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

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

inline

Adds Str sparse attribute with name AttrName to EdgeI.

Definition at line 4421 of file network.h.

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

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

inline

Adds Str sparse attribute with id AttrId to EdgeI.

Definition at line 4425 of file network.h.

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

int TDirNet::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 2847 of file network.cpp.

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

int TDirNet::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 2854 of file network.cpp.

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

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

inline

Adds Int sparse attribute with name AttrName to NodeI.

Definition at line 4275 of file network.h.

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

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

inline

Adds Int sparse attribute with id AttrId to NodeI.

Definition at line 4279 of file network.h.

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

int TDirNet::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 2861 of file network.cpp.

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

int TDirNet::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 2868 of file network.cpp.

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

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

inline

Adds Flt sparse attribute with name AttrName to NodeI.

Definition at line 4289 of file network.h.

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

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

inline

Adds Flt sparse attribute with id AttrId to NodeI.

Definition at line 4293 of file network.h.

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

int TDirNet::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 2875 of file network.cpp.

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

int TDirNet::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 2882 of file network.cpp.

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

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

inline

Adds Str sparse attribute with name AttrName to NodeI.

Definition at line 4303 of file network.h.

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

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

inline

Adds Str sparse attribute with id AttrId to NodeI.

Definition at line 4307 of file network.h.

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

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

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

Definition at line 3102 of file network.cpp.

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

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

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

Definition at line 2961 of file network.cpp.

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

TEdgeI TDirNet::BegEI ( ) const

inline

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

Definition at line 4221 of file network.h.

{ TNodeI NI=BegNI(); while(NI<EndNI() && NI.GetOutDeg()==0){NI++;} return TEdgeI(NI, EndNI()); }

TNodeI TDirNet::BegNI ( ) const

inline

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

Definition at line 4181 of file network.h.

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

void TDirNet::Clr ( )

inline

Deletes all nodes and edges from the network.

Definition at line 4239 of file network.h.

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

void TDirNet::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 2767 of file network.cpp.

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

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

Deletes an edge from node IDs SrcNId to DstNId from the network.

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

Definition at line 2728 of file network.cpp.

                                                                             {
  IAssertR(IsNode(SrcNId) && IsNode(DstNId), TStr::Fmt("%d or %d not a node.", SrcNId, DstNId).CStr());
  { TNode& N = GetNode(SrcNId);
  TIntPr Id(SrcNId, DstNId);
  SAttrE.DelSAttrId(Id);
  const int n = N.OutNIdV.SearchBin(DstNId);
  if (n!= -1) { N.OutNIdV.Del(n); } }
  { TNode& N = GetNode(DstNId);
  const int n = N.InNIdV.SearchBin(SrcNId);
  if (n!= -1) { N.InNIdV.Del(n); } }
  if (! IsDir) {
    { TNode& N = GetNode(SrcNId);
    const int n = N.InNIdV.SearchBin(DstNId);
    if (n!= -1) { N.InNIdV.Del(n); } }
    { TNode& N = GetNode(DstNId);
    const int n = N.OutNIdV.SearchBin(SrcNId);
    if (n!= -1) { N.OutNIdV.Del(n); } }
  }
}

void TDirNet::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 2684 of file network.cpp.

                                    {
  { TNode& Node = GetNode(NId);
  TInt Id(NId);
  SAttrN.DelSAttrId(Id);
  for (int e = 0; e < Node.GetOutDeg(); e++) {
  const int nbr = Node.GetOutNId(e);
  if (nbr == NId) { continue; }
    TNode& N = GetNode(nbr);
    const int n = N.InNIdV.SearchBin(NId);
    if (n!= -1) { N.InNIdV.Del(n); }
  }
  for (int e = 0; e < Node.GetInDeg(); e++) {
  const int nbr = Node.GetInNId(e);
  if (nbr == NId) { continue; }
    TNode& N = GetNode(nbr);
    const int n = N.OutNIdV.SearchBin(NId);
    if (n!= -1) { N.OutNIdV.Del(n); }
  } }
  NodeH.DelKey(NId);
}

void TDirNet::DelNode ( const TNode &  NodeI )

inline

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

Definition at line 4177 of file network.h.

{ DelNode(NodeI.GetId()); }

int TDirNet::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 3069 of file network.cpp.

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

int TDirNet::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 3077 of file network.cpp.

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

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

inline

Deletes sparse attribute with name AttrName from EdgeI.

Definition at line 4477 of file network.h.

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

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

inline

Deletes sparse attribute with id AttrId from EdgeI.

Definition at line 4481 of file network.h.

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

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

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

Definition at line 2931 of file network.cpp.

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

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

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

Definition at line 2938 of file network.cpp.

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

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

inline

Deletes sparse attribute with name AttrName from NodeI.

Definition at line 4359 of file network.h.

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

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

inline

Deletes sparse attribute with id AttrId from NodeI.

Definition at line 4363 of file network.h.

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

void TDirNet::Dump

(

FILE *

OutF = stdout

)

const

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

Definition at line 2822 of file network.cpp.

                                   {
  const int NodePlaces = (int) ceil(log10((double) GetNodes()));
  fprintf(OutF, "-------------------------------------------------\nDirected 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]\n", NodePlaces, Node.GetId());
    fprintf(OutF, "    in [%d]", Node.GetInDeg());
    for (int edge = 0; edge < Node.GetInDeg(); edge++) {
      fprintf(OutF, " %*d", NodePlaces, Node.GetInNId(edge)); }
    fprintf(OutF, "\n    out[%d]", Node.GetOutDeg());
    for (int edge = 0; edge < Node.GetOutDeg(); edge++) {
      fprintf(OutF, " %*d", NodePlaces, Node.GetOutNId(edge)); }
    fprintf(OutF, "\n");
  }
  fprintf(OutF, "\n");
}

bool TDirNet::Empty ( ) const

inline

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

Definition at line 4237 of file network.h.

{ return GetNodes()==0; }

TEdgeI TDirNet::EndEI ( ) const

inline

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

Definition at line 4223 of file network.h.

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

TNodeI TDirNet::EndNI ( ) const

inline

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

Definition at line 4183 of file network.h.

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

int TDirNet::GetEdges

(

)

const

Returns the number of edges in the network.

Definition at line 2705 of file network.cpp.

                            {
  int edges=0;
  for (int N=NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
    edges+=NodeH[N].GetOutDeg();
  }
  return edges;
}

TEdgeI TDirNet::GetEI

(

const int &

EId

)

const

Not supported/implemented!

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

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

Definition at line 2754 of file network.cpp.

                                                                       {
  const TNodeI SrcNI = GetNI(SrcNId);
  const int NodeN = SrcNI.NodeHI.GetDat().OutNIdV.SearchBin(DstNId);
  IAssert(NodeN != -1);
  return TEdgeI(SrcNI, EndNI(), NodeN);
}

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

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

Definition at line 3094 of file network.cpp.

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

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

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

Definition at line 3098 of file network.cpp.

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

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

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

Definition at line 2953 of file network.cpp.

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

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

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

Definition at line 2957 of file network.cpp.

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

int TDirNet::GetMxNId ( ) const

inline

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

Definition at line 4189 of file network.h.

{ return MxNId; }

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

inline

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

Definition at line 4185 of file network.h.

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

void TDirNet::GetNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all nodes in the network.

Definition at line 2761 of file network.cpp.

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

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

inlineprivate

Definition at line 4079 of file network.h.

{ return NodeH.GetDat(NId); }

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

inlineprivate

Definition at line 4080 of file network.h.

{ return NodeH.GetDat(NId); }

int TDirNet::GetNodes ( ) const

inline

Returns the number of nodes in the network.

Definition at line 4134 of file network.h.

{ return NodeH.Len(); }

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

inline

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

Definition at line 4232 of file network.h.

{ return GetNI(GetRndNId(Rnd)); }

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

inline

Returns an ID of a random node in the network.

Definition at line 4230 of file network.h.

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

int TDirNet::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 3021 of file network.cpp.

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

int TDirNet::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 3029 of file network.cpp.

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

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

inline

Gets Int sparse attribute with name AttrName from EdgeI.

Definition at line 4435 of file network.h.

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

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

inline

Gets Int sparse attribute with id AttrId from EdgeI.

Definition at line 4439 of file network.h.

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

int TDirNet::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 3037 of file network.cpp.

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

int TDirNet::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 3045 of file network.cpp.

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

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

inline

Gets Flt sparse attribute with name AttrName from EdgeI.

Definition at line 4449 of file network.h.

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

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

inline

Gets Flt sparse attribute with id AttrId from EdgeI.

Definition at line 4453 of file network.h.

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

int TDirNet::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 3053 of file network.cpp.

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

int TDirNet::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 3061 of file network.cpp.

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

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

inline

Gets Str sparse attribute with name AttrName from EdgeI.

Definition at line 4463 of file network.h.

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

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

inline

Gets Str sparse attribute with id AttrId from EdgeI.

Definition at line 4467 of file network.h.

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

int TDirNet::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 2889 of file network.cpp.

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

int TDirNet::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 2896 of file network.cpp.

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

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

inline

Gets Int sparse attribute with name AttrName from NodeI.

Definition at line 4317 of file network.h.

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

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

inline

Gets Int sparse attribute with id AttrId from NodeI.

Definition at line 4321 of file network.h.

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

int TDirNet::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 2903 of file network.cpp.

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

int TDirNet::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 2910 of file network.cpp.

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

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

inline

Gets Flt sparse attribute with name AttrName from NodeI.

Definition at line 4331 of file network.h.

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

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

inline

Gets Flt sparse attribute with id AttrId from NodeI.

Definition at line 4335 of file network.h.

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

int TDirNet::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 2917 of file network.cpp.

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

int TDirNet::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 2924 of file network.cpp.

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

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

inline

Gets Str sparse attribute with name AttrName from NodeI.

Definition at line 4345 of file network.h.

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

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

inline

Gets Str sparse attribute with id AttrId from NodeI.

Definition at line 4349 of file network.h.

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

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

Gets id and type for attribute with name Name.

Definition at line 3106 of file network.cpp.

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

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

Gets id and type for attribute with name Name.

Definition at line 2965 of file network.cpp.

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

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

Gets name and type for attribute with id AttrId.

Definition at line 3110 of file network.cpp.

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

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

Gets name and type for attribute with id AttrId.

Definition at line 2969 of file network.cpp.

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

int TDirNet::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 3085 of file network.cpp.

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

int TDirNet::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 4487 of file network.h.

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

int TDirNet::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 2945 of file network.cpp.

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

int TDirNet::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 4370 of file network.h.

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

PDirNet TDirNet::GetSmallGraph ( )

static

Returns a small network on 5 nodes and 6 edges.

/// Edges:  0 -> 1, 1 -> 2, 0 -> 2, 1 -> 3, 3 -> 4, 2 -> 3
/// 

Definition at line 2839 of file network.cpp.

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

bool TDirNet::HasFlag

(

const TGraphFlag &

Flag

)

const

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

Definition at line 2618 of file network.cpp.

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

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

Tests whether an edge from node IDs SrcNId to DstNId exists in the network.

Definition at line 2748 of file network.cpp.

                                                                                  {
  if (! IsNode(SrcNId) || ! IsNode(DstNId)) { return false; }
  if (IsDir) { return GetNode(SrcNId).IsOutNId(DstNId); }
  else { return GetNode(SrcNId).IsOutNId(DstNId) || GetNode(DstNId).IsOutNId(SrcNId); }
}

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

inline

Tests whether ID NId is a node.

Definition at line 4179 of file network.h.

{ return NodeH.IsKey(NId); }

bool TDirNet::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 2776 of file network.cpp.

                                                {
  bool RetVal = true;
  for (int N = NodeH.FFirstKeyId(); NodeH.FNextKeyId(N); ) {
    const TNode& Node = NodeH[N];
    if (! Node.OutNIdV.IsSorted()) {
      const TStr Msg = TStr::Fmt("Out-neighbor list of node %d is not sorted.", Node.GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
    }
    if (! Node.InNIdV.IsSorted()) {
      const TStr Msg = TStr::Fmt("In-neighbor list of node %d is not sorted.", Node.GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
    }
    // check out-edges
    int prevNId = -1;
    for (int e = 0; e < Node.GetOutDeg(); e++) {
      if (! IsNode(Node.GetOutNId(e))) {
        const TStr Msg = TStr::Fmt("Out-edge %d --> %d: node %d does not exist.",
          Node.GetId(), Node.GetOutNId(e), Node.GetOutNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
      }
      if (e > 0 && prevNId == Node.GetOutNId(e)) {
        const TStr Msg = TStr::Fmt("Node %d has duplidate out-edge %d --> %d.",
          Node.GetId(), Node.GetId(), Node.GetOutNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
      }
      prevNId = Node.GetOutNId(e);
    }
    // check in-edges
    prevNId = -1;
    for (int e = 0; e < Node.GetInDeg(); e++) {
      if (! IsNode(Node.GetInNId(e))) {
        const TStr Msg = TStr::Fmt("In-edge %d <-- %d: node %d does not exist.",
          Node.GetId(), Node.GetInNId(e), Node.GetInNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
      }
      if (e > 0 && prevNId == Node.GetInNId(e)) {
        const TStr Msg = TStr::Fmt("Node %d has duplidate in-edge %d <-- %d.",
          Node.GetId(), Node.GetId(), Node.GetInNId(e));
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false;
      }
      prevNId = Node.GetInNId(e);
    }
  }
  return RetVal;
}

static PDirNet TDirNet::Load ( TSIn &  SIn )

inlinestatic

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

Definition at line 4113 of file network.h.

{ return PDirNet(new TDirNet(SIn)); }

static PDirNet TDirNet::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 4115 of file network.h.

                                    { PDirNet Graph = PDirNet(new TDirNet());
    Graph->MxNId.Load(SIn); Graph->NodeH.Load(SIn); return Graph;
  }

void TDirNet::LoadNetworkShM ( TShMIn &  ShMIn )

inlineprivate

Definition at line 4088 of file network.h.

                                     {
    MxNId = TInt(ShMIn);
    TNodeFunctor f;
    NodeH.LoadShM(ShMIn, f);
    SAttrN.Load(ShMIn);
    SAttrE = TAttrPair(ShMIn);
  }

static PDirNet TDirNet::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 4123 of file network.h.

                                        {
    TDirNet* Network = new TDirNet();
    Network->LoadNetworkShM(ShMIn);
    return PDirNet(Network);
  }

static PDirNet TDirNet::New ( )

inlinestatic

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

Definition at line 4107 of file network.h.

{ return new TDirNet(); }

static PDirNet TDirNet::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: PDirNet Net = TDirNet::New(Nodes, Edges).

Definition at line 4111 of file network.h.

{ return new TDirNet(Nodes, Edges); }

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

inline

Definition at line 4130 of file network.h.

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

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

inline

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

Definition at line 4241 of file network.h.

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

void TDirNet::ReserveNIdInDeg ( const int &  NId, const int &  InDeg  )

inline

Reserves memory for node ID NId having InDeg in-edges.

Definition at line 4243 of file network.h.

{ GetNode(NId).InNIdV.Reserve(InDeg); }

void TDirNet::ReserveNIdOutDeg ( const int &  NId, const int &  OutDeg  )

inline

Reserves memory for node ID NId having OutDeg out-edges.

Definition at line 4245 of file network.h.

{ GetNode(NId).OutNIdV.Reserve(OutDeg); }

void TDirNet::Save ( TSOut &  SOut ) const

inline

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

Definition at line 4103 of file network.h.

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

void TDirNet::Save_V1 ( TSOut &  SOut ) const

inline

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

Definition at line 4105 of file network.h.

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

void TDirNet::SortNodeAdjV ( )

inline

Sorts the adjacency lists of each node.

Definition at line 4247 of file network.h.

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

Friends And Related Function Documentation

friend class TDirNetMtx

friend

Definition at line 4505 of file network.h.

friend class TPt< TDirNet >

friend

Definition at line 4504 of file network.h.

Member Data Documentation

TCRef TDirNet::CRef

private

Definition at line 4073 of file network.h.

TInt TDirNet::MxNId

private

Definition at line 4074 of file network.h.

THash<TInt, TNode> TDirNet::NodeH

private

Definition at line 4075 of file network.h.

TAttrPair TDirNet::SAttrE

private

Definition at line 4077 of file network.h.

TAttr TDirNet::SAttrN

private

Definition at line 4076 of file network.h.

---

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

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