position_iterator< Deref, Dim > Class Template Reference

An iterator that remembers its current X,Y position and invokes a function object with it upon dereferencing. Used to create virtual image views. Models: StepIteratorConcept, PixelIteratorConcept, PixelBasedConcept, HasDynamicXStepTypeConcept. More...

#include <position_iterator.hpp>

Inherits iterator_interface< position_iterator< Deref, Dim >, std::random_access_iterator_tag, Deref::value_type, Deref::reference, Deref::value_type *, Deref::argument_type::template axis< Dim >::coord_t >.

Public Types
using	parent_t = stl_interfaces::iterator_interface< position_iterator< Deref, Dim >, std::random_access_iterator_tag, typename Deref::value_type, typename Deref::reference, typename Deref::value_type *, typename Deref::argument_type::template axis< Dim >::coord_t >
using	difference_type = typename parent_t::difference_type
using	reference = typename parent_t::reference
using	iterator_category = typename parent_t::iterator_concept
using	point_t = typename Deref::argument_type

Public Member Functions
	position_iterator (point_t const &p, point_t const &step, Deref const &d)
	position_iterator (position_iterator const &p)
template<typename D >
	position_iterator (position_iterator< D, Dim > const &p)
auto	operator= (position_iterator const &p) -> position_iterator &
auto	pos () const -> point_t const &
auto	step () const -> point_t const &
auto	deref_fn () const -> Deref const &
void	set_step (difference_type s)
constexpr auto	operator* () const noexcept -> reference
constexpr auto	operator+= (difference_type d) noexcept -> position_iterator &
constexpr auto	operator++ () noexcept -> position_iterator &
constexpr auto	operator-- () noexcept -> position_iterator &
constexpr auto	operator++ (int) noexcept -> position_iterator
constexpr auto	operator-- (int) noexcept -> position_iterator
constexpr auto	operator- (position_iterator other) const noexcept
constexpr bool	operator== (position_iterator other) const noexcept

Friends
struct	boost::stl_interfaces::access

Detailed Description

template<typename Deref, int Dim>
class boost::gil::position_iterator< Deref, Dim >

An iterator that remembers its current X,Y position and invokes a function object with it upon dereferencing. Used to create virtual image views. Models: StepIteratorConcept, PixelIteratorConcept, PixelBasedConcept, HasDynamicXStepTypeConcept.

Template Parameters

Deref	A function object that given a point returns a pixel reference. Models PixelDereferenceAdaptorConcept
Dim	Dimension to advance along

---

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

• position_iterator.hpp