TUNGraph::TNodeI Class Reference

Node iterator. Only forward iteration (operator++) is supported. More...

#include <graph.h>

Collaboration diagram for TUNGraph::TNodeI:

List of all members.

Public Member Functions
	TNodeI ()
	TNodeI (const THashIter &NodeHIter)
	TNodeI (const TNodeI &NodeI)
TNodeI &	operator= (const TNodeI &NodeI)
TNodeI &	operator++ (int)
	Increment iterator.
bool	operator< (const TNodeI &NodeI) const
bool	operator== (const TNodeI &NodeI) const
int	GetId () const
	Returns ID of the current node.
int	GetDeg () const
	Returns degree of the current node.
int	GetInDeg () const
	Returns in-degree of the current node (returns same as value GetDeg() since the graph is undirected).
int	GetOutDeg () const
	Returns out-degree of the current node (returns same as value GetDeg() since the graph is undirected).
int	GetInNId (const int &NodeN) const
	Returns ID of NodeN-th in-node (the node pointing to the current node).
int	GetOutNId (const int &NodeN) const
	Returns ID of NodeN-th out-node (the node the current node points to).
int	GetNbrNId (const int &NodeN) const
	Returns ID of NodeN-th neighboring node.
bool	IsInNId (const int &NId) const
	Tests whether node with ID NId points to the current node.
bool	IsOutNId (const int &NId) const
	Tests whether the current node points to node with ID NId.
bool	IsNbrNId (const int &NId) const
	Tests whether node with ID NId is a neighbor of the current node.
Private Types
typedef THash< TInt, TNode >::TIter	THashIter
Private Attributes
THashIter	NodeHI
Friends
class	TUNGraph

---

Detailed Description

Node iterator. Only forward iteration (operator++) is supported.

Definition at line 62 of file graph.h.

---

Member Typedef Documentation

typedef THash<TInt, TNode>::TIter TUNGraph::TNodeI::THashIter [private]

Definition at line 64 of file graph.h.

---

Constructor & Destructor Documentation

TUNGraph::TNodeI::TNodeI

(

)

[inline]

Definition at line 67 of file graph.h.

: NodeHI() { }

TUNGraph::TNodeI::TNodeI

(

const THashIter &

NodeHIter

)

[inline]

Definition at line 68 of file graph.h.

: NodeHI(NodeHIter) { }

TUNGraph::TNodeI::TNodeI

(

const TNodeI &

NodeI

)

[inline]

Definition at line 69 of file graph.h.

: NodeHI(NodeI.NodeHI) { }

---

Member Function Documentation

int TUNGraph::TNodeI::GetDeg

(

)

const [inline]

Returns degree of the current node.

Definition at line 81 of file graph.h.

References NodeHI.

Referenced by TSnap::GetCmnNbrs< PUNGraph >(), TLocClustStat::TCutInfo::GetFracDegOut(), TCliqueOverlap::GetNbrs(), TCliqueOverlap::GetNodeIdWithMaxDeg(), and TCliqueOverlap::MaxNbrsInCANDNodeId().

{ return NodeHI.GetDat().GetDeg(); }

Here is the caller graph for this function:

int TUNGraph::TNodeI::GetId

(

)

const [inline]

Returns ID of the current node.

Definition at line 79 of file graph.h.

References NodeHI.

Referenced by TUNGraph::AddNode(), TUNGraph::BegEI(), TSnap::GetBetweennessCentr(), and TUNGraph::TEdgeI::GetSrcNId().

{ return NodeHI.GetDat().GetId(); }

Here is the caller graph for this function:

int TUNGraph::TNodeI::GetInDeg

(

)

const [inline]

Returns in-degree of the current node (returns same as value GetDeg() since the graph is undirected).

Definition at line 83 of file graph.h.

References NodeHI.

{ return NodeHI.GetDat().GetInDeg(); }

int TUNGraph::TNodeI::GetInNId

(

const int &

NodeN

)

const [inline]

Returns ID of NodeN-th in-node (the node pointing to the current node).

Range of NodeN: 0 <= NodeN < GetInDeg(). Since the graph is undirected GetInNId(), GetOutNId() and GetNbrNId() all give the same output.

Definition at line 90 of file graph.h.

References NodeHI.

{ return NodeHI.GetDat().GetInNId(NodeN); }

int TUNGraph::TNodeI::GetNbrNId

(

const int &

NodeN

)

const [inline]

Returns ID of NodeN-th neighboring node.

Range of NodeN: 0 <= NodeN < GetNbrDeg(). Since the graph is undirected GetInNId(), GetOutNId() and GetNbrNId() all give the same output.

Definition at line 100 of file graph.h.

References NodeHI.

Referenced by TSnap::GetCmnNbrs< PUNGraph >(), TLocClustStat::TCutInfo::GetFracDegOut(), TCliqueOverlap::GetNbrs(), and TCliqueOverlap::MaxNbrsInCANDNodeId().

{ return NodeHI.GetDat().GetNbrNId(NodeN); }

Here is the caller graph for this function:

int TUNGraph::TNodeI::GetOutDeg

(

)

const [inline]

Returns out-degree of the current node (returns same as value GetDeg() since the graph is undirected).

Definition at line 85 of file graph.h.

References NodeHI.

Referenced by TSnap::TSnapDetail::_GirvanNewmanGetModularity(), TLocClust::ApproxPageRank(), TLocClustStat::BagOfWhiskers(), TLocClustStat::BagOfWhiskers2(), TUNGraph::BegEI(), TUndirFFire::BurnGeoFire(), TSnap::GetBetweennessCentr(), TLocClust::GetCutStat(), TSnap::GetSubGraph(), TSnap::TSnapDetail::TCNMQMatrix::Init(), TUNGraph::TEdgeI::operator++(), and TLocClust::SupportSweep().

{ return NodeHI.GetDat().GetOutDeg(); }

Here is the caller graph for this function:

int TUNGraph::TNodeI::GetOutNId

(

const int &

NodeN

)

const [inline]

Returns ID of NodeN-th out-node (the node the current node points to).

Range of NodeN: 0 <= NodeN < GetOutDeg(). Since the graph is undirected GetInNId(), GetOutNId() and GetNbrNId() all give the same output.

Definition at line 95 of file graph.h.

References NodeHI.

Referenced by TLocClust::ApproxPageRank(), TUNGraph::BegEI(), TUndirFFire::BurnGeoFire(), TSnap::GetBetweennessCentr(), TLocClust::GetCutStat(), TUNGraph::TEdgeI::GetDstNId(), TSnap::GetSubGraph(), and TLocClust::SupportSweep().

{ return NodeHI.GetDat().GetOutNId(NodeN); }

Here is the caller graph for this function:

bool TUNGraph::TNodeI::IsInNId

(

const int &

NId

)

const [inline]

Tests whether node with ID NId points to the current node.

Definition at line 102 of file graph.h.

References NodeHI.

{ return NodeHI.GetDat().IsInNId(NId); }

bool TUNGraph::TNodeI::IsNbrNId

(

const int &

NId

)

const [inline]

Tests whether node with ID NId is a neighbor of the current node.

Definition at line 106 of file graph.h.

References NodeHI.

{ return NodeHI.GetDat().IsNbrNId(NId); }

bool TUNGraph::TNodeI::IsOutNId

(

const int &

NId

)

const [inline]

Tests whether the current node points to node with ID NId.

Definition at line 104 of file graph.h.

References NodeHI.

{ return NodeHI.GetDat().IsOutNId(NId); }

TNodeI& TUNGraph::TNodeI::operator++

(

int

)

[inline]

Increment iterator.

Definition at line 73 of file graph.h.

References NodeHI.

{ NodeHI++; return *this; }

bool TUNGraph::TNodeI::operator<

(

const TNodeI &

NodeI

)

const [inline]

Definition at line 75 of file graph.h.

References NodeHI.

{ return NodeHI < NodeI.NodeHI; }

TNodeI& TUNGraph::TNodeI::operator=

(

const TNodeI &

NodeI

)

[inline]

Definition at line 70 of file graph.h.

References NodeHI.

{ NodeHI = NodeI.NodeHI; return *this; }

bool TUNGraph::TNodeI::operator==

(

const TNodeI &

NodeI

)

const [inline]

Definition at line 76 of file graph.h.

References NodeHI.

{ return NodeHI == NodeI.NodeHI; }

---

Friends And Related Function Documentation

friend class TUNGraph [friend]

Definition at line 107 of file graph.h.

---

Member Data Documentation

THashIter TUNGraph::TNodeI::NodeHI [private]

Definition at line 65 of file graph.h.

Referenced by GetDeg(), TUNGraph::GetEI(), GetId(), GetInDeg(), GetInNId(), GetNbrNId(), GetOutDeg(), GetOutNId(), IsInNId(), IsNbrNId(), IsOutNId(), operator++(), operator<(), operator=(), and operator==().

---

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

• snap-core/graph.h