mmcfilters::ContourTraceComputation::iterator Class Reference

Single-pass iterator yielding a node and borrowed ordered trace. More...

#include <ContourTraceComputation.hpp>

Public Types
using	iterator_concept = std::input_iterator_tag
	C++20 iterator concept for a single-pass traversal.
using	iterator_category = std::input_iterator_tag
	Iterator category used by standard algorithms.
using	value_type = std::pair< NodeId, ContourTraceView >
	Node identifier and borrowed ordered trace yielded by dereference.
using	difference_type = std::ptrdiff_t
	Signed iterator-distance type.

Public Member Functions
value_type	operator* () const
	Borrows the current node and ordered trace.
iterator &	operator++ ()
	Advances to the next node trace.
void	operator++ (int)
	Advances without retaining the preceding borrowed trace.

Friends
class	ContourTraceComputation
bool	operator== (const iterator &position, std::default_sentinel_t) noexcept
	Tests exhaustion against the traversal sentinel.

Detailed Description

Single-pass iterator yielding a node and borrowed ordered trace.

The trace view remains valid until this iterator or one of its copies advances, or their shared traversal is destroyed. Copies share one traversal position. Each call to begin() creates an independent traversal.

Definition at line 84 of file ContourTraceComputation.hpp.

Member Typedef Documentation

difference_type

using mmcfilters::ContourTraceComputation::iterator::difference_type = std::ptrdiff_t

Signed iterator-distance type.

Definition at line 93 of file ContourTraceComputation.hpp.

iterator_category

using mmcfilters::ContourTraceComputation::iterator::iterator_category = std::input_iterator_tag

Iterator category used by standard algorithms.

Definition at line 89 of file ContourTraceComputation.hpp.

iterator_concept

using mmcfilters::ContourTraceComputation::iterator::iterator_concept = std::input_iterator_tag

C++20 iterator concept for a single-pass traversal.

Definition at line 87 of file ContourTraceComputation.hpp.

value_type

using mmcfilters::ContourTraceComputation::iterator::value_type = std::pair<NodeId, ContourTraceView>

Node identifier and borrowed ordered trace yielded by dereference.

Definition at line 91 of file ContourTraceComputation.hpp.

Member Function Documentation

operator*()

value_type mmcfilters::ContourTraceComputation::iterator::operator* ( ) const

inline

Borrows the current node and ordered trace.

Returns

Current node identifier and trace view.

Definition at line 101 of file ContourTraceComputation.hpp.

operator++() [1/2]

iterator & mmcfilters::ContourTraceComputation::iterator::operator++ ( )

inline

Advances to the next node trace.

Returns

This iterator after advancing.

Definition at line 112 of file ContourTraceComputation.hpp.

operator++() [2/2]

void mmcfilters::ContourTraceComputation::iterator::operator++ ( int  )

inline

Advances without retaining the preceding borrowed trace.

Definition at line 121 of file ContourTraceComputation.hpp.

Friends And Related Symbol Documentation

ContourTraceComputation

friend class ContourTraceComputation

friend

Definition at line 129 of file ContourTraceComputation.hpp.

operator==

bool operator== ( const iterator &  position, std::default_sentinel_t    )

friend

Tests exhaustion against the traversal sentinel.

Definition at line 124 of file ContourTraceComputation.hpp.

---

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

• mmcfilters/contours/ContourTraceComputation.hpp