.TH "std::reverse_iterator< _Iterator >" 3cxx "Wed Jul 14 2021" "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::reverse_iterator< _Iterator > .SH SYNOPSIS .br .PP .PP Inherits \fBstd::iterator< iterator_traits< _Iterator >::iterator_category, iterator_traits< _Iterator >::value_type, iterator_traits< _Iterator >::difference_type, iterator_traits< _Iterator >::pointer, iterator_traits< _Iterator >::reference >\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "typedef __traits_type::difference_type \fBdifference_type\fP" .br .ti -1c .RI "typedef \fBiterator_traits\fP< _Iterator >::\fBiterator_category\fP \fBiterator_category\fP" .br .RI "One of the \fBtag types\fP\&. " .ti -1c .RI "typedef _Iterator \fBiterator_type\fP" .br .ti -1c .RI "typedef __traits_type::pointer \fBpointer\fP" .br .ti -1c .RI "typedef __traits_type::reference \fBreference\fP" .br .ti -1c .RI "typedef \fBiterator_traits\fP< _Iterator >::\fBvalue_type\fP \fBvalue_type\fP" .br .RI "The type 'pointed to' by the iterator\&. " .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "constexpr \fBreverse_iterator\fP ()" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP (const \fBreverse_iterator\fP &__x)" .br .ti -1c .RI "template constexpr \fBreverse_iterator\fP (const \fBreverse_iterator\fP< _Iter > &__x)" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP (iterator_type __x)" .br .ti -1c .RI "constexpr iterator_type \fBbase\fP () const" .br .ti -1c .RI "constexpr reference \fBoperator*\fP () const" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP \fBoperator+\fP (difference_type __n) const" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP & \fBoperator++\fP ()" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP \fBoperator++\fP (int)" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP & \fBoperator+=\fP (difference_type __n)" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP \fBoperator\-\fP (difference_type __n) const" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP & \fBoperator\-\-\fP ()" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP \fBoperator\-\-\fP (int)" .br .ti -1c .RI "constexpr \fBreverse_iterator\fP & \fBoperator\-=\fP (difference_type __n)" .br .ti -1c .RI "constexpr pointer \fBoperator\->\fP () const" .br .ti -1c .RI "\fBreverse_iterator\fP & \fBoperator=\fP (const \fBreverse_iterator\fP &)=default" .br .ti -1c .RI "constexpr reference \fBoperator[]\fP (difference_type __n) const" .br .in -1c .SS "Protected Types" .in +1c .ti -1c .RI "typedef \fBiterator_traits\fP< _Iterator > \fB__traits_type\fP" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "_Iterator \fBcurrent\fP" .br .in -1c .SH "Detailed Description" .PP .SS "template .br 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 \fCi\fP is established by the identity: .PP .nf &*(reverse_iterator(i)) == &*(i - 1) .fi .PP .PP \fIThis 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\&.\fP [24\&.4\&.1]/1,2 .PP 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\&. .PP Definition at line 125 of file bits/stl_iterator\&.h\&. .SH "Member Typedef Documentation" .PP .SS "typedef \fBiterator_traits\fP< _Iterator >::\fBiterator_category\fP \fBstd::iterator\fP< \fBiterator_traits\fP< _Iterator >::\fBiterator_category\fP , \fBiterator_traits\fP< _Iterator >::\fBvalue_type\fP , \fBiterator_traits\fP< _Iterator >::difference_type , \fBiterator_traits\fP< _Iterator >::pointer , \fBiterator_traits\fP< _Iterator >::reference >::\fBiterator_category\fP\fC [inherited]\fP" .PP One of the \fBtag types\fP\&. .PP Definition at line 130 of file stl_iterator_base_types\&.h\&. .SS "typedef \fBiterator_traits\fP< _Iterator >::\fBvalue_type\fP \fBstd::iterator\fP< \fBiterator_traits\fP< _Iterator >::\fBiterator_category\fP , \fBiterator_traits\fP< _Iterator >::\fBvalue_type\fP , \fBiterator_traits\fP< _Iterator >::difference_type , \fBiterator_traits\fP< _Iterator >::pointer , \fBiterator_traits\fP< _Iterator >::reference >::\fBvalue_type\fP\fC [inherited]\fP" .PP The type 'pointed to' by the iterator\&. .PP Definition at line 132 of file stl_iterator_base_types\&.h\&. .SH "Constructor & Destructor Documentation" .PP .SS "template constexpr \fBstd::reverse_iterator\fP< _Iterator >::\fBreverse_iterator\fP ()\fC [inline]\fP, \fC [constexpr]\fP" The default constructor value-initializes member \fCcurrent\fP\&. If it is a pointer, that means it is zero-initialized\&. .PP Definition at line 164 of file bits/stl_iterator\&.h\&. .PP Referenced by std::reverse_iterator< _Iterator >::operator+(), and std::reverse_iterator< _Iterator >::operator\-()\&. .SS "template constexpr \fBstd::reverse_iterator\fP< _Iterator >::\fBreverse_iterator\fP (iterator_type __x)\fC [inline]\fP, \fC [explicit]\fP, \fC [constexpr]\fP" This iterator will move in the opposite direction that \fCx\fP does\&. .PP Definition at line 170 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBstd::reverse_iterator\fP< _Iterator >::\fBreverse_iterator\fP (const \fBreverse_iterator\fP< _Iterator > & __x)\fC [inline]\fP, \fC [constexpr]\fP" The copy constructor is normal\&. .PP Definition at line 176 of file bits/stl_iterator\&.h\&. .SS "template template constexpr \fBstd::reverse_iterator\fP< _Iterator >::\fBreverse_iterator\fP (const \fBreverse_iterator\fP< _Iter > & __x)\fC [inline]\fP, \fC [constexpr]\fP" A reverse_iterator across other types can be copied if the underlying iterator can be converted to the type of \fCcurrent\fP\&. .PP Definition at line 189 of file bits/stl_iterator\&.h\&. .SH "Member Function Documentation" .PP .SS "template constexpr iterator_type \fBstd::reverse_iterator\fP< _Iterator >::base () const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 \fCcurrent\fP, the iterator used for underlying work\&. .RE .PP .PP Definition at line 196 of file bits/stl_iterator\&.h\&. .PP Referenced by std::operator==()\&. .SS "template constexpr reference \fBstd::reverse_iterator\fP< _Iterator >::operator* () const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 A reference to the value at \fC--current\fP .RE .PP This requires that \fC--current\fP is dereferenceable\&. .PP \fBWarning\fP .RS 4 This implementation requires that for an iterator of the underlying iterator type, \fCx\fP, a reference obtained by \fC*x\fP remains valid after \fCx\fP has been modified or destroyed\&. This is a bug: http://gcc.gnu.org/PR51823 .RE .PP .PP Definition at line 210 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP \fBstd::reverse_iterator\fP< _Iterator >::operator+ (difference_type __n) const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 A reverse_iterator that refers to \fCcurrent\fP - \fI__n\fP .RE .PP The underlying iterator must be a Random Access Iterator\&. .PP Definition at line 291 of file bits/stl_iterator\&.h\&. .PP References std::reverse_iterator< _Iterator >::reverse_iterator()\&. .SS "template constexpr \fBreverse_iterator\fP& \fBstd::reverse_iterator\fP< _Iterator >::operator++ ()\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 \fC*this\fP .RE .PP Decrements the underlying iterator\&. .PP Definition at line 241 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP \fBstd::reverse_iterator\fP< _Iterator >::operator++ (int)\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 The original value of \fC*this\fP .RE .PP Decrements the underlying iterator\&. .PP Definition at line 253 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP& \fBstd::reverse_iterator\fP< _Iterator >::operator+= (difference_type __n)\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 *this .RE .PP Moves the underlying iterator backwards \fI__n\fP steps\&. The underlying iterator must be a Random Access Iterator\&. .PP Definition at line 301 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP \fBstd::reverse_iterator\fP< _Iterator >::operator\- (difference_type __n) const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 A reverse_iterator that refers to \fCcurrent\fP - \fI__n\fP .RE .PP The underlying iterator must be a Random Access Iterator\&. .PP Definition at line 313 of file bits/stl_iterator\&.h\&. .PP References std::reverse_iterator< _Iterator >::reverse_iterator()\&. .SS "template constexpr \fBreverse_iterator\fP& \fBstd::reverse_iterator\fP< _Iterator >::operator\-\- ()\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 \fC*this\fP .RE .PP Increments the underlying iterator\&. .PP Definition at line 266 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP \fBstd::reverse_iterator\fP< _Iterator >::operator\-\- (int)\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 A reverse_iterator with the previous value of \fC*this\fP .RE .PP Increments the underlying iterator\&. .PP Definition at line 278 of file bits/stl_iterator\&.h\&. .SS "template constexpr \fBreverse_iterator\fP& \fBstd::reverse_iterator\fP< _Iterator >::operator\-= (difference_type __n)\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 *this .RE .PP Moves the underlying iterator forwards \fI__n\fP steps\&. The underlying iterator must be a Random Access Iterator\&. .PP Definition at line 323 of file bits/stl_iterator\&.h\&. .SS "template constexpr pointer \fBstd::reverse_iterator\fP< _Iterator >::operator\-> () const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 A pointer to the value at \fC--current\fP .RE .PP This requires that \fC--current\fP is dereferenceable\&. .PP Definition at line 222 of file bits/stl_iterator\&.h\&. .SS "template constexpr reference \fBstd::reverse_iterator\fP< _Iterator >::operator[] (difference_type __n) const\fC [inline]\fP, \fC [constexpr]\fP" .PP \fBReturns\fP .RS 4 The value at \fCcurrent\fP - \fI__n\fP - 1 .RE .PP The underlying iterator must be a Random Access Iterator\&. .PP Definition at line 335 of file bits/stl_iterator\&.h\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.