std::begin, std::cbegin

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

[編集] 引数

[編集] 戻り値

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

[編集] 例外

[編集] ノート

<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 のカスタムオーバーロードを提供しても構いません。 以下のオーバーロードは標準ライブラリによってすでに提供されています。

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

[編集] 例

#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

[編集] 関連項目