mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset > Class Template Reference

Small value range carrying one immutable traversal context. More...

#include <RegularGridAdjacency2D.hpp>

Public Types
using	iterator = IteratorAdjacencyT< ForwardOnly >
	Iterator type returned by this range.

Public Member Functions
	GridIndexRangeT (const RegularGridAdjacency2D &relation, int row, int column) noexcept
	Creates a range for one validated grid coordinate.
iterator	begin () const noexcept
	Returns an iterator positioned at the first valid neighbour.
iterator	end () const noexcept
	Returns the traversal sentinel iterator.

Detailed Description

template<bool ForwardOnly, int FirstOffset>
class mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset >

Small value range carrying one immutable traversal context.

Definition at line 835 of file RegularGridAdjacency2D.hpp.

Member Typedef Documentation

iterator

template<bool ForwardOnly, int FirstOffset>

using mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset >::iterator = IteratorAdjacencyT<ForwardOnly>

Iterator type returned by this range.

Definition at line 855 of file RegularGridAdjacency2D.hpp.

Constructor & Destructor Documentation

GridIndexRangeT()

template<bool ForwardOnly, int FirstOffset>

mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset >::GridIndexRangeT ( const RegularGridAdjacency2D &  relation, int  row, int  column  )

inlinenoexcept

Creates a range for one validated grid coordinate.

Parameters

relation	Adjacency relation traversed by the iterator.
row	Zero-based row coordinate.
column	Zero-based column coordinate.

Definition at line 852 of file RegularGridAdjacency2D.hpp.

Member Function Documentation

begin()

template<bool ForwardOnly, int FirstOffset>

iterator mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset >::begin ( ) const

inlinenoexcept

Returns an iterator positioned at the first valid neighbour.

Returns

An iterator positioned at the first valid neighbour.

Definition at line 862 of file RegularGridAdjacency2D.hpp.

end()

template<bool ForwardOnly, int FirstOffset>

iterator mmcfilters::RegularGridAdjacency2D::GridIndexRangeT< ForwardOnly, FirstOffset >::end ( ) const

inlinenoexcept

Returns the traversal sentinel iterator.

Returns

The traversal sentinel iterator.

Definition at line 869 of file RegularGridAdjacency2D.hpp.

---

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

• mmcfilters/utils/RegularGridAdjacency2D.hpp