std::ranges::begin

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

范围库

范围访问 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)

悬垂迭代器处理 悬垂 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 /* unspecified */ {     inline constexpr /* unspecified */ begin = /* unspecified */; }		(自 C++20 起) (定制点对象)
调用签名
template< class T >     requires /* see below */ 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 表示一个 定制点对象，它是一个 const 函数对象，属于一个 字面量 semiregular 类类型。为了说明的目的，其类型的 cv 无限定版本表示为 __begin_fn。

__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 is modifiable object
    *vi = 42; // OK: vi points to mutable element
    // *vci = 13; // Error: vci points to immutable element
 
    int a[]{-5, 10, 15};
    auto ai = std::ranges::begin(a); // works with C-arrays as well
    assert(*ai == -5);
    *ai = 42; // OK
}

缺陷报告

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

DR	应用于	已发布的行为	正确行为
P2602R2	C++20	存在机制来禁止通过 ADL 找到的某些非成员 begin	删除了这种机制

另请参阅

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