SNAP Library 4.1, Developer Reference  2018-07-26 16:30:42
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
Public Member Functions | Private Attributes | Friends | List of all members
TUndirNet::TEdgeI Class Reference

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

#include <network.h>

Collaboration diagram for TUndirNet::TEdgeI:
Collaboration graph
[legend]

Public Member Functions

 TEdgeI ()
 
 TEdgeI (const TNodeI &NodeI, const TNodeI &EndNodeI, const int &EdgeN=0)
 
 TEdgeI (const TEdgeI &EdgeI)
 
TEdgeI & operator= (const TEdgeI &EdgeI)
 
TEdgeI & operator++ (int)
 Increment iterator. More...
 
bool operator< (const TEdgeI &EdgeI) const
 
bool operator== (const TEdgeI &EdgeI) const
 
int GetId () const
 Returns edge ID. Always returns -1 since only edges in multigraphs have explicit IDs. More...
 
int GetSrcNId () const
 Returns the source of the edge. Since the network is undirected, this is the node with a smaller ID of the edge endpoints. More...
 
int GetDstNId () const
 Returns the destination of the edge. Since the network is undirected, this is the node with a greater ID of the edge endpoints. More...
 

Private Attributes

TNodeI CurNode
 
TNodeI EndNode
 
int CurEdge
 

Friends

class TUndirNet
 

Detailed Description

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

Definition at line 3234 of file network.h.

Constructor & Destructor Documentation

TUndirNet::TEdgeI::TEdgeI ( )
inline

Definition at line 3239 of file network.h.

3239 : CurNode(), EndNode(), CurEdge(0) { }
TUndirNet::TEdgeI::TEdgeI ( const TNodeI &  NodeI,
const TNodeI &  EndNodeI,
const int &  EdgeN = 0 
)
inline

Definition at line 3240 of file network.h.

3240 : CurNode(NodeI), EndNode(EndNodeI), CurEdge(EdgeN) { }
TUndirNet::TEdgeI::TEdgeI ( const TEdgeI &  EdgeI)
inline

Definition at line 3241 of file network.h.

3241 : CurNode(EdgeI.CurNode), EndNode(EdgeI.EndNode), CurEdge(EdgeI.CurEdge) { }

Member Function Documentation

int TUndirNet::TEdgeI::GetDstNId ( ) const
inline

Returns the destination of the edge. Since the network is undirected, this is the node with a greater ID of the edge endpoints.

Definition at line 3252 of file network.h.

Referenced by TUndirNet::AddEdge(), TUndirNet::AddSAttrDatE(), TUndirNet::DelSAttrDatE(), TUndirNet::GetSAttrDatE(), and TUndirNet::GetSAttrVE().

3252 { return CurNode.GetOutNId(CurEdge); }
TUndirNet::TNodeI::GetOutNId
int GetOutNId(const int &NodeN) const
Returns ID of NodeN-th out-node (the node the current node points to).
Definition: network.h:3219

Here is the caller graph for this function:

int TUndirNet::TEdgeI::GetId ( ) const
inline

Returns edge ID. Always returns -1 since only edges in multigraphs have explicit IDs.

Definition at line 3248 of file network.h.

3248 { return -1; }
int TUndirNet::TEdgeI::GetSrcNId ( ) const
inline

Returns the source of the edge. Since the network is undirected, this is the node with a smaller ID of the edge endpoints.

Definition at line 3250 of file network.h.

Referenced by TUndirNet::AddEdge(), TUndirNet::AddSAttrDatE(), TUndirNet::DelSAttrDatE(), TUndirNet::GetSAttrDatE(), and TUndirNet::GetSAttrVE().

3250 { return CurNode.GetId(); }
TUndirNet::TNodeI::GetId
int GetId() const
Returns ID of the current node.
Definition: network.h:3201

Here is the caller graph for this function:

TEdgeI& TUndirNet::TEdgeI::operator++ ( int  )
inline

Increment iterator.

Definition at line 3244 of file network.h.

3244 { do { CurEdge++; if (CurEdge >= CurNode.GetOutDeg()) { CurEdge=0; CurNode++; while (CurNode < EndNode && CurNode.GetOutDeg()==0) { CurNode++; } } } while (CurNode < EndNode && GetSrcNId()>GetDstNId()); return *this; }
TUndirNet::TNodeI::GetOutDeg
int GetOutDeg() const
Returns out-degree of the current node (returns same as value GetDeg() since the network is undirecte...
Definition: network.h:3207
TUndirNet::TEdgeI::GetDstNId
int GetDstNId() const
Returns the destination of the edge. Since the network is undirected, this is the node with a greater...
Definition: network.h:3252
TUndirNet::TEdgeI::GetSrcNId
int GetSrcNId() const
Returns the source of the edge. Since the network is undirected, this is the node with a smaller ID o...
Definition: network.h:3250
bool TUndirNet::TEdgeI::operator< ( const TEdgeI &  EdgeI) const
inline

Definition at line 3245 of file network.h.

References CurEdge, and CurNode.

3245 { return CurNode<EdgeI.CurNode || (CurNode==EdgeI.CurNode && CurEdge<EdgeI.CurEdge); }
TEdgeI& TUndirNet::TEdgeI::operator= ( const TEdgeI &  EdgeI)
inline

Definition at line 3242 of file network.h.

References CurEdge, CurNode, and EndNode.

3242 { if (this!=&EdgeI) { CurNode=EdgeI.CurNode; EndNode=EdgeI.EndNode; CurEdge=EdgeI.CurEdge; } return *this; }
bool TUndirNet::TEdgeI::operator== ( const TEdgeI &  EdgeI) const
inline

Definition at line 3246 of file network.h.

References CurEdge, and CurNode.

3246 { return CurNode == EdgeI.CurNode && CurEdge == EdgeI.CurEdge; }

Friends And Related Function Documentation

friend class TUndirNet
friend

Definition at line 3253 of file network.h.

Member Data Documentation

int TUndirNet::TEdgeI::CurEdge
private

Definition at line 3237 of file network.h.

Referenced by operator<(), operator=(), and operator==().

TNodeI TUndirNet::TEdgeI::CurNode
private

Definition at line 3236 of file network.h.

Referenced by operator<(), operator=(), and operator==().

TNodeI TUndirNet::TEdgeI::EndNode
private

Definition at line 3236 of file network.h.

Referenced by operator=().

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