std::ranges::begin

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

範圍庫 (Ranges library)

範圍訪問 begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

範圍轉換 (Range conversions) std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

懸空迭代器處理 (Dangling iterator handling) dangling borrowed_iterator_t borrowed_subrange_t

範圍原語 (Range primitives)
range_size_trange_difference_trange_value_t elements_of (C++23)	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (C++23)(C++23)	range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t (C++23)

範圍概念 (Range concepts)
range borrowed_range    common_range	sized_range viewable_range    view	input_range output_range forward_range	bidirectional_range    random_access_range contiguous_range	approximately_sized_range (C++26) constant_range (C++23)

檢視
view_interface	subrange

範圍工廠 (Range factories)
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

範圍介面卡 (Range adaptors)
views::all_tviews::all as_rvalue_viewviews::as_rvalue (C++23)(C++23)   filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while common_viewviews::common views::counted to_input_viewviews::to_input (C++26)(C++26)	ref_view drop_viewviews::drop drop_while_viewviews::drop_while lazy_split_viewviews::lazy_split split_viewviews::split join_viewviews::join join_with_viewviews::join_with (C++23)(C++23)   concat_viewviews::concat (C++26)(C++26) cache_latest_viewviews::cache_latest (C++26)(C++26)	owning_view reverse_viewviews::reverse as_const_viewviews::as_const (C++23)(C++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (C++23)(C++23) zip_viewviews::zip (C++23)(C++23) zip_transform_viewviews::zip_transform (C++23)(C++23)	adjacent_viewviews::adjacent (C++23)(C++23) views::pairwise (C++23) adjacent_transform_viewviews::adjacent_transform (C++23)(C++23) views::pairwise_transform (C++23) chunk_viewviews::chunk (C++23)(C++23) slide_viewviews::slide (C++23)(C++23) chunk_by_viewviews::chunk_by (C++23)(C++23) stride_viewviews::stride (C++23)(C++23) cartesian_product_viewviews::cartesian_product (C++23)(C++23)

範圍生成器 (Range generators) std::generator (C++23)

範圍介面卡閉包物件 (Range adaptor closure objects) range_adaptor_closure (C++23)

範圍介面卡物件 (Range adaptor objects)

輔助項 (Helper items)
copyable-box movable-box (直到 C++23)  (C++23)	simple-view non-propagating-cache

 

定義於標頭檔案 <ranges>
定義於標頭檔案 <iterator>
inline namespace /* 未指定 */ {     inline constexpr /* 未指定 */ begin = /* 未指定 */; }		(C++20 起) (定製點物件)
呼叫簽名 (Call signature)
template< class T >     requires /* 見下文 */ constexpr std::input_or_output_iterator auto begin( T&& t );		(C++20 起)

返回引數的第一個元素的迭代器。

如果引數是左值，或者 ranges::enable_borrowed_range<std::remove_cv_t<T>> 為 true，則呼叫 ranges::begin 表示式等價於

1. 如果 t 具有陣列型別，則為 t + 0。
   • 如果 std::remove_all_extents_t<std::remove_reference_t<T>> 不完整，則對 ranges::begin 的呼叫是 ill-formed，無需診斷。
2. 否則，decay-copy(t.begin())(C++23 前)auto(t.begin())(C++23 起)，如果該表示式有效且其型別建模 std::input_or_output_iterator。
3. 否則，decay-copy(begin(t))(C++23 前)auto(begin(t))(C++23 起)，如果 T 是類或列舉型別，且該表示式有效且其型別建模 std::input_or_output_iterator，其中 begin 的含義是透過僅執行實參依賴查詢來確定的。

在所有其他情況下，對 ranges::begin 的呼叫是 ill-formed，當調用出現在模板例項化的直接上下文中時，可能導致替換失敗。

自定義點物件

名稱 ranges::begin 表示一個*自定義點物件*，它是一個常量函式物件，其型別為字面量semiregular類型別。為了便於說明，其 cv-unqualified 版本的型別表示為 __begin_fn。

__begin_fn 的所有例項均相等。在相同引數上呼叫不同型別的 __begin_fn 例項的效果是等效的，無論表示例項的表示式是左值還是右值，以及是否為 const-qualified（但是，volatile-qualified 例項不要求是可呼叫的）。因此，ranges::begin 可以自由複製，並且其副本可以互換使用。

給定一組型別 Args...，如果 std::declval<Args>()... 滿足上述 ranges::begin 的引數要求，則 __begin_fn 建模

• std::invocable<__begin_fn, Args...>,
• std::invocable<const __begin_fn, Args...>,
• std::invocable<__begin_fn&, Args...>，以及
• std::invocable<const __begin_fn&, Args...>.
  

否則，__begin_fn 的任何函式呼叫運算子都不參與過載決議。

注意

如果引數是右值（即 T 是物件型別）並且 ranges::enable_borrowed_range<std::remove_cv_t<T>> 為 false，則對 ranges::begin 的呼叫是 ill-formed，這也會導致替換失敗。

返回型別在所有情況下都建模 std::input_or_output_iterator。

C++20 標準要求如果底層 begin 函式呼叫返回一個 prvalue，則返回值是從具體化的臨時物件移動構造的。所有實現都直接返回 prvalue。該要求已透過 C++20 後的提案 P0849R8 進行了更正，以與實現匹配。

示例

執行此程式碼

#include <cassert>
#include <ranges>
#include <vector>
 
int main() 
{
    std::vector v{3, 1, 4};
    auto vi = std::ranges::begin(v);
    auto vci = std::ranges::cbegin(v);
    assert(*vi == 3 and *vi == *vci);
    ++vi;
    ++vci; // OK: vci is modifiable object
    *vi = 42; // OK: vi points to mutable element
    // *vci = 13; // Error: vci points to immutable element
 
    int a[]{-5, 10, 15};
    auto ai = std::ranges::begin(a); // works with C-arrays as well
    assert(*ai == -5);
    *ai = 42; // OK
}

缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
P2602R2	C++20	存在機制來禁止某些透過ADL找到的非成員 begin	刪除了此類機制

參閱

ranges::cbegin (C++20)	返回只讀範圍的起始迭代器 (自定義點物件)
begincbegin (C++11)(C++14)	返回指向容器或陣列開頭的迭代器 (函式模板)