std::ranges::adjacent_view<V,N>::iterator

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Ranges library

Range access begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata empty

Range conversions std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

Dangling iterator handling dangling borrowed_iterator_t borrowed_subrange_t

Range primitives
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

Range concepts
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	constant_range (C++23)

Views
view_interface	subrange

Range factories
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Range adaptors
views::all_tviews::all ref_view owning_view as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (C++26)(C++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

Range generators std::generator (C++23)

Range adaptor closure objects range_adaptor_closure (C++23)

Range adaptor objects

Helper items
copyable-box movable-box (until C++23)  (C++23)	simple-view non-propagating-cache

 

std::ranges::adjacent_view

Member functions

adjacent_view::adjacent_view

adjacent_view::begin

adjacent_view::end

adjacent_view::size

Iterator

Member functions

adjacent_view::iterator::iterator

adjacent_view::iterator::operator*

adjacent_view::iterator::operator[]

adjacent_view::iterator::operator++ adjacent_view::iterator::operator++(int) adjacent_view::iterator::operator-- adjacent_view::iterator::operator--(int) adjacent_view::iterator::operator+= adjacent_view::iterator::operator-=

Non-member functions

operator==(adjacent_view::iterator) operator<(adjacent_view::iterator) operator>(adjacent_view::iterator) operator<=(adjacent_view::iterator) operator>=(adjacent_view::iterator) operator<=>(adjacent_view::iterator)

operator+(adjacent_view::iterator) operator-(adjacent_view::iterator)

iter_move(adjacent_view::iterator)

iter_swap(adjacent_view::iterator)

Sentinel

Member functions

adjacent_view::sentinel::sentinel

Non-member functions

operator==(adjacent_view::iterator,adjacent_view::sentinel)

operator-(adjacent_view::iterator,adjacent_view::sentinel)

 

template< bool Const > class /*iterator*/		(since C++23) (exposition only*)

The return type of adjacent_view::begin, and of adjacent_view::end when the underlying view V is a common_range.

The type /*iterator*/<true> is returned by the const-qualified overloads. The type /*iterator*/<false> is returned by the non-const-qualified overloads.

Member types

Member type	Definition
Base (private)	const V if Const is true, otherwise V. (exposition-only member type*)
iterator_category	std::input_iterator_tag
iterator_concept	std::random_access_iterator_tag, if Base models random_access_range. Otherwise, std::bidirectional_iterator_tag, if Base models bidirectional_range. Otherwise, std::forward_iterator_tag.
value_type	std::tuple</*REPEAT*/(ranges::range_value_t<Base>, N)...>;
difference_type	ranges::range_difference_t<Base>

Data members

Member object	Definition
current_ (private)	std::array<ranges::iterator_t<Base>, N>. (exposition-only member object*)

Member functions

(constructor)	constructs an iterator (public member function)
operator*	accesses the element (public member function)
operator[]	accesses an element by index (public member function)
operator++operator++(int)operator--operator--(int)operator+=operator-=	advances or decrements the underlying iterators (public member function)

Non-member functions

operator==operator<operator>operator<=operator>=operator<=> (C++23)	compares the underlying iterators (function)
operator+operator- (C++23)	performs iterator arithmetic (function)
iter_move (C++23)	casts the result of dereferencing the underlying iterator to its associated rvalue reference type (function)
iter_swap (C++23)	swaps the objects pointed to by two underlying iterators (function)

Example

Run this code

#include <cassert>
#include <concepts>
#include <list>
#include <ranges>
#include <tuple>
#include <utility>
#include <vector>
 
int main()
{
    auto v = std::vector{0, 1, 2, 3, 4, 5};
    auto i = (v | std::views::adjacent<3>).begin();
    using I = decltype(i);
    static_assert(std::same_as<I::value_type, std::tuple<int, int, int>>);
    static_assert(std::same_as<I::iterator_concept, std::random_access_iterator_tag>);
    // some of available operators:
    ++i; i++; --i; i--; i += 2; i -= 2;
    assert(i[2] == std::tuple(2, 3, 4));
    using DI = decltype(*i);
    static_assert(std::same_as<DI, std::tuple<int&, int&, int&>>);
    std::get<1>(*i) = 42; // modifies v[1] via iterator i
    assert(v[1] == 42);
 
    auto l = std::list{0, 1, 2, 3, 4, 5};
    auto j = (l | std::views::adjacent<3>).begin();
    using J = decltype(j);
    static_assert(std::same_as<J::value_type, std::tuple<int, int, int>>);
    static_assert(std::same_as<J::iterator_concept, std::bidirectional_iterator_tag>);
    ++j; --j; j++; j--; // some of available operators
    // j += 2; j -= 2;       // error: these operator are not available
    // std::ignore() = j[1]; //        for bidirectional iterator
}

References

• C++23 standard (ISO/IEC 14882:2024):

• 26.7.25.3 Class template adjacent_view::iterator [range.adjacent.iterator]