reverse_iterator Class Template Reference

Inheritance diagram for reverse_iterator:

Inheritance graph
List of all members.

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.

Public Types

Public Member Functions

Protected Attributes


Member Typedef Documentation

typedef iterator_traits<_Iterator>::difference_type difference_type
 

Distance between iterators is represented as this type.

Reimplemented from iterator< iterator_traits< _Iterator >::iterator_category, iterator_traits< _Iterator >::value_type, iterator_traits< _Iterator >::difference_type, iterator_traits< _Iterator >::pointer, iterator_traits< _Iterator >::reference >.

Definition at line 103 of file stl_iterator.h.

typedef iterator_traits< _Iterator >::iterator_category iterator_category [inherited]
 

One of the tag types.

Definition at line 109 of file stl_iterator_base_types.h.

typedef iterator_traits<_Iterator>::pointer pointer
 

This type represents a pointer-to-value_type.

Reimplemented from iterator< iterator_traits< _Iterator >::iterator_category, iterator_traits< _Iterator >::value_type, iterator_traits< _Iterator >::difference_type, iterator_traits< _Iterator >::pointer, iterator_traits< _Iterator >::reference >.

Definition at line 105 of file stl_iterator.h.

typedef iterator_traits<_Iterator>::reference reference
 

This type represents a reference-to-value_type.

Reimplemented from iterator< iterator_traits< _Iterator >::iterator_category, iterator_traits< _Iterator >::value_type, iterator_traits< _Iterator >::difference_type, iterator_traits< _Iterator >::pointer, iterator_traits< _Iterator >::reference >.

Definition at line 104 of file stl_iterator.h.

typedef iterator_traits< _Iterator >::value_type value_type [inherited]
 

The type "pointed to" by the iterator.

Definition at line 111 of file stl_iterator_base_types.h.


Constructor & Destructor Documentation

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.

Referenced by reverse_iterator::operator+(), and reverse_iterator::operator-().

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.

reverse_iterator const reverse_iterator< _Iterator > &  __x  )  [inline]
 

The copy constructor is normal.

Definition at line 125 of file stl_iterator.h.

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

iterator_type base  )  const [inline]
 

Returns:
current, the iterator used for underlying work.

Definition at line 140 of file stl_iterator.h.

References reverse_iterator::current.

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

reference operator *  )  const [inline]
 

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

Definition at line 149 of file stl_iterator.h.

References reverse_iterator::current.

Referenced by reverse_iterator::operator->().

reverse_iterator operator+ difference_type  __n  )  const [inline]
 

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

Definition at line 219 of file stl_iterator.h.

References reverse_iterator::current, and reverse_iterator::reverse_iterator().

reverse_iterator operator++ int   )  [inline]
 

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

Definition at line 182 of file stl_iterator.h.

References reverse_iterator::current.

reverse_iterator& operator++  )  [inline]
 

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

Definition at line 170 of file stl_iterator.h.

References reverse_iterator::current.

reverse_iterator& operator+= difference_type  __n  )  [inline]
 

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

Definition at line 228 of file stl_iterator.h.

References reverse_iterator::current.

reverse_iterator operator- difference_type  __n  )  const [inline]
 

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

Definition at line 240 of file stl_iterator.h.

References reverse_iterator::current, and reverse_iterator::reverse_iterator().

reverse_iterator operator-- int   )  [inline]
 

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

Definition at line 206 of file stl_iterator.h.

References reverse_iterator::current.

reverse_iterator& operator--  )  [inline]
 

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

Definition at line 195 of file stl_iterator.h.

References reverse_iterator::current.

reverse_iterator& operator-= difference_type  __n  )  [inline]
 

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

Definition at line 249 of file stl_iterator.h.

References reverse_iterator::current.

pointer operator->  )  const [inline]
 

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

Definition at line 161 of file stl_iterator.h.

References reverse_iterator::operator *().

reference operator[] difference_type  __n  )  const [inline]
 

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

Definition at line 261 of file stl_iterator.h.


The documentation for this class was generated from the following file:
Generated on Tue May 23 12:56:15 2006 for libstdc++ source by  doxygen 1.4.4