SNAP Library 3.0, Developer 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
TNGraph::TNodeI Class Reference

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

#include <graph.h>

Collaboration diagram for TNGraph::TNodeI:

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...
 
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 TNGraph
 

Detailed Description

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

Definition at line 339 of file graph.h.

Member Typedef Documentation

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

Definition at line 341 of file graph.h.

Constructor & Destructor Documentation

TNGraph::TNodeI::TNodeI ( )
inline

Definition at line 344 of file graph.h.

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

Definition at line 345 of file graph.h.

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

Definition at line 346 of file graph.h.

346 : NodeHI(NodeI.NodeHI) { }
THashIter NodeHI
Definition: graph.h:342

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 358 of file graph.h.

References NodeHI.

Referenced by TSnap::CountTriangles(), TSnap::GetEgonet(), TSubGraphEnum< TGraphCounter >::GetSubGraphs(), TSubGraphEnum< TGraphCounter >::GetSubGraphs_recursive(), TSnap::TSnapDetail::inComp(), TCoda::MLEGradAscentParallel(), TCoda::NeighborComInit(), TCodaAnalyzer::Net2ModeCommunities(), and TKroneckerLL::SetBestDegPerm().

358 { return NodeHI.GetDat().GetDeg(); }
THashIter NodeHI
Definition: graph.h:342

Here is the caller graph for this function:

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

Returns ID of the current node.

Definition at line 356 of file graph.h.

References NodeHI.

Referenced by TNGraph::AddNode(), TSnap::CountTriangles(), TGHash< TDat >::GetNodeMap(), TNGraph::TEdgeI::GetSrcNId(), and TSubGraphsEnum::RecurBfs().

356 { return NodeHI.GetDat().GetId(); }
THashIter NodeHI
Definition: graph.h:342

Here is the caller graph for this function:

int TNGraph::TNodeI::GetInNId ( const int &  NodeN) const
inline
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 376 of file graph.h.

References NodeHI.

Referenced by TSnap::GetEgonet(), TGraphEnumUtils::GetIndGraph(), TSubGraphEnum< TGraphCounter >::GetSubGraphs(), TSubGraphEnum< TGraphCounter >::GetSubGraphs_recursive(), TCoda::MLEGradAscentParallel(), and TCoda::NeighborComInit().

376 { return NodeHI.GetDat().GetNbrNId(NodeN); }
THashIter NodeHI
Definition: graph.h:342

Here is the caller graph for this function:

bool TNGraph::TNodeI::IsInNId ( const int &  NId) const
inline

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

Definition at line 378 of file graph.h.

References NodeHI.

Referenced by IsNbrNId().

378 { return NodeHI.GetDat().IsInNId(NId); }
THashIter NodeHI
Definition: graph.h:342

Here is the caller graph for this function:

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 382 of file graph.h.

References IsInNId(), and IsOutNId().

382 { 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:378
bool IsOutNId(const int &NId) const
Tests whether the current node points to node with ID NId.
Definition: graph.h:380

Here is the call graph for this function:

bool TNGraph::TNodeI::IsOutNId ( const int &  NId) const
inline

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

Definition at line 380 of file graph.h.

References NodeHI.

Referenced by IsNbrNId().

380 { return NodeHI.GetDat().IsOutNId(NId); }
THashIter NodeHI
Definition: graph.h:342

Here is the caller graph for this function:

TNodeI& TNGraph::TNodeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 349 of file graph.h.

References NodeHI.

349 { NodeHI++; return *this; }
THashIter NodeHI
Definition: graph.h:342
TNodeI& TNGraph::TNodeI::operator-- ( int  )
inline

Decrement iterator.

Definition at line 351 of file graph.h.

References NodeHI.

351 { NodeHI--; return *this; }
THashIter NodeHI
Definition: graph.h:342
bool TNGraph::TNodeI::operator< ( const TNodeI NodeI) const
inline

Definition at line 353 of file graph.h.

References NodeHI.

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

Definition at line 347 of file graph.h.

References NodeHI.

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

Definition at line 354 of file graph.h.

References NodeHI.

354 { return NodeHI == NodeI.NodeHI; }
THashIter NodeHI
Definition: graph.h:342
void TNGraph::TNodeI::SortNIdV ( )
inline

Sorts the adjacency lists of the current node.

Definition at line 364 of file graph.h.

References NodeHI.

364 { NodeHI.GetDat().SortNIdV(); }
THashIter NodeHI
Definition: graph.h:342

Friends And Related Function Documentation

friend class TNGraph
friend

Definition at line 383 of file graph.h.

Member Data Documentation


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