std::ranges::views::adjacent, std::ranges::adjacent_view, std::ranges::views::pairwise

 

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)

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
to (C++23)
Range primitives
range_size_trange_difference_trange_value_trange_reference_t	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)	elements_of (C++23)
Dangling iterator handling
dangling	borrowed_iterator_t	borrowed_subrange_t
Range concepts
range borrowed_range sized_range constant_range (C++23)	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
Views
view_interface	subrange
Range factories
empty_viewviews::empty single_viewviews::single	iota_viewviews::iota repeat_viewviews::repeat (C++23)(C++23)	basic_istream_viewviews::istream
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	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 objects
Range adaptor closure objects
range_adaptor_closure (C++23)
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 (C++23)

adjacent_view::begin (C++23)

adjacent_view::end (C++23)

adjacent_view::size (C++23)

Iterator

Member functions

adjacent_view::iterator::iterator (C++23)

adjacent_view::iterator::operator* (C++23)

adjacent_view::iterator::operator[] (C++23)

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-= (C++23)(C++23)(C++23)(C++23)(C++23)(C++23)

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) (C++23)(C++23)(C++23)(C++23)(C++23)(C++23)

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

iter_move(adjacent_view::iterator) (C++23)

iter_swap(adjacent_view::iterator) (C++23)

Sentinel

Member functions

adjacent_view::sentinel::sentinel (C++23)

Non-member functions

operator==(adjacent_view::iterator,adjacent_view::sentinel) (C++23)

operator-(adjacent_view::iterator,adjacent_view::sentinel) (C++23)

 

Defined in header <ranges>
template< ranges::forward_range V, std::size_t N >     requires ranges::view<V> && (N > 0) class adjacent_view : public ranges::view_interface<adjacent_view<V, N>>	(1)	(since C++23)
namespace views { template< std::size_t N >     inline constexpr /* unspecified */ adjacent = /* unspecified */ ; }	(2)	(since C++23)
namespace views {     inline constexpr auto pairwise = adjacent<2>; }	(3)	(since C++23)
Call signature
template< ranges::viewable_range R >     requires /* see below */ constexpr ranges::view auto adjacent<N>( R&& r );		(since C++23)

1) adjacent_view is a range adaptor that takes a view, and produces a view whose i^th element (a "window") is a std::tuple that holds N references to the elements of the original view, from i^th up to i + N - 1^th inclusively.

Let S be the size of the original view. Then the size of produced view is:

• S - N + 1, if S >= N,
• ​0​ otherwise, and the resulting view is empty.

2) The name views::adjacent<N> denotes a RangeAdaptorObject. Given a subexpression e and a constant expression N, the expression views::adjacent<N>(e) is expression-equivalent to

• ((void)e, auto(views::empty<tuple<>>)) if N is equal to ​0​,
• adjacent_view<views::all_t<decltype((e))>, N>(e) otherwise.

adjacent_view always models forward_range, and models bidirectional_range, random_access_range, or sized_range if adapted view type models the corresponding concept.

Data members

Typical implementations of adjacent_view hold only one non-static data member base_ of type V. The name is for exposition only.

Member functions

(constructor) (C++23)	constructs a adjacent_view (public member function)
begin (C++23)	returns an iterator to the beginning (public member function)
end (C++23)	returns an iterator or a sentinel to the end (public member function)
size (C++23)	returns the number of elements. Provided only if the underlying (adapted) range satisfies sized_range. (public member function)
Inherited from std::ranges::view_interface
empty (C++20)	returns whether the derived view is empty. Provided if it satisfies sized_range or forward_range. (public member function of std::ranges::view_interface<D>)
cbegin (C++23)	returns a constant iterator to the beginning of the range. (public member function of std::ranges::view_interface<D>)
cend (C++23)	returns a sentinel for the constant iterator of the range. (public member function of std::ranges::view_interface<D>)
operator bool (C++20)	returns whether the derived view is not empty. Provided if ranges::empty is applicable to it. (public member function of std::ranges::view_interface<D>)
front (C++20)	returns the first element in the derived view. Provided if it satisfies forward_range. (public member function of std::ranges::view_interface<D>)
back (C++20)	returns the last element in the derived view. Provided if it satisfies bidirectional_range and common_range. (public member function of std::ranges::view_interface<D>)
operator[] (C++20)	returns the nth element in the derived view. Provided if it satisfies random_access_range. (public member function of std::ranges::view_interface<D>)

Deduction guides

(none)

Nested classes

iterator (C++23)	the iterator type (exposition-only member class template*)
sentinel (C++23)	the sentinel type used when adjacent_view is not a common_range (exposition-only member class template*)

Helper templates

template< class V, size_t N > inline constexpr bool ranges::enable_borrowed_range<adjacent_view<V, N>> =     ranges::enable_borrowed_range<V>;		(since C++23)

This specialization of ranges::enable_borrowed_range makes adjacent_view satisfy borrowed_range when the underlying view satisfies it.

Notes

There is a similarity between ranges::adjacent_view and ranges::slide_view — they both produce a "sliding window" of the size N, and, given a view of the size S, where S >= N > 0, they both will have the same size: S - N + 1. The difference between these view adaptors are:

View adaptor	value_type	The window size N
ranges::adjacent_view	a tuple-like object	a template parameter
ranges::slide_view	a range	a runtime parameter

Feature-test macro	Value	Std	Comment
__cpp_lib_ranges_zip	202110L	(C++23)	std::ranges::zip_view, std::ranges::zip_transform_view, std::ranges::adjacent_view, std::ranges::adjacent_transform_view

Example

Run this code

#include <array>
#include <cstddef>
#include <iostream>
#include <ranges>
#include <string>
#include <tuple>
 
int main()
{
    constexpr std::size_t window{3};
 
    constexpr std::array v {1, 2, 3, 4, 5, 6};
    std::cout << "v = [1 2 3 4 5 6]\n";
 
    for (int i{}; auto const e: v | std::views::adjacent<window>)
    {
        std::cout << "e = " << std::string(2 * i++, ' ') << '['
                  << std::get<0>(e) << ' '
                  << std::get<1>(e) << ' '
                  << std::get<2>(e) << "]\n";
    }
}

Output:

v = [1 2 3 4 5 6]
e = [1 2 3]
e =   [2 3 4]
e =     [3 4 5]
e =       [4 5 6]

References

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

• 26.7.25 Adjacent view [range.adjacent]

See also

ranges::adjacent_transform_viewviews::adjacent_transform (C++23)	a view consisting of tuples of results of application of a transformation function to adjacent elements of the adapted view (class template) (range adaptor object)
ranges::slide_viewviews::slide (C++23)	a view whose Mth element is a view over the Mth through (M + N - 1)th elements of another view (class template) (range adaptor object)
ranges::chunk_viewviews::chunk (C++23)	a range of views that are N-sized non-overlapping successive chunks of the elements of another view (class template) (range adaptor object)
ranges::stride_viewviews::stride (C++23)	a view consisting of elements of another view, advancing over N elements at a time (class template) (range adaptor object)