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)	返回只讀範圍的起始迭代器 (定製點物件)