Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::pc_tree::PCNodeIterator Class Reference

#include <ogdf/basic/pctree/PCTreeIterators.h>

Public Types

using difference_type = std::ptrdiff_t
 
using iterator_category = std::forward_iterator_tag
 
using pointer = PCNode *
 
using reference = PCNode &
 
using value_type = PCNode
 

Public Member Functions

 PCNodeIterator ()=default
 
bool isParent ()
 
PCNodenodeOf () const
 
bool operator!= (const PCNodeIterator &rhs) const
 
PCNodeoperator* () const
 
PCNodeIteratoroperator++ ()
 Increment operator (prefix, returns result). More...
 
PCNodeIterator operator++ (int)
 Increment operator (postfix, returns previous value). More...
 
PCNodeoperator-> () const
 
bool operator== (const PCNodeIterator &rhs) const
 

Private Member Functions

 PCNodeIterator (PCNode *node, PCNode *pred, PCNode *curr)
 

Private Attributes

PCNodem_curr = nullptr
 
PCNodem_node = nullptr
 
PCNodem_pred = nullptr
 

Friends

struct PCNodeChildrenIterable
 
struct PCNodeNeighborsIterable
 

Detailed Description

Definition at line 41 of file PCTreeIterators.h.

Member Typedef Documentation

◆ difference_type

Definition at line 57 of file PCTreeIterators.h.

◆ iterator_category

using ogdf::pc_tree::PCNodeIterator::iterator_category = std::forward_iterator_tag

Definition at line 53 of file PCTreeIterators.h.

◆ pointer

Definition at line 55 of file PCTreeIterators.h.

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ PCNodeIterator() [1/2]

ogdf::pc_tree::PCNodeIterator::PCNodeIterator ( PCNode node,
PCNode pred,
PCNode curr 
)
inlineprivate

Definition at line 49 of file PCTreeIterators.h.

◆ PCNodeIterator() [2/2]

ogdf::pc_tree::PCNodeIterator::PCNodeIterator ( )
default

Member Function Documentation

◆ isParent()

bool ogdf::pc_tree::PCNodeIterator::isParent ( )

◆ nodeOf()

PCNode* ogdf::pc_tree::PCNodeIterator::nodeOf ( ) const
inline

Definition at line 77 of file PCTreeIterators.h.

◆ operator!=()

bool ogdf::pc_tree::PCNodeIterator::operator!= ( const PCNodeIterator rhs) const
inline

Definition at line 75 of file PCTreeIterators.h.

◆ operator*()

PCNode* ogdf::pc_tree::PCNodeIterator::operator* ( ) const
inline

Definition at line 63 of file PCTreeIterators.h.

◆ operator++() [1/2]

PCNodeIterator& ogdf::pc_tree::PCNodeIterator::operator++ ( )

Increment operator (prefix, returns result).

◆ operator++() [2/2]

PCNodeIterator ogdf::pc_tree::PCNodeIterator::operator++ ( int  )

Increment operator (postfix, returns previous value).

◆ operator->()

PCNode& ogdf::pc_tree::PCNodeIterator::operator-> ( ) const
inline

Definition at line 61 of file PCTreeIterators.h.

◆ operator==()

bool ogdf::pc_tree::PCNodeIterator::operator== ( const PCNodeIterator rhs) const
inline

Definition at line 71 of file PCTreeIterators.h.

Friends And Related Function Documentation

◆ PCNodeChildrenIterable

friend struct PCNodeChildrenIterable
friend

Definition at line 42 of file PCTreeIterators.h.

◆ PCNodeNeighborsIterable

friend struct PCNodeNeighborsIterable
friend

Definition at line 43 of file PCTreeIterators.h.

Member Data Documentation

◆ m_curr

PCNode* ogdf::pc_tree::PCNodeIterator::m_curr = nullptr
private

Definition at line 47 of file PCTreeIterators.h.

◆ m_node

PCNode* ogdf::pc_tree::PCNodeIterator::m_node = nullptr
private

Definition at line 45 of file PCTreeIterators.h.

◆ m_pred

PCNode* ogdf::pc_tree::PCNodeIterator::m_pred = nullptr
private

Definition at line 46 of file PCTreeIterators.h.


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