std::for_each

ヘッダー `<algorithm>` で定義
template< class InputIt, class UnaryFunc > UnaryFunc for_each( InputIt first, InputIt last, UnaryFunc f );	(1)	(C++20 以降 constexpr)
template< class ExecutionPolicy, class ForwardIt, class UnaryFunc > void for_each( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last, UnaryFunc f );	(2)	(C++17以降)

与えられた単項関数オブジェクト f を、[first, last) の範囲内のすべてのイテレータのデリファレンス結果に適用します。f が結果を返した場合、その結果は無視されます。

1) f は first から順に適用されます。

UnaryFunc が MoveConstructible でない場合、動作は未定義です。

(C++11以降)

2) f は順序通りに適用されない場合があります。アルゴリズムは policy に従って実行されます。

このオーバーロードは、以下のすべての条件が満たされた場合にのみオーバーロード解決に参加します。

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> が true である。	(C++20まで)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> は true です。	(C++20以降)

UnaryFunc が CopyConstructible でない場合、動作は未定義です。

イテレータ型 (InputIt/ForwardIt) がミュータブルな場合、f はデリファレンスされたイテレータを通して範囲の要素を変更する可能性があります。

他の並列アルゴリズムとは異なり、for_each はシーケンスの要素がTriviallyCopyableであっても、コピーを作成することは許されません。

first, last	-	関数オブジェクトが適用される要素の範囲を定義するイテレータの組
policy	-	使用する実行ポリシー
f	-	関数オブジェクト。`[`first`,` last`)` の範囲内のすべてのイテレータのデリファレンス結果に適用されます。関数のシグネチャは以下と同等である必要があります。 void fun(const Type &a); シグネチャは const & を持つ必要はありません。型 Type は、InputIt 型のオブジェクトがデリファレンスされ、暗黙的に Type に変換できるような型でなければなりません。
型要件
- `InputIt` は LegacyInputIterator の要件を満たす必要があります。
- `ForwardIt` は LegacyForwardIterator の要件を満たさなければなりません。

[編集] 戻り値

1) f

2) (なし)

[編集] 計算量

正確に std::distance(first, last) 回の f の適用。

[編集] 例外

テンプレートパラメータ ExecutionPolicy を持つオーバーロードは、次のようにエラーを報告します。

アルゴリズムの一部として呼び出された関数の実行が例外をスローし、ExecutionPolicy が標準ポリシーのいずれかである場合、std::terminate が呼び出されます。その他の ExecutionPolicy の場合、動作は実装定義です。
アルゴリズムがメモリの割り当てに失敗した場合、std::bad_alloc がスローされます。

[編集] 可能な実装

libstdc++、libc++、および MSVC stdlib の実装も参照してください。

template<class InputIt, class UnaryFunc>
constexpr UnaryFunc for_each(InputIt first, InputIt last, UnaryFunc f)
{
    for (; first != last; ++first)
        f(*first);
 
    return f; // implicit move since C++11
}

[編集] 備考

オーバーロード (1) の場合、f はステートフルな関数オブジェクトにすることができます。戻り値は、バッチ操作の最終状態と見なすことができます。

オーバーロード (2) の場合、並列呼び出しを実行するために f の複数のコピーが作成されることがあります。並列化では効率的な状態の蓄積が困難なことが多いため、値は返されません。

[編集] 例

以下の例では、ラムダ式を使用してベクトルのすべての要素をインクリメントし、次に関数オブジェクト（「ファンクタ」）のオーバーロードされた operator() を使用してそれらの合計を計算します。合計を計算するには、専用のアルゴリズム std::accumulate を使用することをお勧めします。

このコードを実行

#include <algorithm>
#include <iostream>
#include <vector>
 
int main()
{
    std::vector<int> v{3, -4, 2, -8, 15, 267};
 
    auto print = [](const int& n) { std::cout << n << ' '; };
 
    std::cout << "before:\t";
    std::for_each(v.cbegin(), v.cend(), print);
    std::cout << '\n';
 
    // increment elements in-place
    std::for_each(v.begin(), v.end(), [](int &n) { n++; });
 
    std::cout << "after:\t";
    std::for_each(v.cbegin(), v.cend(), print);
    std::cout << '\n';
 
    struct Sum
    {
        void operator()(int n) { sum += n; }
        int sum {0};
    };
 
    // invoke Sum::operator() for each element
    Sum s = std::for_each(v.cbegin(), v.cend(), Sum());    
    std::cout << "sum:\t" << s.sum << '\n';
}

出力

before:	3 -4 2 -8 15 267 
after:	4 -3 3 -7 16 268 
sum:	281

[編集] 欠陥報告

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

DR	適用対象	公開された動作	正しい動作
LWG 475	C++98	f がイテレート中のシーケンスの要素を変更できるか不明確だった（`for_each` は「非変更シーケンス操作」に分類されるため）イテレート中のシーケンスの要素を変更できるか不明確だった（`for_each` は「非変更シーケンス操作」に分類されるため）	明確化された（イテレータ型がミュータブルな場合は許可される）イテレータ型がミュータブルな場合は許可される
LWG 2747	C++11	オーバーロード (1) は std::move(f) を返していた	f を返す（暗黙的にムーブされる）

[編集] 関連項目

transform	範囲内の要素に関数を適用し、結果を結果範囲に格納する (関数テンプレート) [編集]
for_each_n (C++17)	シーケンスの最初のN個の要素に関数オブジェクトを適用する (関数テンプレート) [編集]
ranges::for_each (C++20)	範囲内の要素に単項関数オブジェクトを適用する (アルゴリズム関数オブジェクト)[編集]
ranges::for_each_n (C++20)	シーケンスの最初のN個の要素に関数オブジェクトを適用する (アルゴリズム関数オブジェクト)[編集]
範囲`for`ループ(C++11)	範囲に対するループを実行する[編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作