Namespaces
Variants

std::ranges:: begin

From cppreference.net
Ranges library
Range adaptors
定义于头文件 <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 起)

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

range-begin-end.svg

如果实参是左值或 ranges:: enable_borrowed_range < std:: remove_cv_t < T >> true ,则对 ranges::begin 的调用 表达式等价 于:

  1. t + 0 t 具有数组类型。
  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 类类型的常量 函数对象 。有关详细信息,请参阅 定制点对象

注释

若实参为右值(即 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; // 正常:vci 是可修改对象
    *vi = 42; // 正常:vi 指向可变元素
    // *vci = 13; // 错误:vci 指向不可变元素
    int a[]{-5, 10, 15};
    auto ai = std::ranges::begin(a); // 同样适用于 C 风格数组
    assert(*ai == -5);
    *ai = 42; // 正常
}

缺陷报告

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

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

参见

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