std::ranges::begin

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

范围库

范围访问
begin cbegin end cend	rbegin crbegin rend crend	size ssize data cdata	empty
范围原语
iterator_tsentinel_t	range_size_trange_difference_t	range_reference_trange_rvalue_reference_t	range_value_t
悬垂迭代器处理
dangling	borrowed_iterator_t	borrowed_subrange_t
范围概念
range borrowed_range    sized_range	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
视图
view_interface	subrange
范围工厂
empty_viewviews::empty	single_viewviews::single	iota_viewviews::iota	basic_istream_viewviews::istream
适配器
views::all_tviews::all ref_view owning_view common_viewviews::common reverse_viewviews::reverse views::counted zip_viewviews::zip (C++23)(C++23)	take_viewviews::take take_while_viewviews::take_while drop_viewviews::drop drop_while_viewviews::drop_while zip_transform_viewviews::zip_transform (C++23)(C++23)	elements_viewviews::elements keys_viewviews::keys values_viewviews::values transform_viewviews::transform adjacent_viewviews::adjacent (C++23)(C++23)	filter_viewviews::filter join_viewviews::join split_viewviews::split lazy_split_viewviews::lazy_split adjacent_transform_viewviews::adjacent_transform (C++23)(C++23)
范围适配器对象
范围适配器闭包对象
辅助项
copyable-box	simple-view

 

定义于头文件 <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);

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

令 t 为 T 类型对象。若实参为左值或 ranges::enable_borrowed_range<std::remove_cv_t<T>> 为 true ，则调用 ranges::begin 表达式等价于：

1. t + 0 ，若 T 为数组类型。

   若 std::remove_all_extents_t<T> 不完整，则调用 ranges::begin(std::forward<T>(t)) 非良构，不要求诊断。

2. 否则为 std::forward<T>(t).begin() 转换到其衰变类型，若该带转换的表达式合法且其转换后的类型实现 std::input_or_output_iterator 。
3. 否则为 begin(std::forward<T>(t)) 转换到其衰变类型，若 T 为类或枚举类型，而带转换的前述无限定调用合法，且其转换后的类型实现 std::input_or_output_iterator ，其中以下列候选进行重载决议：
   • void begin(auto&) = delete;
   • void begin(const auto&) = delete;
   • 实参依赖查找所找到的任何 begin 的声明。

所有其他情况下，调用 ranges::begin 非良构，这能在 ranges::begin(t) 出现于模板实例化的立即语境中时导致替换失败。

表达式等价

表达式 e 表达式等价于表达式 f ，若 e 与 f 拥有相同效果，均为潜在抛出或均非潜在抛出（即 noexcept(e) == noexcept(f) ），且均为常量子表达式或均非常量子表达式。

定制点对象

名字 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 <iostream>
#include <vector>
#include <ranges>
 
int main() 
{
    std::vector<int> v = { 3, 1, 4 };
    auto vi = std::ranges::begin(v);
    std::cout << *vi << '\n';
    *vi = 42; // OK
 
    int a[] = { -5, 10, 15 };
    auto ai = std::ranges::begin(a);
    std::cout << *ai << '\n';
    *ai = 42; // OK
}

输出：

3
-5

参阅

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