std::ranges::begin

 

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 /* 未指定 */ begin = /* 未指定 */; }		(C++20以降) (カスタマイズポイントオブジェクト)
呼び出しシグネチャ
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 + 0 と式等価です（t が配列型の場合）。
   • std::remove_all_extents_t<std::remove_reference_t<T>> が不完全型の場合、ranges::begin の呼び出しは ill-formed であり、診断は要求されません。
2. それ以外の場合、t.begin() を呼び出し、その結果の型が std::input_or_output_iterator をモデル化する場合、decay-copy(t.begin())(C++23まで)auto(t.begin())(C++23以降)。
3. それ以外の場合、T がクラス型または列挙型であり、引数依存名前探索のみによって確立される begin の意味で begin(t) を呼び出し、その結果の型が std::input_or_output_iterator をモデル化する場合、decay-copy(begin(t))(C++23まで)auto(begin(t))(C++23以降)。

上記以外の場合、ranges::begin の呼び出しは ill-formed となり、テンプレートインスタンス化の即時コンテキストで呼び出しが現れると、SFINAE を引き起こす可能性があります。

カスタマイゼーションポイントオブジェクト

ranges::begin という名前は、const であり、リテラルな semiregular クラス型の**カスタマイゼーションポイントオブジェクト**を表します。説明のため、その型の cv-修飾されていないバージョンを __begin_fn と表記します。

__begin_fn のすべてのインスタンスは等価です。同じ引数に対して異なる __begin_fn 型のインスタンスを呼び出す効果は、インスタンスを表す式が左辺値か右辺値か、const 修飾されているかどうかに関わらず等価です（ただし、volatile 修飾されたインスタンスが呼び出し可能である必要はありません）。したがって、ranges::begin は自由にコピーでき、そのコピーは相互に交換可能です。

型のセット Args... が与えられた場合、ranges::begin への引数に対する要件を std::declval<Args>()... が満たす場合、__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 の関数呼び出し演算子はオーバーロード解決に参加しません。

Notes

引数が右辺値（つまり T がオブジェクト型）で、ranges::enable_borrowed_range<std::remove_cv_t<T>> が false の場合、ranges::begin の呼び出しは ill-formed となり、これも substitution failure を引き起こします。

すべてのケースで、戻り値の型は std::input_or_output_iterator をモデル化します。

C++20 標準では、基になる begin 関数呼び出しが prvalue を返す場合、戻り値はマテリアライズされた一時オブジェクトからムーブ構築されることが要求されています。すべての実装は直接 prvalue を返します。この要件は、C++20 後に提案された P0849R8 によって、実装に合わせるように修正されています。

Example

このコードを実行

#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
}

Defect reports

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
P2602R2	C++20	ADL によって見つけられる特定の非メンバ begin を禁止する仕組みがありました。	その仕組みは削除されました。

See also

ranges::cbegin (C++20)	読み取り専用rangeの先頭を指すイテレータを返す (カスタマイゼーションポイントオブジェクト)
begincbegin (C++11)(C++14)	コンテナまたは配列の先頭を指すイテレータを返す (関数テンプレート)