SNAP Library 2.4, User Reference  2015-05-11 19:40:56
SNAP, a general purpose, high performance system for analysis and manipulation of large networks
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
TUNGraph::TNodeI Class Reference

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

#include <graph.h>

Public Member Functions

 TNodeI ()
 
 TNodeI (const THashIter &NodeHIter)
 
 TNodeI (const TNodeI &NodeI)
 
TNodeIoperator= (const TNodeI &NodeI)
 
TNodeIoperator++ (int)
 Increment iterator. More...
 
TNodeIoperator-- (int)
 Decrement iterator. More...
 
bool operator< (const TNodeI &NodeI) const
 
bool operator== (const TNodeI &NodeI) const
 
int GetId () const
 Returns ID of the current node. More...
 
int GetDeg () const
 Returns degree of the current node. More...
 
int GetInDeg () const
 Returns in-degree of the current node (returns same as value GetDeg() since the graph is undirected). More...
 
int GetOutDeg () const
 Returns out-degree of the current node (returns same as value GetDeg() since the graph is undirected). More...
 
int GetInNId (const int &NodeN) const
 Returns ID of NodeN-th in-node (the node pointing to the current node). More...
 
int GetOutNId (const int &NodeN) const
 Returns ID of NodeN-th out-node (the node the current node points to). More...
 
int GetNbrNId (const int &NodeN) const
 Returns ID of NodeN-th neighboring node. More...
 
bool IsInNId (const int &NId) const
 Tests whether node with ID NId points to the current node. More...
 
bool IsOutNId (const int &NId) const
 Tests whether the current node points to node with ID NId. More...
 
bool IsNbrNId (const int &NId) const
 Tests whether node with ID NId is a neighbor of the current node. More...
 

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 63 of file graph.h.

Member Typedef Documentation

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

Definition at line 65 of file graph.h.

Constructor & Destructor Documentation

TUNGraph::TNodeI::TNodeI ( )
inline

Definition at line 68 of file graph.h.

68 : NodeHI() { }
THashIter NodeHI
Definition: graph.h:66
TUNGraph::TNodeI::TNodeI ( const THashIter NodeHIter)
inline

Definition at line 69 of file graph.h.

69 : NodeHI(NodeHIter) { }
THashIter NodeHI
Definition: graph.h:66
TUNGraph::TNodeI::TNodeI ( const TNodeI NodeI)
inline

Definition at line 70 of file graph.h.

70 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: graph.h:66

Member Function Documentation

int TUNGraph::TNodeI::GetDeg ( ) const
inline

Returns degree of the current node.

Definition at line 85 of file graph.h.

85 { return NodeHI.GetDat().GetDeg(); }
THashIter NodeHI
Definition: graph.h:66
int TUNGraph::TNodeI::GetId ( ) const
inline

Returns ID of the current node.

Definition at line 83 of file graph.h.

83 { return NodeHI.GetDat().GetId(); }
THashIter NodeHI
Definition: graph.h:66
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 87 of file graph.h.

87 { return NodeHI.GetDat().GetInDeg(); }
THashIter NodeHI
Definition: graph.h:66
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 94 of file graph.h.

94 { return NodeHI.GetDat().GetInNId(NodeN); }
THashIter NodeHI
Definition: graph.h:66
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 104 of file graph.h.

104 { return NodeHI.GetDat().GetNbrNId(NodeN); }
THashIter NodeHI
Definition: graph.h:66
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 89 of file graph.h.

89 { return NodeHI.GetDat().GetOutDeg(); }
THashIter NodeHI
Definition: graph.h:66
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 99 of file graph.h.

99 { return NodeHI.GetDat().GetOutNId(NodeN); }
THashIter NodeHI
Definition: graph.h:66
bool TUNGraph::TNodeI::IsInNId ( const int &  NId) const
inline

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

Definition at line 106 of file graph.h.

106 { return NodeHI.GetDat().IsInNId(NId); }
THashIter NodeHI
Definition: graph.h:66
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 110 of file graph.h.

110 { return NodeHI.GetDat().IsNbrNId(NId); }
THashIter NodeHI
Definition: graph.h:66
bool TUNGraph::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 108 of file graph.h.

108 { return NodeHI.GetDat().IsOutNId(NId); }
THashIter NodeHI
Definition: graph.h:66
TNodeI& TUNGraph::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 74 of file graph.h.

74 { NodeHI++; return *this; }
THashIter NodeHI
Definition: graph.h:66
TNodeI& TUNGraph::TNodeI::operator-- ( int  )
inline

Decrement iterator.

Definition at line 76 of file graph.h.

76 { NodeHI--; return *this; }
THashIter NodeHI
Definition: graph.h:66
bool TUNGraph::TNodeI::operator< ( const TNodeI NodeI) const
inline

Definition at line 79 of file graph.h.

79 { return NodeHI < NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:66
TNodeI& TUNGraph::TNodeI::operator= ( const TNodeI NodeI)
inline

Definition at line 71 of file graph.h.

71 { NodeHI = NodeI.NodeHI; return *this; }
THashIter NodeHI
Definition: graph.h:66
bool TUNGraph::TNodeI::operator== ( const TNodeI NodeI) const
inline

Definition at line 80 of file graph.h.

80 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:66

Friends And Related Function Documentation

friend class TUNGraph
friend

Definition at line 111 of file graph.h.

Member Data Documentation

THashIter TUNGraph::TNodeI::NodeHI
private

Definition at line 66 of file graph.h.


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