std::ranges::cbegin

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

Rangesライブラリ

Rangeアクセス begin cbegin   end cend rbegin crbegin   rend crend size ssize   data cdata reserve_hint (C++26)   empty

Range変換 std::from_range_t std::from_range (C++23)(C++23)     to (C++23)

ダングリングイテレータの扱い dangling borrowed_iterator_t borrowed_subrange_t

Rangeプリミティブ
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コンセプト
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ファクトリ
empty_viewviews::empty	single_viewviews::single	basic_istream_viewviews::istream	iota_viewviews::iota	repeat_viewviews::repeat (C++23)(C++23)

Rangeアダプタ
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ジェネレータ std::generator (C++23)

Rangeアダプタクロージャオブジェクト range_adaptor_closure (C++23)

Rangeアダプタオブジェクト

ヘルパーアイテム
copyable-box movable-box (C++23まで)  (C++23)	simple-view non-propagating-cache

 

ヘッダ <ranges> で定義
ヘッダ <iterator> で定義
inline namespace /* 未指定 */ {     inline constexpr /* 未指定 */ cbegin = /* 未指定 */; }		(C++20以降) (カスタマイズポイントオブジェクト)
呼び出しシグネチャ
template< class T >     requires /* 以下を参照 */ constexpr /* 以下を参照 */ auto cbegin( T&& t );		(C++20以降)

const修飾された引数の最初の要素へのイテレータを返します。	(C++23まで)
引数の最初の要素への定数イテレータを返します。	(C++23から)

CT を次のようにします。 引数が左辺値（つまり、T が左辺値参照型）の場合、const std::remove_reference_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 の呼び出しは不適格であり、テンプレートインスタンス化の即時コンテキストで呼び出しが出現した場合、SFINAE を引き起こす可能性があります。	(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)	rangeの先頭を指すイテレータを返す (カスタマイゼーションポイントオブジェクト)
begincbegin (C++11)(C++14)	コンテナまたは配列の先頭を指すイテレータを返す (関数テンプレート)