trusty (3) std::reverse_iterator.3cxx.gz

Provided by: libstdc++6-4.4-doc_4.4.7-8ubuntu1_all bug

NAME

       std::reverse_iterator< _Iterator > -

SYNOPSIS

       Inherits std::iterator< iterator_traits< _Iterator >::iterator_category, iterator_traits< _Iterator
       >::value_type, iterator_traits< _Iterator >::difference_type, iterator_traits< _Iterator >::pointer,
       iterator_traits< _Iterator >::reference >.

   Public Types
       typedef iterator_traits
           < _Iterator >::difference_type difference_type"
       typedef iterator_traits
           < _Iterator >
           ::iterator_category iterator_category"
       typedef _Iterator iterator_type
       typedef iterator_traits
           < _Iterator >::pointer pointer"
       typedef iterator_traits
           < _Iterator >::reference reference"
       typedef iterator_traits
           < _Iterator >::value_type value_type"

   Public Member Functions
       iterator_type base () const
       reference operator* () const
       reverse_iterator operator+ (difference_type __n) const
       reverse_iterator & operator++ ()
       reverse_iterator operator++ (int)
       reverse_iterator & operator+= (difference_type __n)
       reverse_iterator operator- (difference_type __n) const
       reverse_iterator & operator-- ()
       reverse_iterator operator-- (int)
       reverse_iterator & operator-= (difference_type __n)
       pointer operator-> () const
       reference operator[] (difference_type __n) const
       reverse_iterator ()
       reverse_iterator (iterator_type __x)
       reverse_iterator (const reverse_iterator &__x)
       template<typename _Iter > reverse_iterator (const reverse_iterator< _Iter > &__x)

   Protected Attributes
       _Iterator current

Detailed Description

   template<typename _Iterator>class std::reverse_iterator< _Iterator >
       "Bidirectional and random access iterators have corresponding reverse iterator adaptors that iterate
       through the data structure in the opposite direction. They have the same signatures as the corresponding
       iterators. The fundamental relation between a reverse iterator and its corresponding iterator i is
       established by the identity:

       &*(reverse_iterator(i)) == &*(i - 1)

       This mapping is dictated by the fact that while there is always a pointer past the end of an array, there
       might not be a valid pointer before the beginning of an array." [24.4.1]/1,2

       Reverse iterators can be tricky and surprising at first. Their semantics make sense, however, and the
       trickiness is a side effect of the requirement that the iterators must be safe.

       Definition at line 90 of file stl_iterator.h.

Member Typedef Documentation

   typedef iterator_traits< _Iterator >::iterator_category  std::iterator< iterator_traits< _Iterator
       >::iterator_category , iterator_traits< _Iterator >::value_type , iterator_traits< _Iterator
       >::difference_type , iterator_traits< _Iterator >::pointer , iterator_traits< _Iterator >::reference
       >::iterator_category [inherited]
       One of the tag types.

       Definition at line 107 of file stl_iterator_base_types.h.

   typedef iterator_traits< _Iterator >::value_type  std::iterator< iterator_traits< _Iterator
       >::iterator_category , iterator_traits< _Iterator >::value_type , iterator_traits< _Iterator
       >::difference_type , iterator_traits< _Iterator >::pointer , iterator_traits< _Iterator >::reference
       >::value_type [inherited]
       The type 'pointed to' by the iterator.

       Definition at line 109 of file stl_iterator_base_types.h.

Constructor & Destructor Documentation

   template<typename _Iterator> std::reverse_iterator< _Iterator >::reverse_iterator () [inline]
       The default constructor default-initializes member current. If it is a pointer, that means it is zero-
       initialized.

       Definition at line 114 of file stl_iterator.h.

   template<typename _Iterator> std::reverse_iterator< _Iterator >::reverse_iterator (iterator_type__x)
       [inline],  [explicit]
       This iterator will move in the opposite direction that x does.

       Definition at line 120 of file stl_iterator.h.

   template<typename _Iterator> std::reverse_iterator< _Iterator >::reverse_iterator (const reverse_iterator<
       _Iterator > &__x) [inline]
       The copy constructor is normal.

       Definition at line 125 of file stl_iterator.h.

   template<typename _Iterator> template<typename _Iter > std::reverse_iterator< _Iterator >::reverse_iterator
       (const reverse_iterator< _Iter > &__x) [inline]
       A reverse_iterator across other types can be copied in the normal fashion.

       Definition at line 133 of file stl_iterator.h.

Member Function Documentation

   template<typename _Iterator> iterator_type std::reverse_iterator< _Iterator >::base () const [inline]
       Returns:
           current, the iterator used for underlying work.

       Definition at line 140 of file stl_iterator.h.

       Referenced by std::operator+(), std::operator-(), std::operator<(), and std::operator==().

   template<typename _Iterator> reference std::reverse_iterator< _Iterator >::operator* () const [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 149 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator std::reverse_iterator< _Iterator >::operator+
       (difference_type__n) const [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 220 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator& std::reverse_iterator< _Iterator >::operator++ () [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 170 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator std::reverse_iterator< _Iterator >::operator++ (int) [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 182 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator& std::reverse_iterator< _Iterator >::operator+=
       (difference_type__n) [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 229 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator std::reverse_iterator< _Iterator >::operator-
       (difference_type__n) const [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 241 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator& std::reverse_iterator< _Iterator >::operator-- () [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 195 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator std::reverse_iterator< _Iterator >::operator-- (int) [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 207 of file stl_iterator.h.

   template<typename _Iterator> reverse_iterator& std::reverse_iterator< _Iterator >::operator-=
       (difference_type__n) [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 250 of file stl_iterator.h.

   template<typename _Iterator> pointer std::reverse_iterator< _Iterator >::operator-> () const [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 161 of file stl_iterator.h.

   template<typename _Iterator> reference std::reverse_iterator< _Iterator >::operator[] (difference_type__n)
       const [inline]
       Returns:
           TODO

       Todo
           Doc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.

       Definition at line 262 of file stl_iterator.h.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.