Namespaces
Variants

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

From cppreference.net
Ranges library
Range adaptors
adjacent_view views::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 /* 未指定 */ adjacent = /* 未指定 */ ;

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

inline constexpr auto pairwise = adjacent < 2 > ;

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

requires /* 见下文 */

constexpr ranges:: view auto adjacent < N > ( R && r ) ;
(C++23 起)
1) adjacent_view 是一个范围适配器,它接受一个 view ,并生成一个 view ,其第 i 个元素(一个“窗口”)是一个 std::tuple ,其中包含对原始视图元素 [ i , i + N - 1 ] N 个引用。
S 为原始视图的尺寸。则生成视图的尺寸为:
  • S - N + 1 ,若 S >= N
  • 0 否则,此时生成的视图为空。
2) 名称 views :: adjacent < N > 表示一个 范围适配器对象 。给定子表达式 e 和常量表达式 N ,表达式 views :: adjacent < N > ( e ) 表达式等价 于:
3) 名称 views :: pairwise 表示一个 RangeAdaptorObject ,其行为与 views :: adjacent < 2 > 完全一致。

adjacent_view 始终满足 forward_range 概念要求,并且当被适配的 view 类型满足相应概念时,它也会满足 bidirectional_range random_access_range sized_range 概念要求。

目录

数据成员

成员 描述
V base_ 底层 view
( 仅用于说明的成员对象* )

成员函数

构造一个 adjacent_view
(公开成员函数)
返回指向起始位置的迭代器
(公开成员函数)
返回指向末尾位置的迭代器或哨兵
(公开成员函数)
返回元素数量,仅当底层(适配的)范围满足 sized_range 时提供
(公开成员函数)
返回结果 approximately_sized_range 的近似大小
(公开成员函数)
继承自 std::ranges::view_interface
返回派生视图是否为空,仅当它满足 sized_range forward_range 时提供
( std::ranges::view_interface<D> 的公开成员函数)
(C++23)
返回指向范围起始位置的常量迭代器
( std::ranges::view_interface<D> 的公开成员函数)
(C++23)
返回范围常量迭代器的哨兵
( std::ranges::view_interface<D> 的公开成员函数)
返回派生视图是否非空,仅当 ranges::empty 适用于它时提供
( std::ranges::view_interface<D> 的公开成员函数)
返回派生视图中的首个元素,仅当它满足 forward_range 时提供
( std::ranges::view_interface<D> 的公开成员函数)
返回派生视图中的最后一个元素,仅当它满足 bidirectional_range common_range 时提供
( std::ranges::view_interface<D> 的公开成员函数)
返回派生视图中的第 n 个元素,仅当它满足 random_access_range 时提供
( std::ranges::view_interface<D> 的公开成员函数)

推导指引

(无)

嵌套类

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

辅助模板

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 的特化使得当底层视图满足 borrowed_range 时, adjacent_view 也满足该概念。

注释

views :: adjacent 仅接受前向范围,即使当 N 0 时也是如此。

ranges::adjacent_view ranges::slide_view 之间存在相似之处:

  • 两者都创建大小为 N 的“滑动窗口”。
  • 两者具有相同的尺寸 S - N + 1 ,其中 S 是适配的 view 的尺寸,且满足 S >= N > 0

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

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

示例

#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]

缺陷报告

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

缺陷报告 应用于 发布时的行为 正确行为
LWG 4098 C++23 views :: adjacent < 0 > 过去接受仅输入范围 改为拒绝

参考文献

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

参见

由对适配视图的相邻元素应用转换函数的结果组成的 view
(类模板) (范围适配器对象)
其第M个元素是另一个 view 的第M至(M + N - 1)个元素的 view
(类模板) (范围适配器对象)
由另一个 view 元素组成的、大小为N的非重叠连续块构成的 view s 范围
(类模板) (范围适配器对象)
由另一个 view 的元素组成、每次跨越N个元素的 view
(类模板) (范围适配器对象)