std::ranges::begin

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

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

range-begin-end.svg

tT 类型对象。若实参为左值或 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 ,若 ef 拥有相同效果,均为潜在抛出或均非潜在抛出(即 noexcept(e) == noexcept(f) ),且均为常量子表达式或均非常量子表达式。

定制点对象

名字 ranges::begin 代表一个定制点对象,它是字面 semiregular 类类型(为说明目的以 begin_ftor 表示)的 const 函数对象begin_ftor 的所有实例均相等。从而能自由地复制 ranges::begin ,且能交替使用其副本。

给定类型集合 Args... ,若 std::declval<Args>()... 满足上面对于 ranges::begin 的参数要求,则 begin_ftor 将满足 std::invocable<const begin_ftor&, Args...> 。否则, begin_ftor 的函数调用运算符不参与重载决议。

注解

若实参为右值(即 T 为对象类型)且 ranges::enable_borrowed_range<std::remove_cv_t<T>>false ,则调用 ranges::begin 为谬构,这亦能导致替换失败。

所有情况下,返回类型实现 std::input_or_output_iterator

示例

#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

参阅

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