std::ranges::cbegin

 

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 /* unspecified */ {     inline constexpr /* unspecified */ cbegin = /* unspecified */; }		(C++20 起) (定製點物件)
呼叫簽名 (Call signature)
template< class T >     requires /* 見下文 */ constexpr /* 見下文 */ auto cbegin( T&& t );		(C++20 起)

返回一個指向 const 限定引數第一個元素的迭代器。	(直至 C++23)
返回一個指向引數第一個元素的常迭代器。	(C++23 起)

令 CT 為 const std::remove_reference_t<T>& 如果引數是左值（即 T 是左值引用型別）， const T 否則。 呼叫 ranges::cbegin 表示式等價於 ranges::begin(static_cast<CT&&>(t))。	(直至 C++23)
如果引數是左值或 ranges::enable_borrowed_range<std::remove_cv_t<T>> 為 true，則呼叫 ranges::cbegin 表示式等價於 std::const_iterator<decltype(U)>(U)，其中 U 是等價於 ranges::begin(possibly-const-range(t) 的某個表示式。 在所有其他情況下，呼叫 ranges::cbegin 是病態的，這可能導致當調用出現在模板例項化的直接語境中時發生替換失敗。	(C++23 起)

在所有情況下，返回型別都滿足 std::input_or_output_iterator 和 constant-iterator(C++23 起)。

自定義點物件

名稱 ranges::cbegin 表示一個定製點物件，它是一個 字面型別 semiregular 類型別的 const 函式物件。為便於闡述，其 cv 非限定版本型別表示為 __cbegin_fn。

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

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

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

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

注意

對於型別為 T 的左值範圍 e，ranges::cbegin(e) 等價於

ranges::begin(std::as_const(e)).	(直至 C++23)
ranges::begin(e)，如果 T 滿足 constant_range。 否則，ranges::begin(std::as_const(e))，如果 const T 滿足 constant_range。 否則，std::basic_const_iterator(ranges::begin(e))。	(C++23 起)

示例

執行此程式碼

#include <cassert>
#include <ranges>
#include <vector>
 
int main()
{
    std::vector v{3, 1, 4};
    auto vi = std::ranges::cbegin(v);
    assert(3 == *vi);
    ++vi; // OK, constant-iterator object is mutable
    assert(1 == *vi);
    // *vi = 13; // Error: constant-iterator points to an immutable element
 
    int a[]{3, 1, 4};
    auto ai = std::ranges::cbegin(a); // cbegin works with C-arrays as well
    assert(3 == *ai and *(ai + 1) == 1);
    // *ai = 13; // Error: read-only variable is not assignable
}

參閱

ranges::begin (C++20)	返回指向範圍開頭的迭代器 (定製點物件)
begincbegin (C++11)(C++14)	返回指向容器或陣列開頭的迭代器 (函式模板)