SNAP Library 3.0, User Reference  2016-07-20 17:56:49
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...
 
void SortNIdV ()
 Sorts the adjacency lists of the current node. 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 64 of file graph.h.

Member Typedef Documentation

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

Definition at line 66 of file graph.h.

Constructor & Destructor Documentation

TUNGraph::TNodeI::TNodeI ( )
inline

Definition at line 69 of file graph.h.

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

Definition at line 70 of file graph.h.

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

Definition at line 71 of file graph.h.

71 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: graph.h:67

Member Function Documentation

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

Returns degree of the current node.

Definition at line 86 of file graph.h.

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

Returns ID of the current node.

Definition at line 84 of file graph.h.

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

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

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

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

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

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

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

Definition at line 109 of file graph.h.

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

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

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

Definition at line 111 of file graph.h.

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

Increment iterator.

Definition at line 75 of file graph.h.

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

Decrement iterator.

Definition at line 77 of file graph.h.

77 { NodeHI--; return *this; }
THashIter NodeHI
Definition: graph.h:67
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:67
TNodeI& TUNGraph::TNodeI::operator= ( const TNodeI NodeI)
inline

Definition at line 72 of file graph.h.

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

Definition at line 81 of file graph.h.

81 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:67
void TUNGraph::TNodeI::SortNIdV ( )
inline

Sorts the adjacency lists of the current node.

Definition at line 92 of file graph.h.

92 { NodeHI.GetDat().SortNIdV(); }
THashIter NodeHI
Definition: graph.h:67

Friends And Related Function Documentation

friend class TUNGraph
friend

Definition at line 114 of file graph.h.

Member Data Documentation

THashIter TUNGraph::TNodeI::NodeHI
private

Definition at line 67 of file graph.h.


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