std::experimental::ranges::iterator_category

From cppreference.com
< cpp‎ | experimental‎ | ranges
 
 
Experimental
Technical Specification
Filesystem library (filesystem TS)
Library fundamentals (library fundamentals TS)
Library fundamentals 2 (library fundamentals TS v2)
Library fundamentals 3 (library fundamentals TS v3)
Extensions for parallelism (parallelism TS)
Extensions for parallelism 2 (parallelism TS v2)
Extensions for concurrency (concurrency TS)
Extensions for concurrency 2 (concurrency TS v2)
Concepts (concepts TS)
Ranges (ranges TS)
Reflection (reflection TS)
Mathematical special functions (special functions TR)
Experimental Non-TS
Pattern Matching
Linear Algebra
std::execution
Contracts
2D Graphics
 
 
Iterators library
Iterator concepts
Indirect callable concepts
                                                  
                                                  
                                                  
Common algorithm requirements
                                                  
Concept utilities
Iterator utilities and operations
Iterator traits
Iterator adaptors
Stream iterators
 
template< class I >
struct iterator_category {};
(1)
template< class T >
struct iterator_category<T*>;
(2)
template< class T >
struct iterator_category<const T> : iterator_category<T> {};
(3)
template< class T >

    requires requires { typename T::iterator_category; }

struct iterator_category<T>;
(4)

Computes the iterator category of the class I, if any. Users may specialize iterator_category for a program-defined type.

1) Primary template is an empty struct.
2) Specialization for pointers. If T is an object type, provides a member type type equal to ranges::random_access_iterator_tag. Otherwise, there is no member type.
3) Specialization for const-qualified types.
4) Specialization for types that define a public and accessible member type iterator_category. If T::iterator_category is the same as or derived from one of iterator category tags in namespace std, it is mapped to the corresponding tag in the namespace ranges as described below. Otherwise, provides a member type type equal to T::iterator_category.
  • If T::iterator_category is the same as or derives from std::random_access_iterator_tag, provides a member type type equal to ranges::random_access_iterator_tag.
  • Otherwise, if T::iterator_category is the same as or derives from std::bidirectional_iterator_tag, provides a member type type equal to ranges::bidirectional_iterator_tag.
  • Otherwise, if T::iterator_category is the same as or derives from std::forward_iterator_tag, provides a member type type equal to ranges::forward_iterator_tag.
  • Otherwise, if T::iterator_category is the same as or derives from std::input_iterator_tag, provides a member type type equal to ranges::input_iterator_tag.
  • Otherwise, if T::iterator_category is the same as or derives from std::output_iterator_tag, there is no member type.

Helper alias template

template< class T >
using iterator_category_t = typename ranges::iterator_category<T>::type;
(ranges TS)

Example

See also

empty class types used to indicate iterator categories
(class)
empty class types used to indicate iterator categories
(class)
compatibility traits class that collects an iterator’s associated types
(alias template)