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

Range wrapper over the proper descendants of one node. More...

#include <MorphologicalTree.hpp>

Public Member Functions

 DescendantNodeRange ()=default
 Creates an empty descendant range.
 
 DescendantNodeRange (const MorphologicalTree *tree, NodeId rootNodeId, std::size_t expectedVersion)
 Creates a range over proper descendants of rootNodeId.
 
SubtreeNodeIterator begin () const
 Returns an iterator at the first proper descendant.
 
SubtreeNodeIterator end () const
 Returns the descendant range sentinel.
 

Detailed Description

Range wrapper over the proper descendants of one node.

Definition at line 4363 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

◆ DescendantNodeRange()

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

Creates a range over proper descendants of rootNodeId.

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

Definition at line 4385 of file MorphologicalTree.hpp.

Member Function Documentation

◆ begin()

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

Returns an iterator at the first proper descendant.

Returns
An iterator at the first proper descendant.

Definition at line 4393 of file MorphologicalTree.hpp.

◆ end()

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

Returns the descendant range sentinel.

Returns
The descendant range sentinel.

Definition at line 4404 of file MorphologicalTree.hpp.


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