libstdc++
std::_Deque_iterator< _Tp, _Ref, _Ptr > Struct Template Reference

#include <stl_deque.h>

Public Types

typedef __ptr_rebind< _Ptr, _Tp > _Elt_pointer
typedef __ptr_rebind< _Ptr, _Elt_pointer > _Map_pointer
typedef _Deque_iterator _Self
typedef __iter< const _Tp > const_iterator
typedef ptrdiff_t difference_type
typedef __iter< _Tp > iterator
typedef std::random_access_iterator_tag iterator_category
typedef _Ptr pointer
typedef _Ref reference
typedef size_t size_type
typedef _Tp value_type

Public Member Functions

constexpr _Deque_iterator (_Elt_pointer __x, _Map_pointer __y) noexcept
constexpr _Deque_iterator (const _Deque_iterator &__x) noexcept
template<typename _Iter, typename = _Require<is_same<_Self, const_iterator>, is_same<_Iter, iterator>>>
constexpr _Deque_iterator (const _Iter &__x) noexcept
constexpr iterator _M_const_cast () const noexcept
constexpr void _M_set_node (_Map_pointer __new_node) noexcept
constexpr reference operator* () const noexcept
constexpr _Self & operator++ () noexcept
constexpr _Self operator++ (int) noexcept
constexpr _Self & operator+= (difference_type __n) noexcept
constexpr _Self & operator-- () noexcept
constexpr _Self operator-- (int) noexcept
constexpr _Self & operator-= (difference_type __n) noexcept
constexpr pointer operator-> () const noexcept
_Deque_iterator & operator= (const _Deque_iterator &)=default
constexpr reference operator[] (difference_type __n) const noexcept

Static Public Member Functions

static constexpr size_t _S_buffer_size () noexcept
template<typename _Fn>
static _Self _S_for_each_segment (_Self __first, _Self __last, _Fn __func)

Public Attributes

_Elt_pointer _M_cur
_Elt_pointer _M_first
_Elt_pointer _M_last
_Map_pointer _M_node

Static Public Attributes

static const bool _S_enable_for_each_segment

Friends

constexpr _Self operator+ (const _Self &__x, difference_type __n) noexcept
constexpr _Self operator+ (difference_type __n, const _Self &__x) noexcept
template<typename _RefR, typename _PtrR>
constexpr difference_type operator- (const _Self &__x, const _Deque_iterator< _Tp, _RefR, _PtrR > &__y) noexcept
constexpr difference_type operator- (const _Self &__x, const _Self &__y) noexcept
constexpr _Self operator- (const _Self &__x, difference_type __n) noexcept
constexpr strong_ordering operator<=> (const _Self &__x, const _Self &__y) noexcept
template<typename _RefR, typename _PtrR>
constexpr bool operator== (const _Self &__x, const _Deque_iterator< _Tp, _RefR, _PtrR > &__y) noexcept
constexpr bool operator== (const _Self &__x, const _Self &__y) noexcept

Detailed Description

template<typename _Tp, typename _Ref, typename _Ptr>
struct std::_Deque_iterator< _Tp, _Ref, _Ptr >

A deque::iterator.

Quite a bit of intelligence here. Much of the functionality of deque is actually passed off to this class. A deque holds two of these internally, marking its valid range. Access to elements is done as offsets of either of those two, relying on operator overloading in this class.

All the functions are op overloads except for _M_set_node.

Definition at line 116 of file stl_deque.h.

Member Typedef Documentation

◆ _Elt_pointer

template<typename _Tp, typename _Ref, typename _Ptr>
typedef __ptr_rebind<_Ptr, _Tp> std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Elt_pointer

Definition at line 130 of file stl_deque.h.

◆ _Map_pointer

template<typename _Tp, typename _Ref, typename _Ptr>
typedef __ptr_rebind<_Ptr, _Elt_pointer> std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Map_pointer

Definition at line 131 of file stl_deque.h.

◆ _Self

template<typename _Tp, typename _Ref, typename _Ptr>
typedef _Deque_iterator std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Self

Definition at line 144 of file stl_deque.h.

◆ const_iterator

template<typename _Tp, typename _Ref, typename _Ptr>
typedef __iter<const _Tp> std::_Deque_iterator< _Tp, _Ref, _Ptr >::const_iterator

Definition at line 129 of file stl_deque.h.

◆ difference_type

template<typename _Tp, typename _Ref, typename _Ptr>
typedef ptrdiff_t std::_Deque_iterator< _Tp, _Ref, _Ptr >::difference_type

Definition at line 143 of file stl_deque.h.

◆ iterator

template<typename _Tp, typename _Ref, typename _Ptr>
typedef __iter<_Tp> std::_Deque_iterator< _Tp, _Ref, _Ptr >::iterator

Definition at line 128 of file stl_deque.h.

◆ iterator_category

template<typename _Tp, typename _Ref, typename _Ptr>
typedef std::random_access_iterator_tag std::_Deque_iterator< _Tp, _Ref, _Ptr >::iterator_category

Definition at line 138 of file stl_deque.h.

◆ pointer

template<typename _Tp, typename _Ref, typename _Ptr>
typedef _Ptr std::_Deque_iterator< _Tp, _Ref, _Ptr >::pointer

Definition at line 140 of file stl_deque.h.

◆ reference

template<typename _Tp, typename _Ref, typename _Ptr>
typedef _Ref std::_Deque_iterator< _Tp, _Ref, _Ptr >::reference

Definition at line 141 of file stl_deque.h.

◆ size_type

template<typename _Tp, typename _Ref, typename _Ptr>
typedef size_t std::_Deque_iterator< _Tp, _Ref, _Ptr >::size_type

Definition at line 142 of file stl_deque.h.

◆ value_type

template<typename _Tp, typename _Ref, typename _Ptr>
typedef _Tp std::_Deque_iterator< _Tp, _Ref, _Ptr >::value_type

Definition at line 139 of file stl_deque.h.

Constructor & Destructor Documentation

◆ _Deque_iterator() [1/4]

template<typename _Tp, typename _Ref, typename _Ptr>
std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Deque_iterator ( _Elt_pointer __x,
_Map_pointer __y )
inlineconstexprnoexcept

Definition at line 152 of file stl_deque.h.

◆ _Deque_iterator() [2/4]

template<typename _Tp, typename _Ref, typename _Ptr>
std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Deque_iterator ( )
inlineconstexprnoexcept

Definition at line 157 of file stl_deque.h.

◆ _Deque_iterator() [3/4]

template<typename _Tp, typename _Ref, typename _Ptr>
template<typename _Iter, typename = _Require<is_same<_Self, const_iterator>, is_same<_Iter, iterator>>>
std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Deque_iterator ( const _Iter & __x)
inlineconstexprnoexcept

Definition at line 171 of file stl_deque.h.

◆ _Deque_iterator() [4/4]

template<typename _Tp, typename _Ref, typename _Ptr>
std::_Deque_iterator< _Tp, _Ref, _Ptr >::_Deque_iterator ( const _Deque_iterator< _Tp, _Ref, _Ptr > & __x)
inlineconstexprnoexcept

Definition at line 176 of file stl_deque.h.

Member Function Documentation

◆ _M_const_cast()

template<typename _Tp, typename _Ref, typename _Ptr>
iterator std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_const_cast ( ) const
inlineconstexprnoexcept

Definition at line 184 of file stl_deque.h.

◆ _M_set_node()

template<typename _Tp, typename _Ref, typename _Ptr>
void std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_set_node ( _Map_pointer __new_node)
inlineconstexprnoexcept

Prepares to traverse new_node. Sets everything except _M_cur, which should therefore be set by the caller immediately afterwards, based on _M_first and _M_last.

Definition at line 271 of file stl_deque.h.

◆ _S_buffer_size()

template<typename _Tp, typename _Ref, typename _Ptr>
constexpr size_t std::_Deque_iterator< _Tp, _Ref, _Ptr >::_S_buffer_size ( )
inlinestaticconstexprnoexcept

Definition at line 135 of file stl_deque.h.

◆ _S_for_each_segment()

template<typename _Tp, typename _Ref, typename _Ptr>
template<typename _Fn>
_Self std::_Deque_iterator< _Tp, _Ref, _Ptr >::_S_for_each_segment ( _Self __first,
_Self __last,
_Fn __func )
inlinestatic

Definition at line 428 of file stl_deque.h.

◆ operator*()

template<typename _Tp, typename _Ref, typename _Ptr>
reference std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator* ( ) const
inlinenodiscardconstexprnoexcept

Definition at line 189 of file stl_deque.h.

◆ operator++() [1/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self & std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator++ ( )
inlineconstexprnoexcept

Definition at line 198 of file stl_deque.h.

◆ operator++() [2/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator++ ( int )
inlineconstexprnoexcept

Definition at line 210 of file stl_deque.h.

◆ operator+=()

template<typename _Tp, typename _Ref, typename _Ptr>
_Self & std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator+= ( difference_type __n)
inlineconstexprnoexcept

Definition at line 238 of file stl_deque.h.

◆ operator--() [1/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self & std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator-- ( )
inlineconstexprnoexcept

Definition at line 218 of file stl_deque.h.

◆ operator--() [2/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator-- ( int )
inlineconstexprnoexcept

Definition at line 230 of file stl_deque.h.

◆ operator-=()

template<typename _Tp, typename _Ref, typename _Ptr>
_Self & std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator-= ( difference_type __n)
inlineconstexprnoexcept

Definition at line 257 of file stl_deque.h.

◆ operator->()

template<typename _Tp, typename _Ref, typename _Ptr>
pointer std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator-> ( ) const
inlinenodiscardconstexprnoexcept

Definition at line 194 of file stl_deque.h.

◆ operator[]()

template<typename _Tp, typename _Ref, typename _Ptr>
reference std::_Deque_iterator< _Tp, _Ref, _Ptr >::operator[] ( difference_type __n) const
inlinenodiscardconstexprnoexcept

Definition at line 262 of file stl_deque.h.

◆ operator+ [1/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self operator+ ( const _Self & __x,
difference_type __n )
friend

Definition at line 405 of file stl_deque.h.

◆ operator+ [2/2]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self operator+ ( difference_type __n,
const _Self & __x )
friend

Definition at line 423 of file stl_deque.h.

◆ operator- [1/3]

template<typename _Tp, typename _Ref, typename _Ptr>
template<typename _RefR, typename _PtrR>
difference_type operator- ( const _Self & __x,
const _Deque_iterator< _Tp, _RefR, _PtrR > & __y )
friend

Definition at line 393 of file stl_deque.h.

◆ operator- [2/3]

template<typename _Tp, typename _Ref, typename _Ptr>
difference_type operator- ( const _Self & __x,
const _Self & __y )
friend

Definition at line 378 of file stl_deque.h.

◆ operator- [3/3]

template<typename _Tp, typename _Ref, typename _Ptr>
_Self operator- ( const _Self & __x,
difference_type __n )
friend

Definition at line 414 of file stl_deque.h.

◆ operator<=>

template<typename _Tp, typename _Ref, typename _Ptr>
strong_ordering operator<=> ( const _Self & __x,
const _Self & __y )
friend

Definition at line 296 of file stl_deque.h.

◆ operator== [1/2]

template<typename _Tp, typename _Ref, typename _Ptr>
template<typename _RefR, typename _PtrR>
bool operator== ( const _Self & __x,
const _Deque_iterator< _Tp, _RefR, _PtrR > & __y )
friend

Definition at line 289 of file stl_deque.h.

◆ operator== [2/2]

template<typename _Tp, typename _Ref, typename _Ptr>
bool operator== ( const _Self & __x,
const _Self & __y )
friend

Definition at line 280 of file stl_deque.h.

Member Data Documentation

◆ _M_cur

template<typename _Tp, typename _Ref, typename _Ptr>
_Elt_pointer std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_cur

Definition at line 146 of file stl_deque.h.

◆ _M_first

template<typename _Tp, typename _Ref, typename _Ptr>
_Elt_pointer std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_first

Definition at line 147 of file stl_deque.h.

◆ _M_last

template<typename _Tp, typename _Ref, typename _Ptr>
_Elt_pointer std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_last

Definition at line 148 of file stl_deque.h.

◆ _M_node

template<typename _Tp, typename _Ref, typename _Ptr>
_Map_pointer std::_Deque_iterator< _Tp, _Ref, _Ptr >::_M_node

Definition at line 149 of file stl_deque.h.

◆ _S_enable_for_each_segment

template<typename _Tp, typename _Ref, typename _Ptr>
const bool std::_Deque_iterator< _Tp, _Ref, _Ptr >::_S_enable_for_each_segment
static

Definition at line 461 of file stl_deque.h.

The documentation for this struct was generated from the following files: