mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
mmcfilters::MorphologicalTree::PostOrderNodeIterator Class Reference

Post-order iterator over one subtree. More...

#include <MorphologicalTree.hpp>

Public Types

using iterator_category = std::input_iterator_tag
 Standard iterator category exposed for STL compatibility.
 
using value_type = NodeId
 Node id yielded by the iterator.
 
using difference_type = std::ptrdiff_t
 Signed distance type exposed for STL compatibility.
 
using pointer = const NodeId *
 Pointer type exposed for STL compatibility.
 
using reference = const NodeId &
 Reference type exposed for STL compatibility.
 

Public Member Functions

 PostOrderNodeIterator ()=default
 Creates the end/sentinel post-order iterator.
 
 PostOrderNodeIterator (const MorphologicalTree *tree, NodeId rootNodeId, std::size_t expectedVersion)
 Creates a post-order iterator rooted at rootNodeId.
 
PostOrderNodeIteratoroperator++ ()
 Advances to the next node in post-order.
 
NodeId operator* () const
 Returns the current post-order node id.
 
bool operator== (const PostOrderNodeIterator &other) const
 Compares post-order iterator positions.
 
bool operator!= (const PostOrderNodeIterator &other) const
 Compares post-order iterator positions for inequality.
 

Detailed Description

Post-order iterator over one subtree.

Definition at line 3636 of file MorphologicalTree.hpp.

Member Typedef Documentation

◆ difference_type

Signed distance type exposed for STL compatibility.

Definition at line 3681 of file MorphologicalTree.hpp.

◆ iterator_category

Standard iterator category exposed for STL compatibility.

Definition at line 3677 of file MorphologicalTree.hpp.

◆ pointer

Pointer type exposed for STL compatibility.

Definition at line 3683 of file MorphologicalTree.hpp.

◆ reference

Reference type exposed for STL compatibility.

Definition at line 3685 of file MorphologicalTree.hpp.

◆ value_type

Node id yielded by the iterator.

Definition at line 3679 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

◆ PostOrderNodeIterator()

mmcfilters::MorphologicalTree::PostOrderNodeIterator::PostOrderNodeIterator ( const MorphologicalTree tree,
NodeId  rootNodeId,
std::size_t  expectedVersion 
)
inline

Creates a post-order iterator rooted at rootNodeId.

Parameters
treeTree topology.
rootNodeIdIdentifier of the traversal root.
expectedVersionMutation version required by the operation.

Definition at line 3699 of file MorphologicalTree.hpp.

Member Function Documentation

◆ operator!=()

bool mmcfilters::MorphologicalTree::PostOrderNodeIterator::operator!= ( const PostOrderNodeIterator other) const
inline

Compares post-order iterator positions for inequality.

Parameters
otherObject to compare with or transfer from.
Returns
True when the documented condition holds; otherwise false.

Definition at line 3744 of file MorphologicalTree.hpp.

◆ operator*()

NodeId mmcfilters::MorphologicalTree::PostOrderNodeIterator::operator* ( ) const
inline

Returns the current post-order node id.

Returns
The current post-order node id.

Definition at line 3725 of file MorphologicalTree.hpp.

◆ operator++()

PostOrderNodeIterator & mmcfilters::MorphologicalTree::PostOrderNodeIterator::operator++ ( )
inline

Advances to the next node in post-order.

Returns
Mutable reference to the updated object.

Definition at line 3711 of file MorphologicalTree.hpp.

◆ operator==()

bool mmcfilters::MorphologicalTree::PostOrderNodeIterator::operator== ( const PostOrderNodeIterator other) const
inline

Compares post-order iterator positions.

Parameters
otherObject to compare with or transfer from.
Returns
True when the documented condition holds; otherwise false.

Definition at line 3736 of file MorphologicalTree.hpp.


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