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
TDirNet::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, the sum of in-degree and out-degree. 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...
 

Private Types

typedef THash< TInt, TNode >::TIter THashIter
 

Private Attributes

THashIter NodeHI
 

Friends

class TDirNet
 

Detailed Description

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

Definition at line 3298 of file network.h.

Member Typedef Documentation

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

Definition at line 3300 of file network.h.

Constructor & Destructor Documentation

TDirNet::TNodeI::TNodeI ( )
inline

Definition at line 3303 of file network.h.

3303 : NodeHI() { }
THashIter NodeHI
Definition: network.h:3301
TDirNet::TNodeI::TNodeI ( const THashIter NodeHIter)
inline

Definition at line 3304 of file network.h.

3304 : NodeHI(NodeHIter) { }
THashIter NodeHI
Definition: network.h:3301
TDirNet::TNodeI::TNodeI ( const TNodeI NodeI)
inline

Definition at line 3305 of file network.h.

3305 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: network.h:3301

Member Function Documentation

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

Returns degree of the current node, the sum of in-degree and out-degree.

Definition at line 3317 of file network.h.

3317 { return NodeHI.GetDat().GetDeg(); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::TNodeI::GetId ( ) const
inline

Returns ID of the current node.

Definition at line 3315 of file network.h.

3315 { return NodeHI.GetDat().GetId(); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::TNodeI::GetInDeg ( ) const
inline

Returns in-degree of the current node.

Definition at line 3319 of file network.h.

3319 { return NodeHI.GetDat().GetInDeg(); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::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 3325 of file network.h.

3325 { return NodeHI.GetDat().GetInNId(NodeN); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::TNodeI::GetNbrNId ( const int &  NodeN) const
inline

Returns ID of NodeN-th neighboring node.

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

Definition at line 3333 of file network.h.

3333 { return NodeHI.GetDat().GetNbrNId(NodeN); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::TNodeI::GetOutDeg ( ) const
inline

Returns out-degree of the current node.

Definition at line 3321 of file network.h.

3321 { return NodeHI.GetDat().GetOutDeg(); }
THashIter NodeHI
Definition: network.h:3301
int TDirNet::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 3329 of file network.h.

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

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

Definition at line 3335 of file network.h.

3335 { return NodeHI.GetDat().IsInNId(NId); }
THashIter NodeHI
Definition: network.h:3301
bool TDirNet::TNodeI::IsNbrNId ( const int &  NId) const
inline

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

Definition at line 3339 of file network.h.

3339 { return IsOutNId(NId) || IsInNId(NId); }
bool IsOutNId(const int &NId) const
Tests whether the current node points to node with ID NId.
Definition: network.h:3337
bool IsInNId(const int &NId) const
Tests whether node with ID NId points to the current node.
Definition: network.h:3335
bool TDirNet::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 3337 of file network.h.

3337 { return NodeHI.GetDat().IsOutNId(NId); }
THashIter NodeHI
Definition: network.h:3301
TNodeI& TDirNet::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 3308 of file network.h.

3308 { NodeHI++; return *this; }
THashIter NodeHI
Definition: network.h:3301
TNodeI& TDirNet::TNodeI::operator-- ( int  )
inline

Decrement iterator.

Definition at line 3310 of file network.h.

3310 { NodeHI--; return *this; }
THashIter NodeHI
Definition: network.h:3301
bool TDirNet::TNodeI::operator< ( const TNodeI NodeI) const
inline

Definition at line 3312 of file network.h.

3312 { return NodeHI < NodeI.NodeHI; }
THashIter NodeHI
Definition: network.h:3301
TNodeI& TDirNet::TNodeI::operator= ( const TNodeI NodeI)
inline

Definition at line 3306 of file network.h.

3306 { NodeHI = NodeI.NodeHI; return *this; }
THashIter NodeHI
Definition: network.h:3301
bool TDirNet::TNodeI::operator== ( const TNodeI NodeI) const
inline

Definition at line 3313 of file network.h.

3313 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: network.h:3301

Friends And Related Function Documentation

friend class TDirNet
friend

Definition at line 3340 of file network.h.

Member Data Documentation

THashIter TDirNet::TNodeI::NodeHI
private

Definition at line 3301 of file network.h.


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