std::begin, std::cbegin

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

イテレータライブラリ

イテレータのコンセプト
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)	Rangeアクセス 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以降 noexcept) (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() メンバ関数が公開されていない場合のために、カスタムオーバーロードを提供できます。標準ライブラリはすでに以下のオーバーロードを提供しています。

std::begin(std::initializer_list) (C++11)	オーバーロード std::begin (function template)
std::begin(std::valarray) (C++11)	オーバーロード std::begin (function template)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator) (C++17)	範囲ベース for ループのサポート (function)
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;
    }
}

引数依存探索によって見つかる 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)	rangeの先頭を指すイテレータを返す (カスタマイゼーションポイントオブジェクト)
ranges::cbegin (C++20)	読み取り専用rangeの先頭を指すイテレータを返す (カスタマイゼーションポイントオブジェクト)