4. transform_inclusive_scan

最終更新日時(UTC):
が更新

履歴 編集

function template
<numeric>

std::transform_inclusive_scan(C++17)

namespace std {
  template <class InputIterator, class OutputIterator,
            class BinaryOperation, class UnaryOperation>
  OutputIterator
    transform_inclusive_scan(InputIterator first,
                             InputIterator last,
                             OutputIterator result,
                             BinaryOperation binary_op,
                             UnaryOperation unary_op);   // (1) C++17
  template <class InputIterator, class OutputIterator,
            class BinaryOperation, class UnaryOperation>
  constexpr OutputIterator
    transform_inclusive_scan(InputIterator first,
                             InputIterator last,
                             OutputIterator result,
                             BinaryOperation binary_op,
                             UnaryOperation unary_op);   // (1) C++20

  template <class InputIterator, class OutputIterator,
            class BinaryOperation, class UnaryOperation, class T>
  OutputIterator
    transform_inclusive_scan(InputIterator first,
                             InputIterator last,
                             OutputIterator result,
                             BinaryOperation binary_op,
                             UnaryOperation unary_op,
                             T init);                    // (2) C++17
  template <class InputIterator, class OutputIterator,
            class BinaryOperation, class UnaryOperation, class T>
  constexpr OutputIterator
    transform_inclusive_scan(InputIterator first,
                             InputIterator last,
                             OutputIterator result,
                             BinaryOperation binary_op,
                             UnaryOperation unary_op,
                             T init);                    // (2) C++20

  template <class ExecutionPolicy,
            class ForwardIterator1, class ForwardIterator2,
            class BinaryOperation, class UnaryOperation>
   ForwardIterator2
     transform_inclusive_scan(ExecutionPolicy&& exec,
                              ForwardIterator1 first,
                              ForwardIterator1 last,
                              ForwardIterator2 result,
                              BinaryOperation binary_op,
                              UnaryOperation unary_op);  // (3) C++17

  template <class ExecutionPolicy,
            class ForwardIterator1, class ForwardIterator2,
            class BinaryOperation, class UnaryOperation, class T>
  ForwardIterator2
    transform_inclusive_scan(ExecutionPolicy&& exec,
                             ForwardIterator1 first,
                             ForwardIterator1 last,
                             ForwardIterator2 result,
                             BinaryOperation binary_op,
                             UnaryOperation unary_op,
                             T init);                    // (4) C++17
}

概要

イテレータ範囲[first, last)の要素を変換しながら部分和を計算する。この関数は、i番目の部分和を求める際にi番目の要素を含め、範囲[0, i]までの部分和を計算する。

transform_inclusive_scan()の引数として、初期値0、シーケンス{1, 2, 3}が与えられ、和に相当する二項演算関数オブジェクトbinary_opをoperator+、要素変換の関数オブジェクトunary_opをパラメータをそのまま返す関数f()であるとして、以下のような結果が行われる：

{
  1, // (0 + ) f(1)
  3, // (0 + ) f(1) + f(2)
  6  // (0 + ) f(1) + f(2) + f(3)
}

初期値が与えられない場合、その演算は行われない (初期値の代わりにイテレータの要素型を値構築した値を使用したりはしない)。

  • (1) : 二項演算として任意の関数オブジェクトbinary_op、要素を変換する関数オブジェクトunary_opを使用して部分和を求める
  • (2) : 初期値をinit、二項演算として任意の関数オブジェクトbinary_op、要素を変換する関数オブジェクトunary_opを使用して部分和を求める
  • (3) : (1)の並列アルゴリズム版。第1パラメータとして実行ポリシーをとる
  • (4) : (2)の並列アルゴリズム版。第1パラメータとして実行ポリシーをとる

要件

  • (1), (2), (3), (4) : 関数オブジェクトunary_opとbinary_opの呼び出しは、イテレータ範囲[first, last]およびイテレータ範囲[result, result + (last - first)]の要素変更およびイテレータの無効化をしてはならない

テンプレートパラメータ制約

  • (1), (3) : ForwardIteratorの要素型がstd::move_constructible要件を満たすこと
  • (2), (4) : 型Tがstd::move_constructible要件を満たすこと
  • (1), (3) : 以下の全ての演算結果の型が、ForwardIteratorの要素型に変換可能であること
    • binary_op(unary_op(*first), unary_op(*first))
  • (2), (4) : 以下の全ての演算結果の型が、型Tに変換可能であること
    • binary_op(init, init)
    • binary_op(init, unary_op(*first))
    • binary_op(unary_op(*first), unary_op(*first))

効果

  • (1), (3) : 範囲[0, last - first)の各値をKとして、出力先のイテレータresult + Kに、{unary_op(*first), unary_op(*(first + 1)), unary_op(*(first + 2)), ..., unary_op(*(last - 1))}のK番目までの要素の合計値を順不同に代入する
  • (2), (4) : 範囲[0, last - first)の各値をKとして、出力先のイテレータresult + Kに、初期値をinitとして{unary_op(*first), unary_op(*(first + 1)), unary_op(*(first + 2)), ..., unary_op(*(last - 1))}のK番目までの要素の合計値を順不同に代入する

戻り値

結果範囲の末尾イテレータを返す

計算量

関数オブジェクトunary_opとbinary_opをO(last - first)回だけ適用する

備考

  • (1), (2), (3), (4) :
    • resultはfirstと同値になるだろう
    • 関数オブジェクトbinary_opに数学的な結合性がない場合、この関数は非決定的な動作になる可能性がある
  • (2), (4) : 関数オブジェクトunary_opは初期値initに対しては適用しない

例

#include <iostream>
#include <vector>
#include <string>
#include <numeric>

int main()
{
  // (1)
  {
    std::vector<int> v = {1, 2, 3, 4, 5};
    std::vector<int> result(v.size());

    // result[0] = 1*10
    // result[1] = 1*10 + 2*10
    // result[2] = 1*10 + 2*10 + 3*10
    // result[3] = 1*10 + 2*10 + 3*10 + 4*10
    // result[4] = 1*10 + 2*10 + 3*10 + 4*10 + 5*10
    std::transform_inclusive_scan(v.begin(), v.end(), result.begin(),
                        [](int a, int b) { return a + b; },
                        [](int x) { return x * 10; }); // 変換関数で型変換はできない

    for (int x : result) {
      std::cout << x << ' ';
    }
    std::cout << std::endl;
  }

  // (2)
  {
    std::vector<std::string> v = {"1", "2", "3", "4", "5"};
    std::vector<int> result(v.size());

    // result[0] = 0 + stoi("1")
    // result[1] = 0 + stoi("1") + stoi("2")
    // result[2] = 0 + stoi("1") + stoi("2") + stoi("3")
    // result[3] = 0 + stoi("1") + stoi("2") + stoi("3") + stoi("4")
    // result[4] = 0 + stoi("1") + stoi("2") + stoi("3") + stoi("4") + stoi("5")
    std::transform_inclusive_scan(v.begin(), v.end(), result.begin(),
                        [](int a, int b) { return a + b; },
                        [](const std::string& s) { return std::stoi(s); },
                        0);

    for (int x : result) {
      std::cout << x << ' ';
    }
    std::cout << std::endl;
  }
}

出力

10 30 60 100 150 
1 3 6 10 15

バージョン

言語

  • C++17

処理系

参照