SNAP Library 2.3, User Reference  2014-06-16 11:58:46
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
TNGraph::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...
 
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 TNGraph
 

Detailed Description

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

Definition at line 324 of file graph.h.

Member Typedef Documentation

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

Definition at line 326 of file graph.h.

Constructor & Destructor Documentation

TNGraph::TNodeI::TNodeI ( )
inline

Definition at line 329 of file graph.h.

329 : NodeHI() { }
THashIter NodeHI
Definition: graph.h:327
TNGraph::TNodeI::TNodeI ( const THashIter NodeHIter)
inline

Definition at line 330 of file graph.h.

330 : NodeHI(NodeHIter) { }
THashIter NodeHI
Definition: graph.h:327
TNGraph::TNodeI::TNodeI ( const TNodeI NodeI)
inline

Definition at line 331 of file graph.h.

331 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: graph.h:327

Member Function Documentation

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

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

Definition at line 340 of file graph.h.

340 { return NodeHI.GetDat().GetDeg(); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::TNodeI::GetId ( ) const
inline

Returns ID of the current node.

Definition at line 338 of file graph.h.

338 { return NodeHI.GetDat().GetId(); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::TNodeI::GetInDeg ( ) const
inline

Returns in-degree of the current node.

Definition at line 342 of file graph.h.

342 { return NodeHI.GetDat().GetInDeg(); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::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 348 of file graph.h.

348 { return NodeHI.GetDat().GetInNId(NodeN); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::TNodeI::GetNbrNId ( const int &  NodeN) const
inline

Returns ID of NodeN-th neighboring node.

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

Definition at line 356 of file graph.h.

356 { return NodeHI.GetDat().GetNbrNId(NodeN); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::TNodeI::GetOutDeg ( ) const
inline

Returns out-degree of the current node.

Definition at line 344 of file graph.h.

344 { return NodeHI.GetDat().GetOutDeg(); }
THashIter NodeHI
Definition: graph.h:327
int TNGraph::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 352 of file graph.h.

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

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

Definition at line 358 of file graph.h.

358 { return NodeHI.GetDat().IsInNId(NId); }
THashIter NodeHI
Definition: graph.h:327
bool TNGraph::TNodeI::IsNbrNId ( const int &  NId) const
inline

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

Definition at line 362 of file graph.h.

362 { return IsOutNId(NId) || IsInNId(NId); }
bool IsInNId(const int &NId) const
Tests whether node with ID NId points to the current node.
Definition: graph.h:358
bool IsOutNId(const int &NId) const
Tests whether the current node points to node with ID NId.
Definition: graph.h:360
bool TNGraph::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 360 of file graph.h.

360 { return NodeHI.GetDat().IsOutNId(NId); }
THashIter NodeHI
Definition: graph.h:327
TNodeI& TNGraph::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 334 of file graph.h.

334 { NodeHI++; return *this; }
THashIter NodeHI
Definition: graph.h:327
bool TNGraph::TNodeI::operator< ( const TNodeI NodeI) const
inline

Definition at line 335 of file graph.h.

335 { return NodeHI < NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:327
TNodeI& TNGraph::TNodeI::operator= ( const TNodeI NodeI)
inline

Definition at line 332 of file graph.h.

332 { NodeHI = NodeI.NodeHI; return *this; }
THashIter NodeHI
Definition: graph.h:327
bool TNGraph::TNodeI::operator== ( const TNodeI NodeI) const
inline

Definition at line 336 of file graph.h.

336 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:327

Friends And Related Function Documentation

friend class TNGraph
friend

Definition at line 363 of file graph.h.

Member Data Documentation

THashIter TNGraph::TNodeI::NodeHI
private

Definition at line 327 of file graph.h.


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