mmcfilters::MorphologicalTree::ChildrenIterator Class Reference

Iterator over the direct children of one node. More...

#include <MorphologicalTree.hpp>

Public Types
using	iterator_category = std::forward_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
	ChildrenIterator ()=default
	Creates the end/sentinel child iterator.
	ChildrenIterator (const MorphologicalTree *tree, NodeId currentLocal, std::size_t expectedVersion)
	Creates a child iterator starting from a linked-list slot.
ChildrenIterator &	operator++ ()
	Advances to the next sibling in the child list.
NodeId	operator* () const
	Returns the current child node id.
bool	operator== (const ChildrenIterator &other) const
	Compares child iterator positions.
bool	operator!= (const ChildrenIterator &other) const
	Compares child iterator positions for inequality.

Detailed Description

Iterator over the direct children of one node.

Definition at line 3220 of file MorphologicalTree.hpp.

Member Typedef Documentation

difference_type

using mmcfilters::MorphologicalTree::ChildrenIterator::difference_type = std::ptrdiff_t

Signed distance type exposed for STL compatibility.

Definition at line 3235 of file MorphologicalTree.hpp.

iterator_category

using mmcfilters::MorphologicalTree::ChildrenIterator::iterator_category = std::forward_iterator_tag

Standard iterator category exposed for STL compatibility.

Definition at line 3231 of file MorphologicalTree.hpp.

pointer

using mmcfilters::MorphologicalTree::ChildrenIterator::pointer = const NodeId*

Pointer type exposed for STL compatibility.

Definition at line 3237 of file MorphologicalTree.hpp.

reference

using mmcfilters::MorphologicalTree::ChildrenIterator::reference = const NodeId&

Reference type exposed for STL compatibility.

Definition at line 3239 of file MorphologicalTree.hpp.

value_type

using mmcfilters::MorphologicalTree::ChildrenIterator::value_type = NodeId

Node id yielded by the iterator.

Definition at line 3233 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

ChildrenIterator()

mmcfilters::MorphologicalTree::ChildrenIterator::ChildrenIterator ( const MorphologicalTree *  tree, NodeId  currentLocal, std::size_t  expectedVersion  )

inline

Creates a child iterator starting from a linked-list slot.

Parameters

tree	Tree topology.
currentLocal	Current local iterator position.
expectedVersion	Mutation version required by the operation.

Definition at line 3253 of file MorphologicalTree.hpp.

Member Function Documentation

operator!=()

bool mmcfilters::MorphologicalTree::ChildrenIterator::operator!= ( const ChildrenIterator &  other ) const

inline

Compares child iterator positions for inequality.

Parameters

other

Object to compare with or transfer from.

Returns

True when the documented condition holds; otherwise false.

Definition at line 3293 of file MorphologicalTree.hpp.

operator*()

NodeId mmcfilters::MorphologicalTree::ChildrenIterator::operator* ( ) const

inline

Returns the current child node id.

Returns

The current child node id.

Definition at line 3274 of file MorphologicalTree.hpp.

operator++()

ChildrenIterator & mmcfilters::MorphologicalTree::ChildrenIterator::operator++ ( )

inline

Advances to the next sibling in the child list.

Returns

Mutable reference to the updated object.

Definition at line 3261 of file MorphologicalTree.hpp.

operator==()

bool mmcfilters::MorphologicalTree::ChildrenIterator::operator== ( const ChildrenIterator &  other ) const

inline

Compares child iterator positions.

Parameters

other

Object to compare with or transfer from.

Returns

True when the documented condition holds; otherwise false.

Definition at line 3285 of file MorphologicalTree.hpp.

---

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

• mmcfilters/trees/MorphologicalTree.hpp