std::ranges::begin

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

范围库

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata empty

范围转换 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

悬垂迭代器处理 dangling borrowed_iterator_t borrowed_subrange_t

范围原语
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

范围概念
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	constant_range (C++23)

视图
view_interface	subrange

范围工厂
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

范围适配器
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 concat_viewviews::concat (C++26)(C++26)	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)

范围生成器 std::generator (C++23)

范围适配器闭包对象 range_adaptor_closure (C++23)

范围适配器对象

辅助项
copyable-box movable-box (C++23 前)  (C++23)	simple-view non-propagating-cache

 

在标头 <ranges> 定义
在标头 <iterator> 定义
inline namespace /* 未指定 */ {     inline constexpr /* 未指定 */ begin = /* 未指定 */; }		(C++20 起) (定制点对象)
调用签名
template< class T >     requires /* 见下文 */ constexpr std::input_or_output_iterator auto begin( T&& t );		(C++20 起)

返回指向实参首元素的迭代器。

如果实参是左值，或者 ranges::enable_borrowed_range<std::remove_cv_t<T>> 是 true，那么调用 ranges::begin 表达式等价于：

1. t + 0，如果 t 具有数组类型。
   • 如果 std::remove_all_extents_t<std::remove_reference_t<T>> 不完整，那么调用 ranges::begin 非良构，不要求诊断。
2. 否则是 decay-copy(t.begin()) (C++23 前)auto(t.begin()) (C++23 起)，如果该表达式合法且它的类型实现 std::input_or_output_iterator。
3. 否则是 decay-copy(begin(t)) (C++23 前)auto(begin(t)) (C++23 起)，如果 T 是类或枚举类型，而该表达式合法且它的类型实现 std::input_or_output_iterator，其中如同只进行实参依赖查找来确立 begin 的含义。

所有其他情况下，对 ranges::begin 的调用都非良构，这在此调用于模板实例化的立即语境中出现时会导致代换失败。

定制点对象

名字 ranges::begin 代表一个定制点对象，它是某个字面 semiregular 类类型的 const 函数对象。为阐述目的，以 __begin_fn 表示它的类型的 cv 无限定版本。

__begin_fn 的所有实例均相等。在相同实参上调用 __begin_fn 类型的不同实例的效果是等价的，这与指代该实例的表达式是左值还是右值，以及是否为 const 限定无关（然而不要求 volatile 限定的实例是可调用的）。由此，可以自由地复制 ranges::begin 并且能彼此替代地使用它的副本。

给定类型集合 Args...，如果 std::declval<Args>()... 满足上面对于 ranges::begin 的实参的要求，那么 __begin_fn 就实现

• std::invocable<__begin_fn, Args...>、
• std::invocable<const __begin_fn, Args...>、
• std::invocable<__begin_fn&, Args...> 和
• std::invocable<const __begin_fn&, Args...>。

否则，__begin_fn 的函数调用运算符不会参与重载决议。

注解

如果实参是右值（即 T 是对象类型）且 ranges::enable_borrowed_range<std::remove_cv_t<T>> 是 false，那么对 ranges::begin 的调用非良构，这也会导致代换失败。

所有情况下，返回类型都实现 std::input_or_output_iterator。

C++20 标准要求在底层 begin 函数调用返回纯右值时，从实质化的临时对象移动构造其返回值。但所有实现均直接返回纯右值。C++20 后的提案 P0849R8 更正了该要求以匹配实现。

示例

运行此代码

#include <cassert>
#include <ranges>
#include <vector>
 
int main() 
{
    std::vector v{3, 1, 4};
    auto vi = std::ranges::begin(v);
    auto vci = std::ranges::cbegin(v);
    assert(*vi == 3 and *vi == *vci);
    ++vi;
    ++vci; // OK: vci 是可改动对象
    *vi = 42; // OK: vi 指向可改动元素
    // *vci = 13; // 错误: vci 指向不可改动元素
 
    int a[]{-5, 10, 15};
    auto ai = std::ranges::begin(a); // 也可以用于 C 数组
    assert(*ai == -5);
    *ai = 42; // OK
}

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
P2602R2	C++20	存在妨碍 ADL 找到的特定非成员 begin 的机制	移除这种机制

参阅

ranges::cbegin (C++20)	返回指向只读范围起始的迭代器 (定制点对象)
begincbegin (C++11)(C++14)	返回指向容器或数组起始的迭代器 (函数模板)