命名空间
变体
操作

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

来自 cppreference.com
< cpp‎ | ranges
 
 
范围库
范围适配器
adjacent_viewviews::adjacent
(C++23)(C++23)
views::pairwise
(C++23)
 
 
在头文件 <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) (自 C++23 起)
namespace views {

    template< std::size_t N >
    constexpr /* unspecified */ adjacent = /* unspecified */ ;

}
(2) (自 C++23 起)
namespace views {

    inline constexpr auto pairwise = adjacent<2>;

}
(3) (自 C++23 起)
调用签名
template< ranges::viewable_range R >

    requires /* see below */

constexpr ranges::view auto adjacent<N>( R&& r );
(自 C++23 起)
1) adjacent_view 是一个范围适配器,它接受一个 view,并生成一个 view,其 ith 个元素(一个“窗口”)是一个 std::tuple,它包含对原始视图中元素的 N 个引用,从 ithi + N - 1th(包括)。
S 为原始视图的大小。那么生成的视图的大小为
  • S - N + 1,如果 S >= N
  • 0 否则,生成的视图为空。
2) 名称 views::adjacent<N> 表示一个 RangeAdaptorObject。给定一个子表达式 e 和一个常量表达式 N,表达式 views::adjacent<N>(e)
3) 名称 views::pairwise 表示一个 RangeAdaptorObject,其行为与 views::adjacent<2> 完全相同。

adjacent_view 始终模拟 forward_range,并且如果适配的 view 类型模拟了相应的概念,则模拟 bidirectional_rangerandom_access_rangesized_range

内容

[edit] 数据成员

成员名称 定义
base_ (private) 底层 view,类型为 V
(仅供说明的成员对象*)

[edit] 成员函数

构造一个 adjacent_view
(public member function) [edit]
返回指向开头的迭代器
(public member function) [edit]
返回指向末尾的迭代器或哨兵
(public member function) [edit]
返回元素的数量。仅当底层(适配的)范围满足 sized_range 时才提供。
(public member function) [edit]
std::ranges::view_interface 继承
返回派生视图是否为空。如果它满足 sized_rangeforward_range,则提供。
(public member function of std::ranges::view_interface<D>) [edit]
(C++23)
返回指向范围开头的常量迭代器。
(public member function of std::ranges::view_interface<D>) [edit]
(C++23)
返回范围常量迭代器的哨兵。
(public member function of std::ranges::view_interface<D>) [edit]
返回派生视图是否不为空。如果 ranges::empty 对其适用,则提供。
(public member function of std::ranges::view_interface<D>) [edit]
返回派生视图中的第一个元素。如果它满足 forward_range,则提供。
(public member function of std::ranges::view_interface<D>) [edit]
返回派生视图中的最后一个元素。如果它满足 bidirectional_rangecommon_range,则提供。
(public member function of std::ranges::view_interface<D>) [edit]
返回派生视图中的第 n 个元素。如果它满足 random_access_range,则提供。
(public member function of std::ranges::view_interface<D>) [edit]

[edit] 推导指南

(无)

[edit] 嵌套类

迭代器类型
(仅供说明的成员类模板*)
adjacent_view 不是 common_range 时使用的哨兵类型
(仅供说明的成员类模板*)

[edit] 辅助模板

template< class V, size_t N >

constexpr bool ranges::enable_borrowed_range<adjacent_view<V, N>> =

    ranges::enable_borrowed_range<V>;
(自 C++23 起)

这个 ranges::enable_borrowed_range 的特化使 adjacent_view 满足 borrowed_range,前提是底层视图满足它。

[edit] 备注

views::adjacent 即使在 N0 时也只接受正向范围。

ranges::adjacent_viewranges::slide_view 之间存在相似之处。

  • 两者都创建了一个大小为 N 的“滑动窗口”。
  • 两者的大小相同 S - N + 1,其中 S 是一个适配的 view 的大小,使得 S >= N > 0

下表显示了这些适配器之间的差异

视图适配器 value_type 窗口大小 N
ranges::adjacent_view std::tuple 模板参数
ranges::slide_view ranges::range 运行时参数
功能测试 Std 功能
__cpp_lib_ranges_zip 202110L (C++23) ranges::zip_view,
ranges::zip_transform_view,
ranges::adjacent_view,
ranges::adjacent_transform_view

[edit] 示例

#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);
    }
}

输出

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

[edit] 缺陷报告

以下行为更改缺陷报告被追溯应用于先前发布的 C++ 标准。

DR 应用于 已发布的行为 正确行为
LWG 4098 C++23 views::adjacent<0> 以前接受输入范围 被拒绝

[edit] 参考资料

  • C++23 标准 (ISO/IEC 14882:2024)
  • 26.7.25 相邻视图 [range.adjacent]

[edit] 另请参阅

一个 view,它由对适配视图中相邻元素应用转换函数的结果组成
(class template) (range adaptor object)[edit]
一个 view,其第 M 个元素是另一个 view 上的 view,覆盖第 M 个到 (M + N - 1) 个元素
(class template) (range adaptor object)[edit]
一个 view 的范围,这些 view 是另一个 view 的元素的 N 大小非重叠连续块
(class template) (range adaptor object)[edit]
一个 view,它由另一个 view 的元素组成,每次前进 N 个元素
(类模板) (范围适配器对象)[编辑]