std::begin, std::cbegin

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

迭代器库

迭代器概念
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) is-integer-like is-signed-integer-like (C++20)(C++20)	sentinel_for (C++20) sized_sentinel_for (C++20) input_iterator (C++20) output_iterator (C++20) input_or_output_iterator (C++20)	forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
迭代器原语
input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20)	iter_value_titer_difference_titer_reference_titer_const_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++23)(C++20)(C++20)	iterator (C++17 中已弃用) iterator_traits incrementable_traits (C++20) indirectly_readable_traits (C++20)
算法概念与工具
间接可调用概念
indirectly_unary_invocableindirectly_regular_unary_invocable (C++20)(C++20)	indirect_unary_predicate (C++20) indirect_binary_predicate (C++20)	indirect_equivalence_relation (C++20) indirect_strict_weak_order (C++20)
常用算法要求
indirectly_movable (C++20) indirectly_movable_storable (C++20) indirectly_copyable (C++20)	indirectly_copyable_storable (C++20)   indirectly_swappable (C++20) indirectly_comparable (C++20)	permutable (C++20) mergeable (C++20) sortable (C++20)
工具
indirect_result_t (C++20)	projected (C++20)	projected_value_t (C++26)
迭代器适配器
reverse_iterator make_reverse_iterator (C++14) move_iterator (C++11) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20)	front_insert_iterator back_insert_iterator inserter insert_iterator front_inserter back_inserter move_sentinel (C++20)	common_iterator (C++20) counted_iterator (C++20) basic_const_iterator (C++23) const_iterator (C++23) const_sentinel (C++23) make_const_iterator (C++23) make_const_sentinel (C++23)
流迭代器 istream_iterator    ostream_iterator istreambuf_iterator ostreambuf_iterator	迭代器定制点 ranges::iter_move (C++20) ranges::iter_swap (C++20)
迭代器操作 advance distance prev (C++11)   next (C++11) ranges::advance (C++20) ranges::distance (C++20) ranges::prev (C++20) ranges::next (C++20)	范围访问 begincbegin (C++11)(C++14) rbegincrbegin (C++14)(C++14)   endcend (C++11)(C++14) rendcrend (C++14)(C++14)   sizessize (C++17)(C++20) empty (C++17) data (C++17)

 

定义于头文件 <array>
在头文件 <deque> 中定义
在头文件 <flat_map> 中定义
在头文件 <flat_set> 中定义
在头文件 <forward_list> 中定义
在头文件 <inplace_vector> 中定义
定义于头文件 <iterator>
定义于头文件 <list>
定义于头文件 <map>
在头文件 <regex> 中定义
在头文件 <set> 中定义
在头文件 <span> 中定义
定义于头文件 <string>
定义于头文件 <string_view>
在头文件 <unordered_map> 中定义
定义于头文件 <unordered_set>
在头文件 <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 起无异常) (C++14 起为 constexpr)
template< class C > constexpr auto cbegin( const C& c noexcept(/* 见下文 */)     -> decltype(std::begin(c));	(4)	(C++14 起)

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

1,2) 返回 c.begin()，它通常是表示 c 的序列的起始迭代器。

1) 若 C 为标准容器 (Container)，则返回 C::iterator 对象。

2) 若 C 为标准容器 (Container)，则返回 C::const_iterator 对象。

3) 返回 array 的起始指针。

4) 返回 std::begin(c)，其中 c 始终被视为 const 限定。

若 C 为标准容器 (Container)，则返回 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::initializer_list) (C++11)	重载 std::begin (函数模板)
std::begin(std::valarray) (C++11)	重载 std::begin (函数模板)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)	支持基于范围的 for 循环 (函数)
begin(std::filesystem::recursive_directory_iterator)end(std::filesystem::recursive_directory_iterator)	支持基于范围的 for 循环 (函数)

与 swap 的用法类似（在可交换 (Swappable) 中描述），在泛型上下文中 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;
    }
}

通过实参依赖查找 (argument-dependent lookup) 找到的 begin 重载可用于定制 std::ranges::begin、std::ranges::cbegin 以及依赖于 std::ranges::begin 的其他自定义点对象的行为。

(C++20 起)

注解

非数组重载精确地反映了 C::begin 的行为。如果成员函数没有合理的实现，它们的效果可能会令人惊讶。

引入 std::cbegin 是为了统一成员和非成员范围访问。另见 LWG issue 2128。

如果 C 是浅 const 视图，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

参阅

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