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

Range wrapper for pre-order subtree traversal. More...

#include <MorphologicalTree.hpp>

Public Member Functions

 SubtreeNodeRange ()=default
 Creates an empty subtree range.
 
 SubtreeNodeRange (const MorphologicalTree *tree, NodeId rootNodeId, std::size_t expectedVersion)
 Creates a pre-order range over the subtree rooted at rootNodeId.
 
SubtreeNodeIterator begin () const
 Returns an iterator at the subtree root.
 
SubtreeNodeIterator end () const
 Returns the subtree range sentinel.
 

Detailed Description

Range wrapper for pre-order subtree traversal.

Definition at line 4320 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

◆ SubtreeNodeRange()

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

Creates a pre-order range over the subtree rooted at rootNodeId.

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

Definition at line 4342 of file MorphologicalTree.hpp.

Member Function Documentation

◆ begin()

SubtreeNodeIterator mmcfilters::MorphologicalTree::SubtreeNodeRange::begin ( ) const
inline

Returns an iterator at the subtree root.

Returns
An iterator at the subtree root.

Definition at line 4350 of file MorphologicalTree.hpp.

◆ end()

SubtreeNodeIterator mmcfilters::MorphologicalTree::SubtreeNodeRange::end ( ) const
inline

Returns the subtree range sentinel.

Returns
The subtree range sentinel.

Definition at line 4357 of file MorphologicalTree.hpp.


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