std::ranges::views::enumerate, std::ranges::enumerate_view

来自cppreference.com
< cpp‎ | ranges
 
 
范围库
范围适配器
 
 
在标头 <ranges> 定义
template< ranges::view V >

    requires /*range-with-movable-references*/<V>
class enumerate_view :

    public ranges::view_interface<enumerate_view<V>>
(1) (C++23 起)
namespace views {

    inline constexpr /* 未指定 */ enumerate = /* 未指定 */;

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

    requires /* 见下文 */

constexpr /* 见下文 */ enumerate( R&& r );
(C++23 起)
辅助概念
template< class R >

    concept /*range-with-movable-references*/ =
        ranges::input_range<R> &&
        std::move_constructible<ranges::range_reference_t<R>> &&

        std::move_constructible<ranges::range_rvalue_reference_t<R>>;
(3) (仅用于阐述*)
1) enumerate_view 是一个范围适配器,其接受 view 并产生 tuple 的视图。结果序列中第 i 个元素 (元组) 持有:
  • 等于 i 的值,其为底层序列从零开始的索引,及
  • 到底层元素的引用。
2) 名字 views::enumerate 代表一个范围适配器对象 (RangeAdaptorObject) 。给定子表达式 e,表达式 views::enumerate(e) 对于任意合适的子表达式 e表达式等价enumerate_view<views::all_t<decltype((e))>>(e)
3) 保证底层类型的引用可以被移动。

当底层视图 V 实现概念 random_access_rangebidirectional_rangeforward_rangeinput_rangecommon_rangesized_range 时,enumerate_view 也实现相应的概念。

数据成员

成员名 定义
base_ (私有) 指向 V 类型的底层序列的迭代器。
(仅用于阐述的成员对象*)

成员函数

构造 enumerate_view
(公开成员函数)
返回底层(适配的)视图的副本
(公开成员函数)
返回指向起始的迭代器
(公开成员函数)
返回 指向末尾的迭代器或哨位
(公开成员函数)
返回元素数。仅当底层(适配的)范围满足 sized_range 时才提供。
(公开成员函数)
继承自 std::ranges::view_interface
返回视图是否为空。仅当视图满足 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_rangecommon_range 时提供。
(std::ranges::view_interface<D> 的公开成员函数)
返回派生视图中的第 n 个元素。仅当视图满足 random_access_range 时提供。
(std::ranges::view_interface<D> 的公开成员函数)

推导指引

嵌套类

(C++23)
迭代器类型
(仅用于阐述的成员类模板*)
(C++23)
哨位类型
(仅用于阐述的成员类模板*)

辅助模板

template< class View >

constexpr bool enable_borrowed_range<ranges::enumerate_view<View>> =

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

ranges::enable_borrowed_range 的特化使得当底层视图满足 borrowed_range 时,enumerate_view 也满足它。

注解

功能特性测试 标准 功能特性
__cpp_lib_ranges_enumerate 202302L (C++23) std::ranges::enumerate_view

示例

#include <iostream>
#include <map>
#include <ranges>
#include <vector>
 
int main()
{
    constexpr static auto v = {'A', 'B', 'C', 'D'};
 
    for (auto const [index, letter] : std::views::enumerate(v))
        std::cout << '(' << index << ':' << letter << ") ";
    std::cout << '\n';
 
#if __cpp_lib_ranges_to_container
    // 使用每个元素的位置作为键值创建的 map
    auto m = v | std::views::enumerate | std::ranges::to<std::map>();
 
    for (auto const [key, value] : m)
        std::cout << '[' << key << "]:" << value << ' ';
    std::cout << '\n';
#endif
 
    std::vector<int> numbers{1, 3, 5, 7};
 
    // num 即便有 const 也是可改动的,它并不会传播给引用
    // 为使其为 const,应使用 `std::views::enumerate(numbers) | std::views::as_const`
    // 或者 `std::views::enumerate(std::as_const(numbers))`
    for (auto const [index, num] : std::views::enumerate(numbers))
    {
        ++num; // 类型为 int&
        std::cout << numbers[index] << ' ';
    }
    std::cout << '\n';
}

可能的输出:

(0:A) (1:B) (2:C) (3:D)
[0]:A [1]:B [2]:C [3]:D
2 4 6 8

引用

  • C++23 标准(ISO/IEC 14882:2024):
  • 26.7.23 Enumerate view [range.enumerate]

参阅

由通过重复对某个初值自增所生成的序列组成的 view
(类模板) (定制点对象)
到被适配视图的对应元素的引用元组组成的 view
(类模板) (定制点对象)
选取 tuple-like 值组成的 view 和数值 N,产生每个元组的第 N 个元素组成的 view
(类模板) (范围适配器对象)