std::begin, std::cbegin

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (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)

 

<tbody> </tbody>

在标头 <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 起为 noexcept) (C++14 起为 constexpr)
template< class C > constexpr auto cbegin( const C& c ) noexcept(/* 见下文 */) -> decltype(std::begin(c));	(4)	(C++14 起)

See More

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

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)	基于范围的 for 循环支持 (函数)
begin(std::filesystem::recursive_directory_iterator)end(std::filesystem::recursive_directory_iterator)	基于范围的 for 循环支持 (函数)

同 swap 的用法（在可交换 (Swappable) 描述），begin 函数在泛型语境中的典型用法等价于 using std::begin; begin(arg);，这允许实参依赖查找为用户定义类型所选的重载和标准库函数模板出现于同一重载集中。

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 问题 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)	返回指向只读范围起始的迭代器 (定制点对象)