libstdc++
Public Types | Public Member Functions | Protected Types | Protected Attributes
std::reverse_iterator Class Reference
Iterators
Inheritance diagram for std::reverse_iterator:
Inheritance graph
[legend]

List of all members.

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

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.

Member Typedef Documentation

typedef __traits_type::difference_type std::reverse_iterator::difference_type

Distance between iterators is represented as this type.

Reimplemented from 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 >.

Definition at line 111 of file stl_iterator.h.

typedef _Category std::iterator::iterator_category [inherited]

One of the tag types.

Definition at line 122 of file stl_iterator_base_types.h.

typedef __traits_type::pointer std::reverse_iterator::pointer

This type represents a pointer-to-value_type.

Reimplemented from 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 >.

Definition at line 112 of file stl_iterator.h.

typedef __traits_type::reference std::reverse_iterator::reference

This type represents a reference-to-value_type.

Reimplemented from 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 >.

Definition at line 113 of file stl_iterator.h.

typedef _Tp std::iterator::value_type [inherited]

The type "pointed to" by the iterator.

Definition at line 124 of file stl_iterator_base_types.h.

Constructor & Destructor Documentation

std::reverse_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 121 of file stl_iterator.h.

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

std::reverse_iterator::reverse_iterator ( iterator_type  __x) [inline, explicit]

This iterator will move in the opposite direction that x does.

Definition at line 127 of file stl_iterator.h.

std::reverse_iterator::reverse_iterator ( const reverse_iterator &  __x) [inline]

The copy constructor is normal.

Definition at line 132 of file stl_iterator.h.

template<typename _Iter >
std::reverse_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 140 of file stl_iterator.h.

Member Function Documentation

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

Definition at line 147 of file stl_iterator.h.

reference std::reverse_iterator::operator* ( ) const [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 156 of file stl_iterator.h.

Referenced by operator->().

reverse_iterator std::reverse_iterator::operator+ ( difference_type  __n) const [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 227 of file stl_iterator.h.

References reverse_iterator().

reverse_iterator& std::reverse_iterator::operator++ ( ) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 177 of file stl_iterator.h.

reverse_iterator std::reverse_iterator::operator++ ( int  ) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 189 of file stl_iterator.h.

reverse_iterator& std::reverse_iterator::operator+= ( difference_type  __n) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 236 of file stl_iterator.h.

reverse_iterator std::reverse_iterator::operator- ( difference_type  __n) const [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 248 of file stl_iterator.h.

References reverse_iterator().

reverse_iterator& std::reverse_iterator::operator-- ( ) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 202 of file stl_iterator.h.

reverse_iterator std::reverse_iterator::operator-- ( int  ) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 214 of file stl_iterator.h.

reverse_iterator& std::reverse_iterator::operator-= ( difference_type  __n) [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 257 of file stl_iterator.h.

pointer std::reverse_iterator::operator-> ( ) const [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 168 of file stl_iterator.h.

References operator*().

reference std::reverse_iterator::operator[] ( difference_type  __n) const [inline]
Returns:
TODO
Todo:
Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html

Definition at line 269 of file stl_iterator.h.

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