SNAP Library 2.0, Developer Reference  2013-05-13 16:33:57
SNAP, a general purpose, high performance system for analysis and manipulation of large networks
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Types | Private Attributes | Friends
TNodeNet< TNodeData >::TNodeI Class Reference

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

#include <network.h>

Collaboration diagram for TNodeNet< TNodeData >::TNodeI:
Collaboration graph
[legend]

List of all members.

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.
bool operator< (const TNodeI &NodeI) const
bool operator== (const TNodeI &NodeI) const
int GetId () const
 Returns ID of the current node.
int GetDeg () const
 Returns degree of the current node.
int GetInDeg () const
 Returns in-degree of the current node.
int GetOutDeg () const
 Returns out-degree of the current node.
int GetInNId (const int &NodeN) const
 Returns ID of NodeN-th in-node (the node pointing to the current node).
int GetOutNId (const int &NodeN) const
 Returns ID of NodeN-th out-node (the node the current node points to).
int GetNbrNId (const int &NodeN) const
 Returns ID of NodeN-th neighboring node.
bool IsInNId (const int &NId) const
 Tests whether node with ID NId points to the current node.
bool IsOutNId (const int &NId) const
 Tests whether the current node points to node with ID NId.
bool IsNbrNId (const int &NId) const
 Tests whether node with ID NId is a neighbor of the current node.
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 49 of file network.h.

Member Typedef Documentation

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

Definition at line 51 of file network.h.

Constructor & Destructor Documentation

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

Definition at line 55 of file network.h.

: NodeHI(), Net(NULL) { }
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const THashIter &  NodeHIter,
const TNodeNet *  NetPt 
) [inline]

Definition at line 56 of file network.h.

: NodeHI(NodeHIter), Net((TNodeNet *) NetPt) { }
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const TNodeI &  NodeI) [inline]

Definition at line 57 of file network.h.

: NodeHI(NodeI.NodeHI), Net(NodeI.Net) { }

Member Function Documentation

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

Definition at line 92 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TEdgeI::GetSrcNDat().

{ return NodeHI.GetDat().GetDat(); }

Here is the caller graph for this function:

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

Definition at line 93 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI.GetDat().GetDat(); }
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetDeg ( ) const [inline]

Returns degree of the current node.

Definition at line 67 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI.GetDat().GetDeg(); }
template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetId ( ) const [inline]

Returns ID of the current node.

Definition at line 65 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TEdgeI::GetSrcNId().

{ return NodeHI.GetDat().GetId(); }

Here is the caller graph for this function:

template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetInDeg ( ) const [inline]

Returns in-degree of the current node.

Definition at line 69 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI.GetDat().GetInDeg(); }
template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN) const [inline]

Definition at line 94 of file network.h.

References TNodeNet< TNodeData >::TNodeI::GetInNId(), TNodeNet< TNodeData >::GetNDat(), and TNodeNet< TNodeData >::TNodeI::Net.

{ return Net->GetNDat(GetInNId(NodeN)); }

Here is the call graph for this function:

template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN) [inline]

Definition at line 95 of file network.h.

References TNodeNet< TNodeData >::TNodeI::GetInNId(), TNodeNet< TNodeData >::GetNDat(), and TNodeNet< TNodeData >::TNodeI::Net.

{ return Net->GetNDat(GetInNId(NodeN)); }

Here is the call graph for this function:

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 75 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TNodeI::GetInNDat().

{ return NodeHI.GetDat().GetInNId(NodeN); }

Here is the caller graph for this function:

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN) const [inline]

Definition at line 98 of file network.h.

References TNodeNet< TNodeData >::TNodeI::GetNbrNId(), TNodeNet< TNodeData >::GetNDat(), and TNodeNet< TNodeData >::TNodeI::Net.

{ return Net->GetNDat(GetNbrNId(NodeN)); }

Here is the call graph for this function:

template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN) [inline]

Definition at line 99 of file network.h.

References TNodeNet< TNodeData >::TNodeI::GetNbrNId(), TNodeNet< TNodeData >::GetNDat(), and TNodeNet< TNodeData >::TNodeI::Net.

{ return Net->GetNDat(GetNbrNId(NodeN)); }

Here is the call graph for this function:

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 83 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TNodeI::GetNbrNDat().

{ return NodeHI.GetDat().GetNbrNId(NodeN); }

Here is the caller graph for this function:

template<class TNodeData>
int TNodeNet< TNodeData >::TNodeI::GetOutDeg ( ) const [inline]

Returns out-degree of the current node.

Definition at line 71 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TSecTm >::BegEI(), and TNodeNet< TNodeData >::TEdgeI::operator++().

{ return NodeHI.GetDat().GetOutDeg(); }

Here is the caller graph for this function:

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN) const [inline]

Definition at line 96 of file network.h.

References TNodeNet< TNodeData >::GetNDat(), TNodeNet< TNodeData >::TNodeI::GetOutNId(), and TNodeNet< TNodeData >::TNodeI::Net.

Referenced by TNodeNet< TNodeData >::TEdgeI::GetDstNDat().

{ return Net->GetNDat(GetOutNId(NodeN)); }

Here is the call graph for this function:

Here is the caller graph for this function:

template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN) [inline]

Definition at line 97 of file network.h.

References TNodeNet< TNodeData >::GetNDat(), TNodeNet< TNodeData >::TNodeI::GetOutNId(), and TNodeNet< TNodeData >::TNodeI::Net.

{ return Net->GetNDat(GetOutNId(NodeN)); }

Here is the call graph for this function:

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 79 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TEdgeI::GetDstNId(), and TNodeNet< TNodeData >::TNodeI::GetOutNDat().

{ return NodeHI.GetDat().GetOutNId(NodeN); }

Here is the caller graph for this function:

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 85 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TNodeI::IsNbrNId().

{ return NodeHI.GetDat().IsInNId(NId); }

Here is the caller graph for this function:

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 89 of file network.h.

References TNodeNet< TNodeData >::TNodeI::IsInNId(), and TNodeNet< TNodeData >::TNodeI::IsOutNId().

{ return IsOutNId(NId) || IsInNId(NId); }

Here is the call graph for this function:

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 87 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

Referenced by TNodeNet< TNodeData >::TNodeI::IsNbrNId().

{ return NodeHI.GetDat().IsOutNId(NId); }

Here is the caller graph for this function:

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::operator() ( ) const [inline]

Definition at line 90 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI.GetDat().NodeDat; }
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::operator() ( ) [inline]

Definition at line 91 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI.GetDat().GetDat(); }
template<class TNodeData>
TNodeI& TNodeNet< TNodeData >::TNodeI::operator++ ( int  ) [inline]

Increment iterator.

Definition at line 60 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ NodeHI++;  return *this; }
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::operator< ( const TNodeI &  NodeI) const [inline]

Definition at line 61 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI < NodeI.NodeHI; }
template<class TNodeData>
TNodeI& TNodeNet< TNodeData >::TNodeI::operator= ( const TNodeI &  NodeI) [inline]

Definition at line 58 of file network.h.

References TNodeNet< TNodeData >::TNodeI::Net, and TNodeNet< TNodeData >::TNodeI::NodeHI.

{ NodeHI=NodeI.NodeHI; Net=NodeI.Net; return *this; }
template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::operator== ( const TNodeI &  NodeI) const [inline]

Definition at line 62 of file network.h.

References TNodeNet< TNodeData >::TNodeI::NodeHI.

{ return NodeHI == NodeI.NodeHI; }

Friends And Related Function Documentation

template<class TNodeData>
friend class TNodeNet< TNodeData > [friend]

Definition at line 100 of file network.h.

Member Data Documentation

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

Definition at line 53 of file network.h.

Referenced by TNodeNet< TNodeData >::TNodeI::GetInNDat(), TNodeNet< TNodeData >::TNodeI::GetNbrNDat(), TNodeNet< TNodeData >::TNodeI::GetOutNDat(), and TNodeNet< TNodeData >::TNodeI::operator=().

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

Definition at line 52 of file network.h.

Referenced by TNodeNet< TNodeData >::TNodeI::GetDat(), TNodeNet< TNodeData >::TNodeI::GetDeg(), TNodeNet< TNodeData >::GetEI(), TNodeNet< TNodeData >::TNodeI::GetId(), TNodeNet< TNodeData >::TNodeI::GetInDeg(), TNodeNet< TNodeData >::TNodeI::GetInNId(), TNodeNet< TNodeData >::TNodeI::GetNbrNId(), TNodeNet< TNodeData >::TNodeI::GetOutDeg(), TNodeNet< TNodeData >::TNodeI::GetOutNId(), TNodeNet< TNodeData >::TNodeI::IsInNId(), TNodeNet< TNodeData >::TNodeI::IsOutNId(), TNodeNet< TNodeData >::TNodeI::operator()(), TNodeNet< TNodeData >::TNodeI::operator++(), TNodeNet< TNodeData >::TNodeI::operator<(), TNodeNet< TNodeData >::TNodeI::operator=(), and TNodeNet< TNodeData >::TNodeI::operator==().

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