SNAP Library 6.0, User Reference  2020-12-09 16:24:20
SNAP, a general purpose, high performance system for analysis and manipulation of large networks
Public Member Functions | Private Types | Private Attributes | Friends | List of all members
TNodeNet< TNodeData >::TNodeI Class Reference

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

#include <network.h>

Public Member Functions

 TNodeI ()
 
 TNodeI (const THashIter &NodeHIter, const TNodeNet *NetPt)
 
 TNodeI (const TNodeI &NodeI)
 
TNodeI & operator= (const TNodeI &NodeI)
 
TNodeI & operator++ (int)
 Increment 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. More...
 
int GetOutDeg () const
 Returns out-degree 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...
 
const TNodeData & operator() () const
 
TNodeData & operator() ()
 
const TNodeData & GetDat () const
 
TNodeData & GetDat ()
 
const TNodeData & GetInNDat (const int &NodeN) const
 
TNodeData & GetInNDat (const int &NodeN)
 
const TNodeData & GetOutNDat (const int &NodeN) const
 
TNodeData & GetOutNDat (const int &NodeN)
 
const TNodeData & GetNbrNDat (const int &NodeN) const
 
TNodeData & GetNbrNDat (const int &NodeN)
 

Private Types

typedef THash< TInt, TNode >::TIter THashIter
 

Private Attributes

THashIter NodeHI
 
TNodeNet * Net
 

Friends

class TNodeNet< TNodeData >
 

Detailed Description

template<class TNodeData>
class TNodeNet< TNodeData >::TNodeI

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

Definition at line 58 of file network.h.

Member Typedef Documentation

template<class TNodeData>
typedef THash<TInt, TNode>::TIter TNodeNet< TNodeData >::TNodeI::THashIter
private

Definition at line 60 of file network.h.

Constructor & Destructor Documentation

template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( )
inline

Definition at line 64 of file network.h.

64 : NodeHI(), Net(NULL) { }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const THashIter &  NodeHIter,
const TNodeNet *  NetPt 
)
inline

Definition at line 65 of file network.h.

65 : NodeHI(NodeHIter), Net((TNodeNet *) NetPt) { }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
TNodeNet
Node Network (directed graph, TNGraph with data on nodes only).
Definition: network.h:17
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const TNodeI &  NodeI)
inline

Definition at line 66 of file network.h.

66 : NodeHI(NodeI.NodeHI), Net(NodeI.Net) { }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62

Member Function Documentation

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetDat ( ) const
inline

Definition at line 101 of file network.h.

101 { return NodeHI.GetDat().GetDat(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetDat ( )
inline

Definition at line 102 of file network.h.

102 { return NodeHI.GetDat().GetDat(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetDeg ( ) const
inline

Returns degree of the current node.

Definition at line 76 of file network.h.

76 { return NodeHI.GetDat().GetDeg(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetId ( ) const
inline

Returns ID of the current node.

Definition at line 74 of file network.h.

74 { return NodeHI.GetDat().GetId(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetInDeg ( ) const
inline

Returns in-degree of the current node.

Definition at line 78 of file network.h.

78 { return NodeHI.GetDat().GetInDeg(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN) const
inline

Definition at line 103 of file network.h.

103 { return Net->GetNDat(GetInNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::GetInNId
int GetInNId(const int &NodeN) const
Returns ID of NodeN-th in-node (the node pointing to the current node).
Definition: network.h:84
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN)
inline

Definition at line 104 of file network.h.

104 { return Net->GetNDat(GetInNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::GetInNId
int GetInNId(const int &NodeN) const
Returns ID of NodeN-th in-node (the node pointing to the current node).
Definition: network.h:84
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
template<class TNodeData>
int TNodeNet< TNodeData >::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().

Definition at line 84 of file network.h.

84 { return NodeHI.GetDat().GetInNId(NodeN); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN) const
inline

Definition at line 107 of file network.h.

107 { return Net->GetNDat(GetNbrNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
TNodeNet::TNodeI::GetNbrNId
int GetNbrNId(const int &NodeN) const
Returns ID of NodeN-th neighboring node.
Definition: network.h:92
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN)
inline

Definition at line 108 of file network.h.

108 { return Net->GetNDat(GetNbrNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
TNodeNet::TNodeI::GetNbrNId
int GetNbrNId(const int &NodeN) const
Returns ID of NodeN-th neighboring node.
Definition: network.h:92
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetNbrNId ( const int &  NodeN) const
inline

Returns ID of NodeN-th neighboring node.

Range of NodeN: 0 <= NodeN < GetNbrDeg().

Definition at line 92 of file network.h.

92 { return NodeHI.GetDat().GetNbrNId(NodeN); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetOutDeg ( ) const
inline

Returns out-degree of the current node.

Definition at line 80 of file network.h.

80 { return NodeHI.GetDat().GetOutDeg(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN) const
inline

Definition at line 105 of file network.h.

105 { return Net->GetNDat(GetOutNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
TNodeNet::TNodeI::GetOutNId
int GetOutNId(const int &NodeN) const
Returns ID of NodeN-th out-node (the node the current node points to).
Definition: network.h:88
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN)
inline

Definition at line 106 of file network.h.

106 { return Net->GetNDat(GetOutNId(NodeN)); }
TNodeNet::GetNDat
TNodeData & GetNDat(const int &NId)
Returns node data for the node of ID NId in the network.
Definition: network.h:229
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
TNodeNet::TNodeI::GetOutNId
int GetOutNId(const int &NodeN) const
Returns ID of NodeN-th out-node (the node the current node points to).
Definition: network.h:88
template<class TNodeData>
int TNodeNet< TNodeData >::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().

Definition at line 88 of file network.h.

88 { return NodeHI.GetDat().GetOutNId(NodeN); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::IsInNId ( const int &  NId) const
inline

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

Definition at line 94 of file network.h.

94 { return NodeHI.GetDat().IsInNId(NId); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::IsNbrNId ( const int &  NId) const
inline

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

Definition at line 98 of file network.h.

98 { return IsOutNId(NId) || IsInNId(NId); }
TNodeNet::TNodeI::IsOutNId
bool IsOutNId(const int &NId) const
Tests whether the current node points to node with ID NId.
Definition: network.h:96
TNodeNet::TNodeI::IsInNId
bool IsInNId(const int &NId) const
Tests whether node with ID NId points to the current node.
Definition: network.h:94
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 96 of file network.h.

96 { return NodeHI.GetDat().IsOutNId(NId); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::operator() ( ) const
inline

Definition at line 99 of file network.h.

99 { return NodeHI.GetDat().NodeDat; }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::operator() ( )
inline

Definition at line 100 of file network.h.

100 { return NodeHI.GetDat().GetDat(); }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
TNodeI& TNodeNet< TNodeData >::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 69 of file network.h.

69 { NodeHI++; return *this; }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::operator< ( const TNodeI &  NodeI) const
inline

Definition at line 70 of file network.h.

70 { return NodeHI < NodeI.NodeHI; }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
template<class TNodeData>
TNodeI& TNodeNet< TNodeData >::TNodeI::operator= ( const TNodeI &  NodeI)
inline

Definition at line 67 of file network.h.

67 { NodeHI=NodeI.NodeHI; Net=NodeI.Net; return *this; }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61
TNodeNet::TNodeI::Net
TNodeNet * Net
Definition: network.h:62
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::operator== ( const TNodeI &  NodeI) const
inline

Definition at line 71 of file network.h.

71 { return NodeHI == NodeI.NodeHI; }
TNodeNet::TNodeI::NodeHI
THashIter NodeHI
Definition: network.h:61

Friends And Related Function Documentation

template<class TNodeData>
friend class TNodeNet< TNodeData >
friend

Definition at line 109 of file network.h.

Member Data Documentation

template<class TNodeData>
TNodeNet* TNodeNet< TNodeData >::TNodeI::Net
private

Definition at line 62 of file network.h.

template<class TNodeData>
THashIter TNodeNet< TNodeData >::TNodeI::NodeHI
private

Definition at line 61 of file network.h.

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