std::ranges::begin

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

范围库 (Ranges library)

范围访问 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

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

悬空迭代器处理 (Dangling iterator handling) dangling borrowed_iterator_t borrowed_subrange_t

范围原语 (Range primitives)
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 concepts)
range borrowed_range    common_range	sized_range viewable_range    view	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	approximately_sized_range (C++26) constant_range (C++23)

视图
view_interface	subrange

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

范围适配器 (Range adaptors)
views::all_tviews::all as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while common_viewviews::common views::counted to_input_viewviews::to_input (C++26)(C++26)	ref_view drop_viewviews::drop drop_while_viewviews::drop_while lazy_split_viewviews::lazy_split split_viewviews::split join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   concat_viewviews::concat (C++26)(C++26) cache_latest_viewviews::cache_latest (C++26)(C++26)	owning_view 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)

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

范围适配器闭包对象 (Range adaptor closure objects) range_adaptor_closure (C++23)

范围适配器对象 (Range adaptor objects)

辅助项 (Helper items)
copyable-box movable-box (直到 C++23)  (C++23)	simple-view non-propagating-cache

 

定义于头文件 <ranges>
定义于头文件 <iterator>
inline namespace /* 未指定 */ {     inline constexpr /* 未指定 */ begin = /* 未指定 */; }		(C++20 起) (定制点对象)
调用签名 (Call signature)
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 具有数组类型，则为 t + 0。
   • 如果 std::remove_all_extents_t<std::remove_reference_t<T>> 不完整，则对 ranges::begin 的调用是 ill-formed，无需诊断。
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 的调用是 ill-formed，当调用出现在模板实例化的直接上下文中时，可能导致替换失败。

自定义点对象

名称 ranges::begin 表示一个*自定义点对象*，它是一个常量函数对象，其类型为字面量semiregular类类型。为了便于说明，其 cv-unqualified 版本的类型表示为 __begin_fn。

__begin_fn 的所有实例均相等。在相同参数上调用不同类型的 __begin_fn 实例的效果是等效的，无论表示实例的表达式是左值还是右值，以及是否为 const-qualified（但是，volatile-qualified 实例不要求是可调用的）。因此，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 的调用是 ill-formed，这也会导致替换失败。

返回类型在所有情况下都建模 std::input_or_output_iterator。

C++20 标准要求如果底层 begin 函数调用返回一个 prvalue，则返回值是从具体化的临时对象移动构造的。所有实现都直接返回 prvalue。该要求已通过 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++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
P2602R2	C++20	存在机制来禁止某些通过ADL找到的非成员 begin	删除了此类机制

参阅

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