.TH "std::counted_iterator< _It >" 3cxx "Sun Jan 8 2023" "libstdc++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
std::counted_iterator< _It > \- An iterator adaptor that keeps track of the distance to the end\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <iterator>\fP
.PP
Inherits std::__detail::__counted_iter_value_type< _It >, std::__detail::__counted_iter_concept< _It >, and std::__detail::__counted_iter_cat< _It >\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBdifference_type\fP = iter_difference_t< _It >"
.br
.ti -1c
.RI "using \fBiterator_type\fP = _It"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "constexpr \fBcounted_iterator\fP (_It __i, iter_difference_t< _It > __n)"
.br
.ti -1c
.RI "template<typename _It2 > 
.br
requires convertible_to<const _It2&, _It>constexpr \fBcounted_iterator\fP (const \fBcounted_iterator\fP< _It2 > &__x)"
.br
.ti -1c
.RI "constexpr _It \fBbase\fP () &&noexcept(is_nothrow_move_constructible_v< _It >)"
.br
.ti -1c
.RI "constexpr const _It & \fBbase\fP () const &noexcept"
.br
.ti -1c
.RI "constexpr iter_difference_t< _It > \fBcount\fP () const noexcept"
.br
.ti -1c
.RI "constexpr decltype(auto) \fBoperator*\fP () const noexcept(noexcept(*_M_current))"
.br
.ti -1c
.RI "constexpr decltype(auto) \fBoperator*\fP () noexcept(noexcept(*_M_current))"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP \fBoperator+\fP (iter_difference_t< _It > __n) const"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP & \fBoperator++\fP ()"
.br
.ti -1c
.RI "constexpr decltype(auto) \fBoperator++\fP (int)"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP \fBoperator++\fP (int)"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP & \fBoperator+=\fP (iter_difference_t< _It > __n)"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP \fBoperator\-\fP (iter_difference_t< _It > __n) const"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP & \fBoperator\-\-\fP ()"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP \fBoperator\-\-\fP (int)"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP & \fBoperator\-=\fP (iter_difference_t< _It > __n)"
.br
.ti -1c
.RI "constexpr auto \fBoperator\->\fP () const noexcept"
.br
.ti -1c
.RI "template<typename _It2 > 
.br
requires assignable_from<_It&, const _It2&>constexpr \fBcounted_iterator\fP & \fBoperator=\fP (const \fBcounted_iterator\fP< _It2 > &__x)"
.br
.ti -1c
.RI "constexpr decltype(auto) \fBoperator[]\fP (iter_difference_t< _It > __n) const noexcept(noexcept(_M_current[__n]))"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "constexpr iter_rvalue_reference_t< _It > \fBiter_move\fP (const \fBcounted_iterator\fP &__i) noexcept(noexcept(ranges::iter_move(__i\&._M_current)))"
.br
.ti -1c
.RI "template<indirectly_swappable< _It > _It2> constexpr void \fBiter_swap\fP (const \fBcounted_iterator\fP &__x, const \fBcounted_iterator\fP< _It2 > &__y) noexcept(noexcept(ranges::iter_swap(__x\&._M_current, __y\&._M_current)))"
.br
.ti -1c
.RI "constexpr \fBcounted_iterator\fP \fBoperator+\fP (iter_difference_t< _It > __n, const \fBcounted_iterator\fP &__x)"
.br
.ti -1c
.RI "template<common_with< _It > _It2> constexpr iter_difference_t< _It2 > \fBoperator\-\fP (const \fBcounted_iterator\fP &__x, const \fBcounted_iterator\fP< _It2 > &__y)"
.br
.ti -1c
.RI "constexpr iter_difference_t< _It > \fBoperator\-\fP (const \fBcounted_iterator\fP &__x, default_sentinel_t)"
.br
.ti -1c
.RI "constexpr iter_difference_t< _It > \fBoperator\-\fP (default_sentinel_t, const \fBcounted_iterator\fP &__y)"
.br
.ti -1c
.RI "template<common_with< _It > _It2> constexpr strong_ordering \fBoperator<=>\fP (const \fBcounted_iterator\fP &__x, const \fBcounted_iterator\fP< _It2 > &__y)"
.br
.ti -1c
.RI "template<common_with< _It > _It2> constexpr bool \fBoperator==\fP (const \fBcounted_iterator\fP &__x, const \fBcounted_iterator\fP< _It2 > &__y)"
.br
.ti -1c
.RI "constexpr bool \fBoperator==\fP (const \fBcounted_iterator\fP &__x, default_sentinel_t)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<input_or_output_iterator _It>
.br
class std::counted_iterator< _It >"An iterator adaptor that keeps track of the distance to the end\&. 
.PP
Definition at line \fB2306\fP of file \fBbits/iterator\fP\&.
.SH "Member Typedef Documentation"
.PP 
.SS "template<input_or_output_iterator _It> using \fBstd::counted_iterator\fP< _It >::difference_type =  iter_difference_t<_It>"

.PP
Definition at line \fB2314\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> using \fBstd::counted_iterator\fP< _It >::iterator_type =  _It"

.PP
Definition at line \fB2312\fP of file \fBbits/iterator\fP\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<input_or_output_iterator _It> constexpr \fBstd::counted_iterator\fP< _It >::counted_iterator (_It __i, iter_difference_t< _It > __n)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2321\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<typename _It2 > 
.br
requires convertible_to<const _It2&, _It>constexpr \fBstd::counted_iterator\fP< _It >::counted_iterator (const \fBcounted_iterator\fP< _It2 > & __x)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2328\fP of file \fBbits/iterator\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "template<input_or_output_iterator _It> constexpr _It \fBstd::counted_iterator\fP< _It >::base () &&\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2349\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr const _It & \fBstd::counted_iterator\fP< _It >::base () const &\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2344\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr iter_difference_t< _It > \fBstd::counted_iterator\fP< _It >::count () const\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2355\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr decltype(auto) \fBstd::counted_iterator\fP< _It >::operator* () const\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2368\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr decltype(auto) \fBstd::counted_iterator\fP< _It >::operator* ()\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2359\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP \fBstd::counted_iterator\fP< _It >::operator+ (iter_difference_t< _It > __n) const\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2431\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP & \fBstd::counted_iterator\fP< _It >::operator++ ()\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2383\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr decltype(auto) \fBstd::counted_iterator\fP< _It >::operator++ (int)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2392\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP \fBstd::counted_iterator\fP< _It >::operator++ (int)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2406\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP & \fBstd::counted_iterator\fP< _It >::operator+= (iter_difference_t< _It > __n)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2442\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP \fBstd::counted_iterator\fP< _It >::operator\- (iter_difference_t< _It > __n) const\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2453\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP & \fBstd::counted_iterator\fP< _It >::operator\-\- ()\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2414\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP \fBstd::counted_iterator\fP< _It >::operator\-\- (int)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2422\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP & \fBstd::counted_iterator\fP< _It >::operator\-= (iter_difference_t< _It > __n)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2475\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr auto \fBstd::counted_iterator\fP< _It >::operator\-> () const\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2378\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<typename _It2 > 
.br
requires assignable_from<_It&, const _It2&>constexpr \fBcounted_iterator\fP & \fBstd::counted_iterator\fP< _It >::operator= (const \fBcounted_iterator\fP< _It2 > & __x)\fC [inline]\fP, \fC [constexpr]\fP"

.PP
Definition at line \fB2335\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr decltype(auto) \fBstd::counted_iterator\fP< _It >::operator[] (iter_difference_t< _It > __n) const\fC [inline]\fP, \fC [constexpr]\fP, \fC [noexcept]\fP"

.PP
Definition at line \fB2486\fP of file \fBbits/iterator\fP\&.
.SH "Friends And Related Function Documentation"
.PP 
.SS "template<input_or_output_iterator _It> template<input_or_output_iterator _It2> friend class \fBcounted_iterator\fP\fC [friend]\fP"

.PP
Definition at line \fB2534\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr iter_rvalue_reference_t< _It > iter_move (const \fBcounted_iterator\fP< _It > & __i)\fC [friend]\fP"

.PP
Definition at line \fB2515\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<indirectly_swappable< _It > _It2> constexpr void iter_swap (const \fBcounted_iterator\fP< _It > & __x, const \fBcounted_iterator\fP< _It2 > & __y)\fC [friend]\fP"

.PP
Definition at line \fB2525\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr \fBcounted_iterator\fP operator+ (iter_difference_t< _It > __n, const \fBcounted_iterator\fP< _It > & __x)\fC [friend]\fP"

.PP
Definition at line \fB2437\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<common_with< _It > _It2> constexpr iter_difference_t< _It2 > operator\- (const \fBcounted_iterator\fP< _It > & __x, const \fBcounted_iterator\fP< _It2 > & __y)\fC [friend]\fP"

.PP
Definition at line \fB2460\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr iter_difference_t< _It > operator\- (const \fBcounted_iterator\fP< _It > & __x, default_sentinel_t)\fC [friend]\fP"

.PP
Definition at line \fB2466\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr iter_difference_t< _It > operator\- (default_sentinel_t, const \fBcounted_iterator\fP< _It > & __y)\fC [friend]\fP"

.PP
Definition at line \fB2471\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<common_with< _It > _It2> constexpr strong_ordering operator<=> (const \fBcounted_iterator\fP< _It > & __x, const \fBcounted_iterator\fP< _It2 > & __y)\fC [friend]\fP"

.PP
Definition at line \fB2508\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> template<common_with< _It > _It2> constexpr bool operator== (const \fBcounted_iterator\fP< _It > & __x, const \fBcounted_iterator\fP< _It2 > & __y)\fC [friend]\fP"

.PP
Definition at line \fB2497\fP of file \fBbits/iterator\fP\&.
.SS "template<input_or_output_iterator _It> constexpr bool operator== (const \fBcounted_iterator\fP< _It > & __x, default_sentinel_t)\fC [friend]\fP"

.PP
Definition at line \fB2503\fP of file \fBbits/iterator\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for libstdc++ from the source code\&.