Generic Image Library: dereference_iterator_adaptor< Iterator, DFn > Class Template Reference

###  | #  |

Public Types | Public Member Functions | Friends | List of all members
dereference_iterator_adaptor< Iterator, DFn > Class Template Reference
Pixel Iterator » Models » dereference_iterator_adaptor | PixelBased » Models

An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: IteratorAdaptorConcept, PixelIteratorConcept. More...

`#include <pixel_iterator_adaptor.hpp>`

## Public Types
using | parent_t
using | reference = typename DFn::result_type
using | difference_type = typename std::iterator_traits<Iterator>::difference_type
using | dereference_fn = DFn

## Public Member Functions
template<typename Iterator1>
| dereference_iterator_adaptor (const dereference_iterator_adaptor< Iterator1, DFn > &dit)
| dereference_iterator_adaptor (Iterator it, DFn deref_fn=DFn())
template<typename Iterator1, typename DFn1>
| dereference_iterator_adaptor (const dereference_iterator_adaptor< Iterator1, DFn1 > &it)
reference | operator[] (difference_type d) const
bool | operator> (const dereference_iterator_adaptor &p) const
bool | operator< (const dereference_iterator_adaptor &p) const
bool | operator>= (const dereference_iterator_adaptor &p) const
bool | operator<= (const dereference_iterator_adaptor &p) const
bool | operator== (const dereference_iterator_adaptor &p) const
bool | operator!= (const dereference_iterator_adaptor &p) const
Iterator & | base ()
const Iterator & | base () const
const DFn & | deref_fn () const

## Friends
class | boost::iterator_core_access

## Detailed Description

template<typename Iterator, typename DFn>
class boost::gil::dereference_iterator_adaptor< Iterator, DFn >

An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: IteratorAdaptorConcept, PixelIteratorConcept.

## Member Typedef Documentation

## ◆ parent_t

template<typename Iterator, typename DFn>

using parent_t

Initial value:
iterator_adaptor<dereference_iterator_adaptor<Iterator,DFn>,
Iterator,
typename DFn::value_type,
typename std::iterator_traits<Iterator>::iterator_category,
typename DFn::reference,
use_default>

## Member Function Documentation

## ◆ operator[]()

template<typename Iterator, typename DFn>

reference operator[] | ( | difference_type | d | ) | const
| inline

For some reason operator[] provided by iterator_facade returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits

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

- pixel_iterator_adaptor.hpp