TBPGraph Class Reference

Bipartite graph. More...

#include <graph.h>

Collaboration diagram for TBPGraph:

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

Public Types
enum	TNodeTy { bgsUndef, bgsLeft, bgsRight, bgsBoth }
typedef TBPGraph	TNet
typedef TPt< TBPGraph >	PNet

Public Member Functions
	TBPGraph ()
	TBPGraph (const int &Nodes, const int &Edges)
	Constructor that reserves enough memory for a graph of Nodes (LeftNodes+RightNodes) nodes and Edges edges. More...
	TBPGraph (const TBPGraph &BPGraph)
	!! Reserve(Nodes, Edges); } More...
	TBPGraph (TSIn &SIn)
	Constructor for loading the graph from a (binary) stream SIn. More...
void	Save (TSOut &SOut) const
	Saves the graph to a (binary) stream SOut. More...
bool	HasFlag (const TGraphFlag &Flag) const
	Allows for run-time checking the type of the graph (see the TGraphFlag for flags). More...
TBPGraph &	operator= (const TBPGraph &BPGraph)
int	GetNodes () const
	Returns the total number of nodes in the graph. More...
int	GetLNodes () const
	Returns the number of nodes on the 'left' side of the biparite graph. More...
int	GetRNodes () const
	Returns the number of nodes on the 'right' side of the biparite graph. More...
int	AddNode (int NId=-1, const bool &LeftNode=true)
	Adds a node of ID NId to the graph. More...
int	AddNode (const TNodeI &NodeI)
	Adds a node of ID NodeI.GetId() to the graph. More...
void	DelNode (const int &NId)
	Deletes node of ID NId from the graph. More...
void	DelNode (const TNode &NodeI)
	Deletes node of ID NodeI.GetId() from the graph. More...
bool	IsNode (const int &NId) const
	Tests whether ID NId is a node. More...
bool	IsLNode (const int &NId) const
	Tests whether ID NId is a 'left' side node. More...
bool	IsRNode (const int &NId) const
	Tests whether ID NId is a 'right' side node. More...
int	GetMxNId () const
	Returns an ID that is larger than any node ID in the graph. More...
TNodeI	BegNI () const
	Returns an iterator referring to the first node in the graph. More...
TNodeI	EndNI () const
	Returns an iterator referring to the past-the-end node in the graph. More...
TNodeI	GetNI (const int &NId) const
	Returns an iterator referring to the node of ID NId in the graph. More...
TNodeI	BegLNI () const
	Returns an iterator referring to the first 'left' node in the graph. More...
TNodeI	EndLNI () const
	Returns an iterator referring to the past-the-end 'left' node in the graph. More...
TNodeI	BegRNI () const
	Returns an iterator referring to the first 'right' node in the graph. More...
TNodeI	EndRNI () const
	Returns an iterator referring to the past-the-end 'right' node in the graph. More...
int	GetEdges () const
	Returns the number of edges in the graph. More...
int	AddEdge (const int &LeftNId, const int &RightNId)
	Adds an edge between a node LeftNId on the left and a node RightNId on the right side of the bipartite graph. More...
int	AddEdge (const TEdgeI &EdgeI)
	Adds an edge between EdgeI.GetLNId() and EdgeI.GetRNId() to the graph. More...
void	DelEdge (const int &LeftNId, const int &RightNId)
	Deletes an edge between a node LeftNId on the left and a node RightNId on the right side of the bipartite graph. More...
bool	IsEdge (const int &LeftNId, const int &RightNId) const
	Tests whether an edge between node IDs LeftNId and RightNId exists in the graph. More...
TEdgeI	BegEI () const
	Returns an iterator referring to the first edge in the graph. More...
TEdgeI	EndEI () const
	Returns an iterator referring to the past-the-end edge in the graph. More...
TEdgeI	GetEI (const int &EId) const
	Not supported/implemented! More...
TEdgeI	GetEI (const int &LeftNId, const int &RightNId) const
	Returns an iterator referring to edge (LeftNId, RightNId) in the graph. More...
int	GetRndNId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random node in the graph. More...
int	GetRndLNId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random 'left' node in the graph. More...
int	GetRndRNId (TRnd &Rnd=TInt::Rnd)
	Returns an ID of a random 'right' node in the graph. More...
TNodeI	GetRndNI (TRnd &Rnd=TInt::Rnd)
	Returns an interator referring to a random node in the graph. More...
void	GetNIdV (TIntV &NIdV) const
	Gets a vector IDs of all nodes in the bipartite graph. More...
void	GetLNIdV (TIntV &NIdV) const
	Gets a vector IDs of all 'left' nodes in the bipartite graph. More...
void	GetRNIdV (TIntV &NIdV) const
	Gets a vector IDs of all 'right' nodes in the bipartite graph. More...
bool	Empty () const
	Tests whether the bipartite graph is empty (has zero nodes). More...
void	Clr ()
	Deletes all nodes and edges from the bipartite graph. More...
void	Reserve (const int &Nodes, const int &Edges)
	Reserves memory for a biparite graph of Nodes nodes and Edges edges. More...
void	Defrag (const bool &OnlyNodeLinks=false)
	Defragments the biparite graph. More...
bool	IsOk (const bool &ThrowExcept=true) const
	Checks the bipartite graph data structure for internal consistency. More...
void	Dump (FILE *OutF=stdout) const
	Print the biparite graph in a human readable form to an output stream OutF. More...

Static Public Member Functions
static PBPGraph	New ()
	Static constructor that returns a pointer to the graph. Call: PBPGraph BPGraph = TBPGraph::New();. More...
static PBPGraph	New (const int &Nodes, const int &Edges)
	Static constructor that returns a pointer to the graph and reserves enough memory for Nodes nodes and Edges edges. More...
static PBPGraph	Load (TSIn &SIn)
	Static constructor that loads the graph from a stream SIn and returns a pointer to it. More...
static PBPGraph	GetSmallGraph ()
	Returns a small graph on 2 'left', 3 'right' nodes and 4 edges. More...

Private Attributes
TCRef	CRef
TInt	MxNId
THash< TInt, TNode >	LeftH
THash< TInt, TNode >	RightH

Friends
class	TPt< TBPGraph >

Detailed Description

Bipartite graph.

Definition at line 825 of file graph.h.

Member Typedef Documentation

typedef TPt<TBPGraph> TBPGraph::PNet

Definition at line 828 of file graph.h.

typedef TBPGraph TBPGraph::TNet

Definition at line 827 of file graph.h.

Member Enumeration Documentation

enum TBPGraph::TNodeTy

Enumerator
bgsUndef
bgsLeft
bgsRight
bgsBoth

Definition at line 829 of file graph.h.

{ bgsUndef, bgsLeft, bgsRight, bgsBoth } TNodeTy; // left or right hand side node

Constructor & Destructor Documentation

TBPGraph::TBPGraph ( )

inline

Definition at line 942 of file graph.h.

Referenced by Load(), and New().

: CRef(), MxNId(0), LeftH(), RightH() { }

Here is the caller graph for this function:

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

inlineexplicit

Constructor that reserves enough memory for a graph of Nodes (LeftNodes+RightNodes) nodes and Edges edges.

Definition at line 944 of file graph.h.

: MxNId(0) { } 

TBPGraph::TBPGraph ( const TBPGraph &  BPGraph )

inline

!! Reserve(Nodes, Edges); }

Definition at line 945 of file graph.h.

: MxNId(BPGraph.MxNId), LeftH(BPGraph.LeftH), RightH(BPGraph.RightH) { }

TBPGraph::TBPGraph ( TSIn &  SIn )

inline

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

Definition at line 947 of file graph.h.

: MxNId(SIn), LeftH(SIn), RightH(SIn) { }

Member Function Documentation

int TBPGraph::AddEdge	(	const int &	LeftNId,
		const int &	RightNId
	)

Adds an edge between a node LeftNId on the left and a node RightNId on the right side of the bipartite graph.

Definition at line 655 of file graph.cpp.

References TStr::Fmt(), and IAssertR.

Referenced by TSnap::GenRewire().

                                                             {
  const bool IsLL = IsLNode(LeftNId), IsLR = IsRNode(LeftNId);
  const bool IsRL = IsLNode(RightNId), IsRR = IsRNode(RightNId);
  IAssertR((IsLL||IsLR)&&(IsRL||IsRR), TStr::Fmt("%d or %d is not a node.", LeftNId, RightNId).CStr());
  IAssertR(LeftNId!=RightNId, "No self-edges are allowed."); 
  IAssertR((IsLL&&!IsLR&&!IsRL&&IsRR)||(!IsLL&&IsLR&&IsRL&&!IsRR), "One node should be on the 'left' and the other on the 'right'.");
  const int LNId = IsLL ? LeftNId : RightNId; // the real left node
  const int RNId = IsLL ? RightNId : LeftNId; // the real right node
  if (LeftH.GetDat(LNId).IsOutNId(RNId)) { return -2; } // edge already exists
  LeftH.GetDat(LNId).NIdV.AddSorted(RNId);
  RightH.GetDat(RNId).NIdV.AddSorted(LNId);
  return -1; // edge id
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::AddEdge ( const TEdgeI &  EdgeI )

inline

Adds an edge between EdgeI.GetLNId() and EdgeI.GetRNId() to the graph.

Definition at line 1008 of file graph.h.

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

Referenced by AddEdge().

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

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::AddNode	(	int	NId = -1,
		const bool &	LeftNode = true
	)

Adds a node of ID NId to the graph.

Definition at line 621 of file graph.cpp.

References TStr::Fmt(), IAssertR, TMath::Mx(), and TNEGraph::MxNId.

Referenced by TSnap::GenRewire().

                                                   {
  if (NId == -1) { NId = MxNId;  MxNId++; }
  else if (IsLNode(NId)) { IAssertR(LeftNode, TStr::Fmt("Node with id %s already exists on the 'left'.", NId));  return NId; }
  else if (IsRNode(NId)) { IAssertR(! LeftNode, TStr::Fmt("Node with id %s already exists on the 'right'.", NId));  return NId; }
  else { MxNId = TMath::Mx(NId+1, MxNId()); }
  if (LeftNode) { LeftH.AddDat(NId, TNode(NId)); }
  else { RightH.AddDat(NId, TNode(NId)); }
  return NId;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::AddNode ( const TNodeI &  NodeI )

inline

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

Definition at line 972 of file graph.h.

References AddNode(), TBPGraph::TNodeI::GetId(), and TBPGraph::TNodeI::IsLeft().

Referenced by AddNode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

TEdgeI TBPGraph::BegEI ( ) const

inline

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

Definition at line 1015 of file graph.h.

References BegLNI(), EndLNI(), TBPGraph::TNodeI::GetId(), TBPGraph::TNodeI::GetOutDeg(), and TBPGraph::TNodeI::GetOutNId().

{ TNodeI NI=BegLNI(); while (NI<EndLNI() && (NI.GetOutDeg()==0 || NI.GetId()>NI.GetOutNId(0))) { NI++; } return TEdgeI(NI, EndLNI()); }

Here is the call graph for this function:

TNodeI TBPGraph::BegLNI ( ) const

inline

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

Definition at line 994 of file graph.h.

References THash< TKey, TDat, THashFunc >::BegI(), THash< TKey, TDat, THashFunc >::EndI(), LeftH, and RightH.

Referenced by BegEI().

{ return TNodeI(LeftH.BegI(), RightH.EndI()); }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TBPGraph::BegNI ( ) const

inline

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

Definition at line 988 of file graph.h.

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

{ return TNodeI(LeftH.BegI(), RightH.BegI()); }

Here is the call graph for this function:

TNodeI TBPGraph::BegRNI ( ) const

inline

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

Definition at line 998 of file graph.h.

References THash< TKey, TDat, THashFunc >::BegI(), THash< TKey, TDat, THashFunc >::EndI(), LeftH, and RightH.

{ return TNodeI(LeftH.EndI(), RightH.BegI()); }

Here is the call graph for this function:

void TBPGraph::Clr ( )

inline

Deletes all nodes and edges from the bipartite graph.

Definition at line 1042 of file graph.h.

References THash< TKey, TDat, THashFunc >::Clr(), LeftH, MxNId, and RightH.

{ MxNId=0; LeftH.Clr(); RightH.Clr(); }

Here is the call graph for this function:

void TBPGraph::Defrag

(

const bool &

OnlyNodeLinks = false

)

Defragments the biparite graph.

Definition at line 744 of file graph.cpp.

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

void TBPGraph::DelEdge	(	const int &	LeftNId,
		const int &	RightNId
	)

Deletes an edge between a node LeftNId on the left and a node RightNId on the right side of the bipartite graph.

Definition at line 669 of file graph.cpp.

References TVec< TVal, TSizeTy >::Del(), TStr::Fmt(), TVec< TVal, TSizeTy >::GetDat(), IAssertR, and TVec< TVal, TSizeTy >::SearchBin().

                                                              {
  const bool IsLL = IsLNode(LeftNId), IsLR = IsRNode(LeftNId);
  const bool IsRL = IsLNode(RightNId), IsRR = IsRNode(RightNId);
  IAssertR((IsLL||IsLR)&&(IsRL||IsRR), TStr::Fmt("%d or %d is not a node.", LeftNId, RightNId).CStr());
  IAssertR(LeftNId!=RightNId, "No self-edges are allowed."); 
  IAssertR((IsLL&&!IsLR&&!IsRL&&IsRR)||(!IsLL&&IsLR&&IsRL&&!IsRR), "One node should be on the 'left' and the other on the 'right'.");
  const int LNId = IsLL ? LeftNId : RightNId; // the real left node
  const int RNId = IsLL ? RightNId : LeftNId; // the real right node
  { TIntV& NIdV = LeftH.GetDat(LNId).NIdV;
  const int n = NIdV.SearchBin(RNId);
  if (n != -1) { NIdV.Del(n); } }
  { TIntV& NIdV = RightH.GetDat(RNId).NIdV;
  const int n = NIdV.SearchBin(LNId);
  if (n != -1) { NIdV.Del(n); } }
}

Here is the call graph for this function:

void TBPGraph::DelNode

(

const int &

NId

)

Deletes node of ID NId from the graph.

Definition at line 632 of file graph.cpp.

References AssertR, TVec< TVal, TSizeTy >::Del(), THash< TKey, TDat, THashFunc >::DelKey(), TStr::Fmt(), THash< TKey, TDat, THashFunc >::GetDat(), TBPGraph::TNode::GetOutDeg(), TBPGraph::TNode::GetOutNId(), IAssert, IAssertR, TNEGraph::IsNode(), TBPGraph::TNode::NIdV, and TVec< TVal, TSizeTy >::SearchBin().

                                     {
  AssertR(IsNode(NId), TStr::Fmt("NodeId %d does not exist", NId));
  THash<TInt, TNode>& SrcH = IsLNode(NId) ? LeftH : RightH;
  THash<TInt, TNode>& DstH = IsLNode(NId) ? RightH : LeftH;
  { TNode& Node = SrcH.GetDat(NId);
  for (int e = 0; e < Node.GetOutDeg(); e++) {
    const int nbr = Node.GetOutNId(e);
    IAssertR(nbr != NId, "Bipartite graph has a loop!");
    TNode& N = DstH.GetDat(nbr);
    const int n = N.NIdV.SearchBin(NId);
    IAssert(n!= -1); 
    N.NIdV.Del(n);
  } }
  SrcH.DelKey(NId);
}

Here is the call graph for this function:

void TBPGraph::DelNode ( const TNode &  NodeI )

inline

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

Definition at line 977 of file graph.h.

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

Referenced by DelNode().

{ DelNode(NodeI.GetId()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TBPGraph::Dump

(

FILE *

OutF = stdout

)

const

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

Definition at line 795 of file graph.cpp.

References TBPGraph::TNode::GetDeg(), TNEGraph::GetEdges(), TBPGraph::TNode::GetId(), TBPGraph::TNode::GetNbrNId(), and TNEGraph::GetNodes().

                                    {
  const int NodePlaces = (int) ceil(log10((double) GetNodes()));
  fprintf(OutF, "-------------------------------------------------\nBipartite Graph: nodes: %d+%d=%d, edges: %d\n", GetLNodes(), GetRNodes(), GetNodes(), GetEdges());
  for (int N = LeftH.FFirstKeyId(); LeftH.FNextKeyId(N); ) {
    const TNode& Node = LeftH[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");
  /*// Also dump the 'right' side
  fprintf(OutF, "\n");
  for (int N = RightH.FFirstKeyId(); RightH.FNextKeyId(N); ) {
    const TNode& Node = RightH[N];
    fprintf(OutF, "  %*d [%d] ", NodePlaces, Node.GetId(), Node.GetDeg());
    for (int edge = 0; edge < Node.GetDeg(); edge++) {
      fprintf(OutF, " %*d", NodePlaces, Node.GetNbrNId(edge)); }
    fprintf(OutF, "\n");
  }
  fprintf(OutF, "\n"); //*/
}

Here is the call graph for this function:

bool TBPGraph::Empty ( ) const

inline

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

Definition at line 1040 of file graph.h.

References GetNodes().

{ return GetNodes()==0; }

Here is the call graph for this function:

TEdgeI TBPGraph::EndEI ( ) const

inline

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

Definition at line 1017 of file graph.h.

References EndNI().

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

Here is the call graph for this function:

TNodeI TBPGraph::EndLNI ( ) const

inline

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

Definition at line 996 of file graph.h.

References EndNI().

Referenced by BegEI().

{ return EndNI(); }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TBPGraph::EndNI ( ) const

inline

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

Definition at line 990 of file graph.h.

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

Referenced by EndEI(), EndLNI(), and EndRNI().

{ return TNodeI(LeftH.EndI(), RightH.EndI()); }

Here is the call graph for this function:

Here is the caller graph for this function:

TNodeI TBPGraph::EndRNI ( ) const

inline

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

Definition at line 1000 of file graph.h.

References EndNI().

{ return EndNI(); }

Here is the call graph for this function:

int TBPGraph::GetEdges

(

)

const

Returns the number of edges in the graph.

Definition at line 648 of file graph.cpp.

                             {
  int Edges = 0;
  for (int N=LeftH.FFirstKeyId(); LeftH.FNextKeyId(N); ) {
    Edges += LeftH[N].GetDeg(); }
  return Edges;
}

TEdgeI TBPGraph::GetEI

(

const int &

EId

)

const

Not supported/implemented!

TBPGraph::TEdgeI TBPGraph::GetEI	(	const int &	LeftNId,
		const int &	RightNId
	)		const

Returns an iterator referring to edge (LeftNId, RightNId) in the graph.

Definition at line 690 of file graph.cpp.

References TNEGraph::EndNI(), TStr::Fmt(), TNEGraph::GetNI(), IAssertR, and TBPGraph::TNodeI::LeftHI.

                                                                            {
  const bool IsLL = IsLNode(LeftNId), IsLR = IsRNode(LeftNId);
  const bool IsRL = IsLNode(RightNId), IsRR = IsRNode(RightNId);
  IAssertR((IsLL||IsLR)&&(IsRL||IsRR), TStr::Fmt("%d or %d is not a node.", LeftNId, RightNId).CStr());
  IAssertR(LeftNId!=RightNId, "No self-edges are allowed."); 
  IAssertR((IsLL&&!IsLR&&!IsRL&&IsRR)||(!IsLL&&IsLR&&IsRL&&!IsRR), "One node should be on the 'left' and the other on the 'right'.");
  const int LNId = IsLL ? LeftNId : RightNId; // the real left node
  const int RNId = IsLL ? RightNId : LeftNId; // the real right node
  const TNodeI SrcNI = GetNI(LNId);
  const int NodeN = SrcNI.LeftHI.GetDat().NIdV.SearchBin(RNId);
  IAssertR(NodeN != -1, "Right edge endpoint does not exists!");
  return TEdgeI(SrcNI, EndNI(), NodeN);
}

Here is the call graph for this function:

void TBPGraph::GetLNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all 'left' nodes in the bipartite graph.

Definition at line 728 of file graph.cpp.

References TVec< TVal, TSizeTy >::Add(), and TVec< TVal, TSizeTy >::Gen().

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

Here is the call graph for this function:

int TBPGraph::GetLNodes ( ) const

inline

Returns the number of nodes on the 'left' side of the biparite graph.

Definition at line 965 of file graph.h.

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

Referenced by GetNodes().

{ return LeftH.Len(); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::GetMxNId ( ) const

inline

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

Definition at line 985 of file graph.h.

References MxNId.

{ return MxNId; }

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

inline

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

Definition at line 992 of file graph.h.

References THash< TKey, TDat, THashFunc >::EndI(), THash< TKey, TDat, THashFunc >::GetI(), IsLNode(), LeftH, and RightH.

Referenced by GetRndNI().

{ return IsLNode(NId) ? TNodeI(LeftH.GetI(NId), RightH.EndI()) : TNodeI(LeftH.EndI(), RightH.GetI(NId)); }

Here is the call graph for this function:

Here is the caller graph for this function:

void TBPGraph::GetNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all nodes in the bipartite graph.

Definition at line 720 of file graph.cpp.

References TVec< TVal, TSizeTy >::Add(), TVec< TVal, TSizeTy >::Gen(), and TNEGraph::GetNodes().

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

Here is the call graph for this function:

int TBPGraph::GetNodes ( ) const

inline

Returns the total number of nodes in the graph.

Definition at line 963 of file graph.h.

References GetLNodes(), and GetRNodes().

Referenced by Empty().

{ return GetLNodes() + GetRNodes(); }

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::GetRndLNId

(

TRnd &

Rnd = TInt::Rnd

)

Returns an ID of a random 'left' node in the graph.

Definition at line 712 of file graph.cpp.

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

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

inline

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

Definition at line 1031 of file graph.h.

References GetNI(), and GetRndNId().

{ return GetNI(GetRndNId(Rnd)); }

Here is the call graph for this function:

int TBPGraph::GetRndNId

(

TRnd &

Rnd = TInt::Rnd

)

Returns an ID of a random node in the graph.

Definition at line 704 of file graph.cpp.

References TNEGraph::GetNodes(), and TRnd::GetUniDevInt().

Referenced by GetRndNI().

                                 { 
  const int NNodes = GetNodes();
  if (Rnd.GetUniDevInt(NNodes) < GetLNodes()) {
    return GetRndLNId(Rnd); }
  else {
    return GetRndRNId(Rnd); }
}

Here is the call graph for this function:

Here is the caller graph for this function:

int TBPGraph::GetRndRNId

(

TRnd &

Rnd = TInt::Rnd

)

Returns an ID of a random 'right' node in the graph.

Definition at line 716 of file graph.cpp.

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

void TBPGraph::GetRNIdV

(

TIntV &

NIdV

)

const

Gets a vector IDs of all 'right' nodes in the bipartite graph.

Definition at line 734 of file graph.cpp.

References TVec< TVal, TSizeTy >::Add(), and TVec< TVal, TSizeTy >::Gen().

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

Here is the call graph for this function:

int TBPGraph::GetRNodes ( ) const

inline

Returns the number of nodes on the 'right' side of the biparite graph.

Definition at line 967 of file graph.h.

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

Referenced by GetNodes().

{ return RightH.Len(); }

Here is the call graph for this function:

Here is the caller graph for this function:

PBPGraph TBPGraph::GetSmallGraph ( )

static

Returns a small graph on 2 'left', 3 'right' nodes and 4 edges.

Definition at line 818 of file graph.cpp.

References New().

                                 {
  PBPGraph BP = TBPGraph::New();
  BP->AddNode(0, true);
  BP->AddNode(1, true);
  BP->AddNode(2, false);
  BP->AddNode(3, false);
  BP->AddNode(4, false);
  BP->AddEdge(0, 2);
  BP->AddEdge(0, 3);
  BP->AddEdge(1, 2);
  BP->AddEdge(1, 3);
  BP->AddEdge(1, 4);
  return BP;
}

Here is the call graph for this function:

bool TBPGraph::HasFlag

(

const TGraphFlag &

Flag

)

const

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

bool TBPGraph::IsEdge	(	const int &	LeftNId,
		const int &	RightNId
	)		const

Tests whether an edge between node IDs LeftNId and RightNId exists in the graph.

Definition at line 685 of file graph.cpp.

References TNEGraph::IsNode().

                                                                   {
  if (! IsNode(LeftNId) || ! IsNode(RightNId)) { return false; }
  return IsLNode(LeftNId) ? LeftH.GetDat(LeftNId).IsOutNId(RightNId) : RightH.GetDat(LeftNId).IsOutNId(RightNId);
}

Here is the call graph for this function:

bool TBPGraph::IsLNode ( const int &  NId ) const

inline

Tests whether ID NId is a 'left' side node.

Definition at line 981 of file graph.h.

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

Referenced by GetNI(), and IsNode().

{ return LeftH.IsKey(NId); }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Tests whether ID NId is a node.

Definition at line 979 of file graph.h.

References IsLNode(), and IsRNode().

{ return IsLNode(NId) || IsRNode(NId); }

Here is the call graph for this function:

bool TBPGraph::IsOk

(

const bool &

ThrowExcept = true

)

const

Checks the bipartite graph data structure for internal consistency.

Definition at line 753 of file graph.cpp.

References TStr::CStr(), EAssertR, ErrNotify(), and TStr::Fmt().

                                                 {
  bool RetVal = false;
  // edge lists are sorted
  for (int n = LeftH.FFirstKeyId(); LeftH.FNextKeyId(n); ) {
    if (! LeftH[n].NIdV.IsSorted()) {
      const TStr Msg = TStr::Fmt("Neighbor list of node %d is not sorted.", LeftH[n].GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
  }
  for (int n = RightH.FFirstKeyId(); RightH.FNextKeyId(n); ) {
    if (! RightH[n].NIdV.IsSorted()) {
      const TStr Msg = TStr::Fmt("Neighbor list of node %d is not sorted.", RightH[n].GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
  }
  // nodes only appear on one side
  for (int n = LeftH.FFirstKeyId(); LeftH.FNextKeyId(n); ) {
    if (RightH.IsKey(LeftH[n].GetId())) {
      const TStr Msg = TStr::Fmt("'Left' node %d also appears on the 'right'.", LeftH[n].GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
  } 
  for (int n = RightH.FFirstKeyId(); RightH.FNextKeyId(n); ) {
    if (LeftH.IsKey(RightH[n].GetId())) {
      const TStr Msg = TStr::Fmt("'Right' node %d also appears on the 'left'.", RightH[n].GetId());
      if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
  }
  // edges only point from left to right and right to left
  for (int n = LeftH.FFirstKeyId(); LeftH.FNextKeyId(n); ) {
    for (int e = 0; e < LeftH[n].NIdV.Len(); e++) {
      if (! RightH.IsKey(LeftH[n].NIdV[e]) || ! RightH.GetDat(LeftH[n].NIdV[e]).NIdV.IsIn(LeftH[n].GetId())) {
        const TStr Msg = TStr::Fmt("'Left' node %d does not point to the 'right' node %d.", LeftH[n].GetId(), LeftH[n].NIdV[e]());
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
    }
  }
  for (int n = RightH.FFirstKeyId(); RightH.FNextKeyId(n); ) {
    for (int e = 0; e < RightH[n].NIdV.Len(); e++) {
      if (! LeftH.IsKey(RightH[n].NIdV[e]) || ! LeftH.GetDat(RightH[n].NIdV[e]).NIdV.IsIn(RightH[n].GetId())) {
        const TStr Msg = TStr::Fmt("'Left' node %d does not point to the 'right' node %d.", RightH[n].GetId(), RightH[n].NIdV[e]());
        if (ThrowExcept) { EAssertR(false, Msg); } else { ErrNotify(Msg.CStr()); } RetVal=false; }
    }
  }
  return RetVal;
}

Here is the call graph for this function:

bool TBPGraph::IsRNode ( const int &  NId ) const

inline

Tests whether ID NId is a 'right' side node.

Definition at line 983 of file graph.h.

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

Referenced by IsNode().

{ return RightH.IsKey(NId); }

Here is the call graph for this function:

Here is the caller graph for this function:

static PBPGraph TBPGraph::Load ( TSIn &  SIn )

inlinestatic

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

Definition at line 956 of file graph.h.

References TBPGraph().

{ return PBPGraph(new TBPGraph(SIn)); }

Here is the call graph for this function:

static PBPGraph TBPGraph::New ( )

inlinestatic

Static constructor that returns a pointer to the graph. Call: PBPGraph BPGraph = TBPGraph::New();.

Definition at line 951 of file graph.h.

References TBPGraph().

Referenced by TSnap::GenRewire(), TSnap::GenRndBipart(), and GetSmallGraph().

{ return new TBPGraph(); }

Here is the call graph for this function:

Here is the caller graph for this function:

static PBPGraph TBPGraph::New ( const int &  Nodes, const int &  Edges  )

inlinestatic

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

Definition at line 954 of file graph.h.

References TBPGraph().

{ return new TBPGraph(Nodes, Edges); }

Here is the call graph for this function:

TBPGraph& TBPGraph::operator= ( const TBPGraph &  BPGraph )

inline

Definition at line 959 of file graph.h.

References LeftH, MxNId, and RightH.

                                                 {
    if (this!=&BPGraph) { MxNId=BPGraph.MxNId; LeftH=BPGraph.LeftH; RightH=BPGraph.RightH; }  return *this; }

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

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

Definition at line 740 of file graph.cpp.

Referenced by TSnap::GenRewire().

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

Here is the caller graph for this function:

void TBPGraph::Save ( TSOut &  SOut ) const

inline

Saves the graph to a (binary) stream SOut.

Definition at line 949 of file graph.h.

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

{ MxNId.Save(SOut); LeftH.Save(SOut); RightH.Save(SOut); }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class TPt< TBPGraph >

friend

Definition at line 1057 of file graph.h.

Member Data Documentation

TCRef TBPGraph::CRef

private

Definition at line 934 of file graph.h.

THash<TInt, TNode> TBPGraph::LeftH

private

Definition at line 936 of file graph.h.

Referenced by BegLNI(), BegNI(), BegRNI(), Clr(), EndNI(), GetLNodes(), GetNI(), IsLNode(), operator=(), and Save().

TInt TBPGraph::MxNId

private

Definition at line 935 of file graph.h.

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

THash<TInt, TNode> TBPGraph::RightH

private

Definition at line 937 of file graph.h.

Referenced by BegLNI(), BegNI(), BegRNI(), Clr(), EndNI(), GetNI(), GetRNodes(), IsRNode(), operator=(), and Save().

---

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

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