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

Range wrapper for rootward path traversal. More...

#include <MorphologicalTree.hpp>

Public Member Functions

 AncestorNodeRange ()=default
 Creates an empty rootward-path range.
 
 AncestorNodeRange (const MorphologicalTree *tree, NodeId start, std::size_t expectedVersion)
 Creates a range from start to the connected root.
 
AncestorNodeIterator begin () const
 Returns an iterator at the path start node.
 
AncestorNodeIterator end () const
 Returns the rootward-path range sentinel.
 

Detailed Description

Range wrapper for rootward path traversal.

Definition at line 4004 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

◆ AncestorNodeRange()

mmcfilters::MorphologicalTree::AncestorNodeRange::AncestorNodeRange ( const MorphologicalTree tree,
NodeId  start,
std::size_t  expectedVersion 
)
inline

Creates a range from start to the connected root.

Parameters
treeTree topology.
startInclusive start position.
expectedVersionMutation version required by the operation.

Definition at line 4026 of file MorphologicalTree.hpp.

Member Function Documentation

◆ begin()

AncestorNodeIterator mmcfilters::MorphologicalTree::AncestorNodeRange::begin ( ) const
inline

Returns an iterator at the path start node.

Returns
An iterator at the path start node.

Definition at line 4034 of file MorphologicalTree.hpp.

◆ end()

AncestorNodeIterator mmcfilters::MorphologicalTree::AncestorNodeRange::end ( ) const
inline

Returns the rootward-path range sentinel.

Returns
The rootward-path range sentinel.

Definition at line 4041 of file MorphologicalTree.hpp.


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