std::begin, std::cbegin

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

ローカライゼーションライブラリ

入出力ライブラリ

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

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

技術仕様書

 

イテレータライブラリ

イテレータコンセプト
indirectly_readable (C++20) indirectly_writable (C++20) weakly_incrementable (C++20) incrementable (C++20) input_or_output_iterator (C++20) sentinel_for (C++20) sized_sentinel_for (C++20)	input_iterator (C++20) output_iterator (C++20) forward_iterator (C++20) bidirectional_iterator (C++20) random_access_iterator (C++20) contiguous_iterator (C++20)
イテレータプリミティブ
iterator_traits input_iterator_tagoutput_iterator_tagforward_iterator_tagbidirectional_iterator_tagrandom_access_iterator_tagcontiguous_iterator_tag (C++20) iterator (C++17で非推奨)	incrementable_traits (C++20) indirectly_readable_traits (C++20) iter_value_titer_difference_titer_reference_titer_rvalue_reference_titer_common_reference_t (C++20)(C++20)(C++20)(C++20)(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	projected
イテレータアダプタ
reverse_iterator move_iterator (C++11) move_sentinel (C++20) common_iterator (C++20) counted_iterator (C++20) back_insert_iterator front_insert_iterator insert_iterator	make_reverse_iterator (C++14) make_move_iterator (C++11) default_sentinel_tdefault_sentinel (C++20)(C++20) unreachable_sentinel_tunreachable_sentinel (C++20)(C++20) back_inserter front_inserter inserter
ストリームイテレータ
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)
範囲アクセス
begincbegin (C++11)(C++14) endcend (C++11)(C++14) sizessize (C++17)(C++20)	rbegincrbegin (C++14)(C++14) rendcrend (C++14)(C++14) empty (C++17) data (C++17)

 

<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody>

ヘッダ <iterator> で定義
	(1)
template< class C > auto begin( C& c ) -> decltype(c.begin());			(C++11以上) (C++17未満)
template< class C > constexpr auto begin( C& c ) -> decltype(c.begin());			(C++17以上)
		(1)
template< class C > auto begin( const C& c ) -> decltype(c.begin());				(C++11以上) (C++17未満)
template< class C > constexpr auto begin( const C& c ) -> decltype(c.begin());				(C++17以上)
			(2)
template< class T, std::size_t N > T* begin( T (&array)[N] );					(C++11以上) (C++14未満)
template< class T, std::size_t N > constexpr T* begin( T (&array)[N] ) noexcept;					(C++14以上)
template< class C > constexpr auto cbegin( const C& c ) noexcept(/* see below */) -> decltype(std::begin(c));				(3)	(C++14以上)

指定されたコンテナ c または配列 array の先頭を指すイテレータを返します。 これらのテンプレートは C::begin() が妥当な実装を持つことを当てにしています。

1) 正確に c.begin() を返します。 これは一般的には c によって表されるシーケンスの先頭を指すイテレータです。 C が標準の Container の場合、 c が const 修飾されていなければ C::iterator を返し、そうでなければ C::const_iterator を返します。

2) array の先頭を指すポインタを返します。

3) 正確に std::begin(c) を返します。 c は常に const 修飾されたものとして扱われます。 C が標準の Container の場合、これは常に C::const_iterator を返します。

引数

c	-	メンバ関数 begin を持つコンテナ
array	-	任意の型の配列

戻り値

c または array の先頭を指すイテレータ。

例外

3)

noexcept 指定:  

noexcept(noexcept(std::begin(c)))

ノート

<iterator> がインクルードされた場合に加えて <array>、 <deque>、 <forward_list>、 <list>、 <map>、 <regex>、 <set>、 <span> (C++20以上)、 <string>、 <string_view> (C++17以上)、 <unordered_map>、 <unordered_set>、 <vector> のいずれかのヘッダがインクルードされた場合も、 std::begin および std::cbegin が利用可能になることが保証されています。

ユーザ定義のオーバーロード

適切な begin() メンバ関数を持たないけれどもイテレート可能なクラスに対して、 begin のカスタムオーバーロードを提供しても構いません。 以下のオーバーロードは標準ライブラリによってすでに提供されています。

std::begin(std::initializer_list) (C++11)	std::begin の特殊化 (関数テンプレート)
std::begin(std::valarray) (C++11)	std::begin の特殊化 (関数テンプレート)
begin(std::filesystem::directory_iterator)end(std::filesystem::directory_iterator)	範囲ベースの for ループサポート (関数)
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;
    }
}

例

Run this code

#include <iostream>
#include <vector>
#include <iterator>

int main() 
{
    std::vector<int> v = { 3, 1, 4 };
    auto vi = std::begin(v);
    std::cout << *vi << '\n'; 

    int a[] = { -5, 10, 15 };
    auto ai = std::begin(a);
    std::cout << *ai << '\n';
}

出力:

3
-5

関連項目

endcend (C++11)(C++14)

コンテナまたは配列の終端を指すイテレータを返します (関数)