Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::GraphAdjIterator Class Reference

Iterator for AdjEntries of a graph. More...

#include <ogdf/basic/Graph_d.h>

Public Types

using iterator = GraphAdjIterator
 
using value_type = adjEntry
 

Public Member Functions

 GraphAdjIterator (Graph *graph=nullptr, adjEntry entry=nullptr)
 Constructor. More...
 
GraphAdjIterator begin ()
 Returns an iterator to the first adjEntry in the associated graph. More...
 
GraphAdjIterator end ()
 Returns an iterator to the one-past-last adjEntry in the associated graph. More...
 
void next ()
 Proceeds to the next adjEntry. More...
 
bool operator!= (const GraphAdjIterator &iter) const
 Inequality operator. More...
 
adjEntry operator* () const
 Returns the associated adjEntry. More...
 
GraphAdjIteratoroperator++ ()
 Increment operator (prefix). More...
 
GraphAdjIterator operator++ (int)
 Increment operator (postfix). More...
 
GraphAdjIteratoroperator-- ()
 Decrement operator (prefix). More...
 
GraphAdjIterator operator-- (int)
 Decrement operator (postfix). More...
 
AdjElementoperator-> () const
 Returns a reference to the associated adjElement. More...
 
bool operator== (const GraphAdjIterator &iter) const
 Equality operator. More...
 
void prev ()
 Returns to the previous adjEntry. More...
 

Private Attributes

adjEntry m_entry
 
Graphm_pGraph
 

Detailed Description

Iterator for AdjEntries of a graph.

Definition at line 516 of file Graph_d.h.

Member Typedef Documentation

◆ iterator

Definition at line 521 of file Graph_d.h.

◆ value_type

Definition at line 522 of file Graph_d.h.

Constructor & Destructor Documentation

◆ GraphAdjIterator()

ogdf::GraphAdjIterator::GraphAdjIterator ( Graph graph = nullptr,
adjEntry  entry = nullptr 
)

Constructor.

Member Function Documentation

◆ begin()

GraphAdjIterator ogdf::GraphAdjIterator::begin ( )

Returns an iterator to the first adjEntry in the associated graph.

◆ end()

GraphAdjIterator ogdf::GraphAdjIterator::end ( )
inline

Returns an iterator to the one-past-last adjEntry in the associated graph.

Definition at line 531 of file Graph_d.h.

◆ next()

void ogdf::GraphAdjIterator::next ( )

Proceeds to the next adjEntry.

◆ operator!=()

bool ogdf::GraphAdjIterator::operator!= ( const GraphAdjIterator iter) const
inline

Inequality operator.

Definition at line 551 of file Graph_d.h.

◆ operator*()

adjEntry ogdf::GraphAdjIterator::operator* ( ) const
inline

Returns the associated adjEntry.

Definition at line 540 of file Graph_d.h.

◆ operator++() [1/2]

GraphAdjIterator& ogdf::GraphAdjIterator::operator++ ( )
inline

Increment operator (prefix).

Definition at line 554 of file Graph_d.h.

◆ operator++() [2/2]

GraphAdjIterator ogdf::GraphAdjIterator::operator++ ( int  )
inline

Increment operator (postfix).

Definition at line 560 of file Graph_d.h.

◆ operator--() [1/2]

GraphAdjIterator& ogdf::GraphAdjIterator::operator-- ( )
inline

Decrement operator (prefix).

Definition at line 567 of file Graph_d.h.

◆ operator--() [2/2]

GraphAdjIterator ogdf::GraphAdjIterator::operator-- ( int  )
inline

Decrement operator (postfix).

Definition at line 573 of file Graph_d.h.

◆ operator->()

AdjElement& ogdf::GraphAdjIterator::operator-> ( ) const
inline

Returns a reference to the associated adjElement.

Definition at line 543 of file Graph_d.h.

◆ operator==()

bool ogdf::GraphAdjIterator::operator== ( const GraphAdjIterator iter) const
inline

Equality operator.

Definition at line 546 of file Graph_d.h.

◆ prev()

void ogdf::GraphAdjIterator::prev ( )

Returns to the previous adjEntry.

Member Data Documentation

◆ m_entry

adjEntry ogdf::GraphAdjIterator::m_entry
private

Definition at line 518 of file Graph_d.h.

◆ m_pGraph

Graph* ogdf::GraphAdjIterator::m_pGraph
private

Definition at line 517 of file Graph_d.h.


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