std::begin, std::cbegin

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

迭代器库

迭代器概念
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) input_or_output_iterator (C++20) sentinel_for (C++20) sized_sentinel_for (C++20)	input_iterator (C++20) output_iterator (C++20) forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
迭代器原语
iterator_traits input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20) iterator (C++17 中弃用)	incrementable_traits (C++20) indirectly_readable_traits (C++20) iter_value_titer_difference_titer_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++20)(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	projected
迭代器适配器
reverse_iterator move_iterator (C++11) move_sentinel (C++20) common_iterator (C++20) counted_iterator (C++20) back_insert_iterator front_insert_iterator insert_iterator	make_reverse_iterator (C++14) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20) back_inserter front_inserter inserter
流迭代器
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) endcend (C++11)(C++14) sizessize (C++17)(C++20)	rbegincrbegin (C++14)(C++14) rendcrend (C++14)(C++14) empty (C++17) data (C++17)

 

定义于头文件 <array>
定义于头文件 <deque>
定义于头文件 <forward_list>
定义于头文件 <iterator>
定义于头文件 <list>
定义于头文件 <map>
定义于头文件 <regex>
定义于头文件 <set>
定义于头文件 <span>		(C++20 起)
定义于头文件 <string>
定义于头文件 <string_view>		(C++17 起)
定义于头文件 <unordered_map>
定义于头文件 <unordered_set>
定义于头文件 <vector>
	(1)
template< class C > auto begin( C& c ) -> decltype(c.begin());			(C++11 起) (C++17 前)
template< class C > constexpr auto begin( C& c ) -> decltype(c.begin());			(C++17 起)
		(1)
template< class C > auto begin( const C& c ) -> decltype(c.begin());				(C++11 起) (C++17 前)
template< class C > constexpr auto begin( const C& c ) -> decltype(c.begin());				(C++17 起)
			(2)
template< class T, std::size_t N > T* begin( T (&array)[N] );					(C++11 起) (C++14 前)
template< class T, std::size_t N > constexpr T* begin( T (&array)[N] ) noexcept;					(C++14 起)
template< class C > constexpr auto cbegin( const C& c ) noexcept(/* see below */)     -> decltype(std::begin(c));				(3)	(C++14 起)

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

1) 准确返回 c.begin() ，典型地是指向 c 所代表的序列起始的迭代器。若 C 是标准容器 (Container) ，则在 c 不是 const 限定时返回 C::iterator ，否则返回 C::const_iterator 。

2) 返回指向 array 起始的指针。

3) 准确返回 std::begin(c) ，这里 c 始终被视为 const 限定。若 C 是标准容器 (Container) ，则始终返回 C::const_iterator 。

参数

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

返回值

指向范围起始的迭代器

异常

3)

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)	基于范围的 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;
    }
}

实参依赖查找所找到的 begin 重载能用于定制 std::ranges::begin、 std::ranges::cbegin 及其他依赖于 std::ranges::begin 的定制点对象的行为。

(C++20 起)

注解

(1,3) 准确地反映 C::begin() 的行为。若该成员函数无合理的实现，则它们的效果可能令人惊异。

std::cbegin 是为统一成员与非成员范围访问引入的。参阅 LWG 问题 2128 。

若 C 是浅 const 的视图，则 std::cbegin 可能返回可变的迭代器。某些用户不期待这种行为。参阅 P2276 与 P2278 。

示例

运行此代码

#include <iostream>
#include <vector>
#include <iterator>
 
int main() 
{
    std::vector<int> v = { 3, 1, 4 };
    auto vi = std::begin(v);
    std::cout << *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)	返回指向只读范围起始的迭代器 (定制点对象)