SNAP Library, User Reference  2012-10-02 12:56:23
SNAP, a general purpose network analysis and graph mining library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
TNodeNet< TNodeData >::TNodeI Class Reference

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

List of all members.

Public Member Functions

 TNodeI ()
 TNodeI (const THashIter &NodeHIter, const TNodeNet *NetPt)
 TNodeI (const TNodeI &NodeI)
TNodeIoperator= (const TNodeI &NodeI)
TNodeIoperator++ (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)

Friends

class TNodeNet< TNodeData >

Detailed Description

template<class TNodeData>
class TNodeNet< TNodeData >::TNodeI

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


Constructor & Destructor Documentation

template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( ) [inline]
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const THashIter &  NodeHIter,
const TNodeNet NetPt 
) [inline]
template<class TNodeData>
TNodeNet< TNodeData >::TNodeI::TNodeI ( const TNodeI NodeI) [inline]

Member Function Documentation

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

Returns degree of the current node.

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

Returns ID of the current node.

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

Returns in-degree of the current node.

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN) const [inline]
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetInNDat ( const int &  NodeN) [inline]
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().

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN) const [inline]
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetNbrNDat ( const int &  NodeN) [inline]
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().

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

Returns out-degree of the current node.

template<class TNodeData>
const TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN) const [inline]
template<class TNodeData>
TNodeData& TNodeNet< TNodeData >::TNodeI::GetOutNDat ( const int &  NodeN) [inline]
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().

template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::IsInNId ( const int &  NId) const [inline]

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

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.

template<class TNodeData>
bool TNodeNet< TNodeData >::TNodeI::IsOutNId ( const int &  NId) const [inline]

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

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

Increment iterator.

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

Friends And Related Function Documentation

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

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