std::ranges::views::adjacent, std::ranges::adjacent_view, std::ranges::views::pairwise
<ranges>
requires ranges::view <V> && (N > 0)
class adjacent_view
template< std::size_t N >
constexpr /* unspecified */ adjacent = /* unspecified */ ;
inline constexpr auto pairwise = adjacent<2>;
requires /* see below */
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 [
i
,
i + N - 1
]
of the original view.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.
- ((void)e, auto(views::empty <tuple<>>)) if N is equal to 0 and decltype((e)) models
forward_range
, - 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.
Contents
[edit] Data members
[edit] Member functions
sized_range
(public member function) [edit]
approximately_sized_range
(public member function) [edit]
Inherited from std::ranges::view_interface
sized_range
or forward_range
(public member function of
std::ranges::view_interface<D>
) [edit]
(public member function of
std::ranges::view_interface<D>
) [edit]
(public member function of
std::ranges::view_interface<D>
) [edit]
(public member function of
std::ranges::view_interface<D>
) [edit]
forward_range
(public member function of
std::ranges::view_interface<D>
) [edit]
bidirectional_range
and common_range
(public member function of
std::ranges::view_interface<D>
) [edit]
n
th element in the derived view, provided only if it satisfies random_access_range
(public member function of
std::ranges::view_interface<D>
) [edit]
[edit] Deduction guides
(none)
[edit] Nested classes
adjacent_view
is not a common_range
(exposition-only member class template*)
[edit] Helper templates
constexpr bool ranges::enable_borrowed_range <adjacent_view<V, N>> =
This specialization of ranges::enable_borrowed_range makes adjacent_view
satisfy borrowed_range
when the underlying view satisfies it.
[edit] Notes
views::adjacent only accepts forward ranges even when N
is 0
.
There are similarities between ranges::adjacent_view and ranges::slide_view:
- Both create "sliding window" of size
N
. - Both have the same size
S - N + 1
, whereS
is the size of an adaptedview
such thatS >= N > 0
.
The following table shows the differences between these adaptors:
View adaptor | value_type |
The window size N
|
---|---|---|
ranges::adjacent_view | std::tuple | A template parameter |
ranges::slide_view | ranges::range | A runtime argument |
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_ranges_zip |
202110L |
(C++23) | ranges::zip_view , ranges::zip_transform_view , ranges::adjacent_view ,ranges::adjacent_transform_view |
[edit] Example
#include <array> #include <format> #include <iostream> #include <ranges> #include <tuple> int main() { constexpr std::array v{1, 2, 3, 4, 5, 6}; std::cout << "v = [1 2 3 4 5 6]\n"; for (int i{}; std::tuple t : v | std::views::adjacent<3>) { auto [t0, t1, t2] = t; std::cout << std::format ("e = {:<{}}[{} {} {}]\n", "", 2 * i++, t0, t1, t2); } }
Output:
v = [1 2 3 4 5 6] e = [1 2 3] e = [2 3 4] e = [3 4 5] e = [4 5 6]
[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 4098 | C++23 | views::adjacent<0> used to accept input-only ranges | made rejected |
[edit] References
- C++23 standard (ISO/IEC 14882:2024):
- 26.7.25 Adjacent view [range.adjacent]
[edit] See also
view
consisting of results of application of a transformation function to adjacent elements of the adapted view(class template) (range adaptor object)[edit]
view
whose Mth element is a view
over the Mth through (M + N - 1)th elements of another view
(class template) (range adaptor object)[edit]
view
s that are N
-sized non-overlapping successive chunks of the elements of another view
(class template) (range adaptor object)[edit]