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
TUndirNet::TNodeI Class Reference

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

#include <network.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 network is undirected). More...
 
int GetOutDeg () const
 Returns out-degree of the current node (returns same as value GetDeg() since the network 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 TUndirNet
 

Detailed Description

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

Definition at line 2779 of file network.h.

Member Typedef Documentation

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

Definition at line 2781 of file network.h.

Constructor & Destructor Documentation

TUndirNet::TNodeI::TNodeI ( )
inline

Definition at line 2784 of file network.h.

2784 : NodeHI() { }
THashIter NodeHI
Definition: network.h:2782
TUndirNet::TNodeI::TNodeI ( const THashIter NodeHIter)
inline

Definition at line 2785 of file network.h.

2785 : NodeHI(NodeHIter) { }
THashIter NodeHI
Definition: network.h:2782
TUndirNet::TNodeI::TNodeI ( const TNodeI NodeI)
inline

Definition at line 2786 of file network.h.

2786 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: network.h:2782

Member Function Documentation

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

Returns degree of the current node.

Definition at line 2801 of file network.h.

2801 { return NodeHI.GetDat().GetDeg(); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::TNodeI::GetId ( ) const
inline

Returns ID of the current node.

Definition at line 2799 of file network.h.

2799 { return NodeHI.GetDat().GetId(); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::TNodeI::GetInDeg ( ) const
inline

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

Definition at line 2803 of file network.h.

2803 { return NodeHI.GetDat().GetInDeg(); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::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 2810 of file network.h.

2810 { return NodeHI.GetDat().GetInNId(NodeN); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::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 2820 of file network.h.

2820 { return NodeHI.GetDat().GetNbrNId(NodeN); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::TNodeI::GetOutDeg ( ) const
inline

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

Definition at line 2805 of file network.h.

2805 { return NodeHI.GetDat().GetOutDeg(); }
THashIter NodeHI
Definition: network.h:2782
int TUndirNet::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 2815 of file network.h.

2815 { return NodeHI.GetDat().GetOutNId(NodeN); }
THashIter NodeHI
Definition: network.h:2782
bool TUndirNet::TNodeI::IsInNId ( const int &  NId) const
inline

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

Definition at line 2822 of file network.h.

2822 { return NodeHI.GetDat().IsInNId(NId); }
THashIter NodeHI
Definition: network.h:2782
bool TUndirNet::TNodeI::IsNbrNId ( const int &  NId) const
inline

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

Definition at line 2826 of file network.h.

2826 { return NodeHI.GetDat().IsNbrNId(NId); }
THashIter NodeHI
Definition: network.h:2782
bool TUndirNet::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 2824 of file network.h.

2824 { return NodeHI.GetDat().IsOutNId(NId); }
THashIter NodeHI
Definition: network.h:2782
TNodeI& TUndirNet::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 2790 of file network.h.

2790 { NodeHI++; return *this; }
THashIter NodeHI
Definition: network.h:2782
TNodeI& TUndirNet::TNodeI::operator-- ( int  )
inline

Decrement iterator.

Definition at line 2792 of file network.h.

2792 { NodeHI--; return *this; }
THashIter NodeHI
Definition: network.h:2782
bool TUndirNet::TNodeI::operator< ( const TNodeI NodeI) const
inline

Definition at line 2795 of file network.h.

2795 { return NodeHI < NodeI.NodeHI; }
THashIter NodeHI
Definition: network.h:2782
TNodeI& TUndirNet::TNodeI::operator= ( const TNodeI NodeI)
inline

Definition at line 2787 of file network.h.

2787 { NodeHI = NodeI.NodeHI; return *this; }
THashIter NodeHI
Definition: network.h:2782
bool TUndirNet::TNodeI::operator== ( const TNodeI NodeI) const
inline

Definition at line 2796 of file network.h.

2796 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: network.h:2782

Friends And Related Function Documentation

friend class TUndirNet
friend

Definition at line 2827 of file network.h.

Member Data Documentation

THashIter TUndirNet::TNodeI::NodeHI
private

Definition at line 2782 of file network.h.


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