boost_iterator/doc/reverse_iterator_ref.rst

::

  template <class Iterator>
  class reverse_iterator
  {
  public:
    typedef iterator_traits<Iterator>::value_type value_type;
    typedef iterator_traits<Iterator>::reference reference;
    typedef iterator_traits<Iterator>::pointer pointer;
    typedef iterator_traits<Iterator>::difference_type difference_type;
    typedef /* see below */ iterator_category;

    reverse_iterator() {}
    explicit reverse_iterator(Iterator x) ;

    template<class OtherIterator>
    reverse_iterator(
        reverse_iterator<OtherIterator> const& r
      , typename enable_if_convertible<OtherIterator, Iterator>::type* = 0 // exposition
    );
    Iterator base() const;
    reference operator*() const;
    reverse_iterator& operator++();
    reverse_iterator& operator--();
  private:
    Iterator m_iterator; // exposition
  };


The ``iterator_category`` member is a type convertible to the tags
corresponding to each standard concept modeled by
``reverse_iterator``, as described in the models section.


``reverse_iterator`` requirements
.................................

The base ``Iterator`` must be a model of Bidirectional Traversal
Iterator and Readable Iterator.


``reverse_iterator`` models
...........................

The concepts that ``reverse_iterator`` models are dependent on what
concepts the ``Iterator`` argument models, as specified in the
following tables.

+----------------------------------+-------------------------------------+
| If ``Iterator`` models           | then ``reverse_iterator`` models    |
+==================================+=====================================+
| Bidirectional Traversal Iterator | Bidirectional Traversal Iterator    |
+----------------------------------+-------------------------------------+
| Random Access Traversal Iterator | Random Access Traversal Iterator    |
+----------------------------------+-------------------------------------+

+--------------------------------+----------------------------------------------+
| If ``Iterator`` models         | then ``reverse_iterator`` models             |
+================================+==============================================+
| Readable Iterator              | Readable Iterator                            |
+--------------------------------+----------------------------------------------+
| Writable Iterator              | Writable Iterator                            |
+--------------------------------+----------------------------------------------+
| Lvalue Iterator                | Lvalue Iterator                              |
+--------------------------------+----------------------------------------------+


+-------------------------------------------------------+----------------------------------+
| If ``Iterator`` models                                | then ``reverse_iterator`` models |
+=======================================================+==================================+
| Readable Lvalue Iterator,                             | Bidirectional Iterator           |
| Bidirectional Traversal Iterator                      |                                  |
+-------------------------------------------------------+----------------------------------+
| Writable Lvalue Iterator,                             | Mutable Bidirectional Iterator   |
| Bidirectional Traversal Iterator                      |                                  |
+-------------------------------------------------------+----------------------------------+
| Readable Lvalue Iterator,                             | Random Access Iterator           |
| Random Access Traversal Iterator                      |                                  |
+-------------------------------------------------------+----------------------------------+
| Writable Lvalue Iterator,                             | Mutable Random Access Iterator   |
| Random Access Traversal Iterator                      |                                  |
+-------------------------------------------------------+----------------------------------+





``reverse_iterator`` operations
...............................

In addition to the operations required by the concepts modeled by
``reverse_iterator``, ``reverse_iterator`` provides the following
operations.



``reverse_iterator();``

:Requires: ``Iterator`` must be Default Constructible.
:Returns: An instance of ``reverse_iterator`` with ``m_iterator`` 
  default constructed.

``explicit reverse_iterator(Iterator x);``

:Returns: An instance of ``reverse_iterator`` with a
  ``m_iterator`` constructed from ``x``.


::

    template<class OtherIterator>
    reverse_iterator(
        reverse_iterator<OtherIterator> const& r
      , typename enable_if_convertible<OtherIterator, Iterator>::type* = 0 // exposition
    );

:Requires: ``OtherIterator`` is implicitly convertible to ``Iterator``.
:Returns: An instance of ``reverse_iterator`` that is a copy of ``r``.




``Iterator base() const;``

:Returns: ``m_iterator``


``reference operator*() const;``

:Effects: 

::

    Iterator tmp = m_iterator;
    return *--tmp;


``reverse_iterator& operator++();``

:Effects: ``--m_iterator``
:Returns: ``*this``


``reverse_iterator& operator--();``

:Effects: ``++m_iterator``
:Returns: ``*this``