Namespaces
Variants

std::begin, std::cbegin

来自 zh.cppreference.net
 
 
迭代器库
迭代器概念
迭代器原语
算法概念和工具
间接可调用概念
常见算法要求
(C++20)
(C++20)
(C++20)
工具
(C++20)
迭代器适配器
范围访问
(C++11)(C++14)
(C++14)(C++14)  
(C++11)(C++14)
(C++14)(C++14)  
(C++17)(C++20)
(C++17)
(C++17)
 
定义于头文件 <array>
定义于头文件 <deque>
定义于头文件 <flat_map>
 (C++23 起)
定义于头文件 <flat_set>
 (C++23 起)
定义于头文件 <forward_list>
定义于头文件 <inplace_vector>
 (C++26 起)
定义于头文件 <iterator>
定义于头文件 <list>
定义于头文件 <map>
定义于头文件 <optional>
 (C++26 起)
定义于头文件 <regex>
定义于头文件 <set>
定义于头文件 <span>
 (C++20 起)
定义于头文件 <stacktrace>
 (C++23 起)
定义于头文件 <string>
定义于头文件 <string_view>
 (C++17 起)
定义于头文件 <unordered_map>
定义于头文件 <unordered_set>
定义于头文件 <valarray>
定义于头文件 <vector>
template< class C > 
auto begin( C& c ) -> decltype(c.begin());
(1) (C++11 起)
(C++17 起 constexpr)
template< class C > 
auto begin( const C& c ) -> decltype(c.begin());
(2) (C++11 起)
(C++17 起 constexpr)
template< class T, std::size_t N > 
T* begin( T (&array)[N] );
(3) (C++11 起)
(C++14 起 noexcept)
(C++14 起 constexpr)
template< class C > 
constexpr auto cbegin( const C& c ) noexcept(/* see below */)
    -> decltype(std::begin(c));
(4) (C++14 起)

返回指向给定范围起始的迭代器。

1,2) 返回 c.begin(),通常是指向 c 所表示序列起始的迭代器。
1) 如果 C 是标准 容器,则返回一个 C::iterator 对象。
2) 如果 C 是标准 容器,则返回一个 C::const_iterator 对象。
3) 返回指向 array 起始的指针。
4) 返回 std::begin(c),其中 c 始终被视为 const 限定。
如果 C 是标准 容器,则返回一个 C::const_iterator 对象。

参数

c - 具有 begin 成员函数的容器或视图
array - 任意类型的数组

返回值

1,2) c. begin ( )
3) array
4) c. begin ( )

异常

4)
noexcept 规范:
noexcept ( noexcept ( std :: begin ( c ) ) )

重载

对于未提供合适的 begin() 成员函数但仍可迭代的类和枚举,可提供自定义的 begin 重载。标准库已提供以下重载:

重载 std::begin
(函数模板)
重载 std::begin
(函数模板)
基于范围的 for 循环支持
(函数)
基于范围的 for 循环支持
(函数)

类似于 swap 的使用方式(详见 可交换类型 ),在泛型上下文中使用 begin 函数的典型做法等价于 using std :: begin ; begin ( arg ) ; ,这样既允许通过 ADL 为用户定义类型选择重载版本,也允许标准库函数模板出现在同一个重载集中。

template<typename Container, typename Function>
void for_each(Container&& cont, Function f)
{
    using std::begin;
    auto it = begin(cont);
    using std::end;
    auto end_it = end(cont);
    while (it != end_it)
    {
        f(*it);
        ++it;
    }
}

通过 实参依赖查找 找到的 begin 重载可用于自定义 std::ranges::begin 、 std::ranges::cbegin 及其他依赖于 std::ranges::begin 的自定义指针对象的行为。

(C++20 起)

注释

非数组重载完全反映了 C::begin 的行为。若成员函数未实现合理功能,其效果可能会出人意料。

std::cbegin 的引入旨在统一成员与非成员的范围访问方式。另请参阅 LWG issue 2128 。

如果 C 是一个浅常量视图, std::cbegin 可能返回可变迭代器。这种行为对某些用户而言是意料之外的。另请参阅 P2276 和 P2278 。

示例

#include <iostream>
#include <iterator>
#include <vector>
int main() 
{
    std::vector<int> v = {3, 1, 4};
    auto vi = std::begin(v);
    std::cout << std::showpos << *vi << '\n'; 
    int a[] = {-5, 10, 15};
    auto ai = std::begin(a);
    std::cout << *ai << '\n';
}

输出:

+3
-5

参见

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