Namespaces
Variants
Views
Actions

std::iter_value_t, std::iter_reference_t, std::iter_const_reference_t, std::iter_difference_t, std::iter_rvalue_reference_t, std::iter_common_reference_t

From cppreference.com
< cpp‎ | iterator
Revision as of 04:09, 28 June 2023 by Space Mission (Talk | contribs)

 
 
Iterator library
Iterator concepts
Iterator primitives
iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t
(C++20)(C++20)(C++20)(C++23)(C++20)(C++20)
Algorithm concepts and utilities
Indirect callable concepts
Common algorithm requirements
(C++20)
(C++20)
(C++20)
Utilities
(C++20)
Iterator adaptors
Range access
(C++11)(C++14)
(C++14)(C++14)  
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
(C++17)
 
Defined in header <iterator>
template< class T >
concept /*dereferenceable*/ = /* see below */; // exposition only
template< class T >
using iter_value_t = /* see below */;
(1) (since C++20)
template< /*dereferenceable*/ T >
using iter_reference_t = decltype(*std::declval<T&>());
(2) (since C++20)
template< std::indirectly_readable T >

using iter_const_reference_t = std::common_reference_t<const std::iter_value_t<T>&&,

                                                       std::iter_reference_t<T>>;
(3) (since C++23)
template< class T >
using iter_difference_t = /* see below */;
(4) (since C++20)
template< /*dereferenceable*/ T>

    requires /* see below */

using iter_rvalue_reference_t = decltype(ranges::iter_move(std::declval<T&>()));
(5) (since C++20)
template< std::indirectly_readable T >

using iter_common_reference_t = std::common_reference_t<std::iter_reference_t<T>,

                                                        std::iter_value_t<T>&>;
(6) (since C++20)

Compute the associated types of an iterator. The exposition-only concept dereferenceable is satisfied if and only if the expression *std::declval<T&>() is valid and has a referenceable type (in particular, not void).

1) Computes the value type of T. If std::iterator_traits<std::remove_cvref_t<T>> is not specialized, then std::iter_value_t<T> is std::indirectly_readable_traits<std::remove_cvref_t<T>>::value_type. Otherwise, it is std::iterator_traits<std::remove_cvref_t<T>>::value_type.
2) Computes the reference type of T.
3) Computes the const reference type of T.
4) Computes the difference type of T. If std::iterator_traits<std::remove_cvref_t<T>> is not specialized, then std::iter_difference_t<T> is std::incrementable_traits<std::remove_cvref_t<T>>::difference_type. Otherwise, it is std::iterator_traits<std::remove_cvref_t<T>>::difference_type.
5) Computes the rvalue reference type of T. The "see below" portion of the constraint on this alias template is satisfied if and only if the expression ranges::iter_move(std::declval<T&>()) is valid and has a referenceable type (in particular, not void).
6) Computes the common reference type of T. This is the common reference type between its reference type and an lvalue reference to its value type.

See also

specifies that a type is indirectly readable by applying operator *
(concept) [edit]
specifies that a semiregular type can be incremented with pre- and post-increment operators
(concept) [edit]
computes the value type of an indirectly_readable type
(class template) [edit]
computes the difference type of a weakly_incrementable type
(class template) [edit]
provides uniform interface to the properties of an iterator
(class template) [edit]