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

Range wrapper for the path connecting two nodes in the same component. More...

#include <MorphologicalTree.hpp>

Public Member Functions

 PathBetweenNodesRange ()=default
 Creates an empty path-between-nodes range.
 
 PathBetweenNodesRange (const MorphologicalTree *tree, NodeId sourceNodeId, NodeId targetNodeId, std::size_t expectedVersion)
 Materialises and owns the path between two nodes.
 
PathBetweenNodesIterator begin () const
 Returns an iterator at the first node in the materialised path.
 
PathBetweenNodesIterator end () const
 Returns the materialised path range sentinel.
 

Detailed Description

Range wrapper for the path connecting two nodes in the same component.

Definition at line 4129 of file MorphologicalTree.hpp.

Constructor & Destructor Documentation

◆ PathBetweenNodesRange()

mmcfilters::MorphologicalTree::PathBetweenNodesRange::PathBetweenNodesRange ( const MorphologicalTree tree,
NodeId  sourceNodeId,
NodeId  targetNodeId,
std::size_t  expectedVersion 
)
inline

Materialises and owns the path between two nodes.

Parameters
treeTree topology.
sourceNodeIdNode identifier.
targetNodeIdNode identifier.
expectedVersionMutation version required by the operation.

Definition at line 4212 of file MorphologicalTree.hpp.

Member Function Documentation

◆ begin()

PathBetweenNodesIterator mmcfilters::MorphologicalTree::PathBetweenNodesRange::begin ( ) const
inline

Returns an iterator at the first node in the materialised path.

Returns
An iterator at the first node in the materialised path.

Definition at line 4220 of file MorphologicalTree.hpp.

◆ end()

PathBetweenNodesIterator mmcfilters::MorphologicalTree::PathBetweenNodesRange::end ( ) const
inline

Returns the materialised path range sentinel.

Returns
The materialised path range sentinel.

Definition at line 4227 of file MorphologicalTree.hpp.


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