Generic Image Library: step_iterator_adaptor< Derived, Iterator, SFn > Class Template Reference

###  | #  |

Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
step_iterator_adaptor< Derived, Iterator, SFn > Class Template Reference
Pixel Iterator » Models » step iterators

An adaptor over an existing iterator that changes the step unit. More...

`#include <step_iterator.hpp>`

## Public Types
using | parent_t = iterator_adaptor<Derived, Iterator, use_default, use_default, use_default, typename SFn::difference_type>
using | base_difference_type = typename std::iterator_traits<Iterator>::difference_type
using | difference_type = typename SFn::difference_type
using | reference = typename std::iterator_traits<Iterator>::reference

## Public Member Functions
| step_iterator_adaptor (Iterator const &it, SFn step_fn=SFn())
auto | step () const -> difference_type

## Protected Attributes
SFn | _step_fn

## Friends
class | boost::iterator_core_access

## Detailed Description

template<typename Derived, typename Iterator, typename SFn>
class boost::gil::detail::step_iterator_adaptor< Derived, Iterator, SFn >

An adaptor over an existing iterator that changes the step unit.

(i.e. distance(it,it+1)) by a given predicate. Instead of calling base's operators ++, –, +=, -=, etc. the adaptor is using the passed policy object SFn for advancing and for computing the distance between iterators.

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

- step_iterator.hpp