mirror of
https://github.com/boostorg/iterator.git
synced 2025-11-04 02:11:37 +01:00
9cc1a4fdd1
The tags were not being updated for a long time now and were visible in the final docs. Reported in https://github.com/boostorg/website/issues/762.
77 lines
1.8 KiB
ReStructuredText
77 lines
1.8 KiB
ReStructuredText
.. Distributed under the Boost
|
|
.. Software License, Version 1.0. (See accompanying
|
|
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
+++++++++++++++++
|
|
Iterator Traits
|
|
+++++++++++++++++
|
|
|
|
:Author: David Abrahams
|
|
:Contact: dave@boost-consulting.com
|
|
:organization: `Boost Consulting`_
|
|
:copyright: Copyright David Abrahams 2004.
|
|
|
|
.. _`Boost Consulting`: http://www.boost-consulting.com
|
|
|
|
:abstract: Header ``<boost/iterator/iterator_traits.hpp>`` provides
|
|
the ability to access an iterator's associated types using
|
|
MPL-compatible metafunctions_.
|
|
|
|
.. _metafunctions: ../../mpl/doc/index.html#metafunctions
|
|
|
|
Overview
|
|
========
|
|
|
|
``std::iterator_traits`` provides access to five associated types
|
|
of any iterator: its ``value_type``, ``reference``, ``pointer``,
|
|
``iterator_category``, and ``difference_type``. Unfortunately,
|
|
such a "multi-valued" traits template can be difficult to use in a
|
|
metaprogramming context. ``<boost/iterator/iterator_traits.hpp>``
|
|
provides access to these types using a standard metafunctions_.
|
|
|
|
Summary
|
|
=======
|
|
|
|
Header ``<boost/iterator/iterator_traits.hpp>``::
|
|
|
|
template <class Iterator>
|
|
struct iterator_value
|
|
{
|
|
typedef typename
|
|
std::iterator_traits<Iterator>::value_type
|
|
type;
|
|
};
|
|
|
|
template <class Iterator>
|
|
struct iterator_reference
|
|
{
|
|
typedef typename
|
|
std::iterator_traits<Iterator>::reference
|
|
type;
|
|
};
|
|
|
|
|
|
template <class Iterator>
|
|
struct iterator_pointer
|
|
{
|
|
typedef typename
|
|
std::iterator_traits<Iterator>::pointer
|
|
type;
|
|
};
|
|
|
|
template <class Iterator>
|
|
struct iterator_difference
|
|
{
|
|
typedef typename
|
|
detail::iterator_traits<Iterator>::difference_type
|
|
type;
|
|
};
|
|
|
|
template <class Iterator>
|
|
struct iterator_category
|
|
{
|
|
typedef typename
|
|
detail::iterator_traits<Iterator>::iterator_category
|
|
type;
|
|
};
|