4. fold_left

    • Class / Function / Type

      std::

    • Header file

      <>

    • Other / All

    crsearch v3.0.23

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

    履歴 編集

    function template
    <algorithm>

    std::ranges::fold_left

    namespace std::ranges {
  template <input_iterator I,
            sentinel_for<I> S,
            class T,
            indirectly-binary-left-foldable<T, I> F>
  constexpr auto
    fold_left(I first,
              S last,
              T init,
              F f);   // (1) C++23
  template <input_iterator I,
            sentinel_for<I> S,
            class T = iter_value_t<I>,
            indirectly-binary-left-foldable<T, I> F>
  constexpr auto
    fold_left(I first,
              S last,
              T init,
              F f);   // (1) C++26

  template <input_range R,
            class T, 
            indirectly-binary-left-foldable<T, iterator_t<R>> F>
  constexpr auto
    fold_left(R&& r,
              T init,
              F f);   // (2) C++23
  template <input_range R,
            class T = range_value_t<R>, 
            indirectly-binary-left-foldable<T, iterator_t<R>> F>
  constexpr auto
    fold_left(R&& r,
              T init,
              F f);   // (2) C++26
}

    概要

    初期値から始めて、入力範囲の各要素に対して指定された二項演算を適用していきその結果を返す。二項演算が適用される各ステップでは、前のステップまでの積算値が一緒に渡される。

    この関数は、初期値を入力範囲の先頭に付加した範囲に対してその先頭の隣り合う2要素に対して与えられた二項演算を適用し、その結果によって処理した要素を置換し、処理後の範囲に対して同様の処理を残りの要素が無くなるまで繰り返すような処理を行う。

    これは、関数型言語におけるリスト操作の一般形である高階関数foldlに対応し、std::accumulateを改善したものでもある。

    入力範囲を{1, 2, 3, 4, 5}、初期値を0、二項演算を+（std::plus<>）とした時のfold_leftの処理の様子

    0 : init
[1, 2, 3, 4, 5] : rng

0  [1, 2, 3, 4, 5]
0 + 1
   1 + 2
      3 + 3
         6 + 4
           10 + 5 -> fold_left(rng, 0, +)

    fold_rightに対しては、入力範囲の先頭から末尾に向かって処理を進めていく点が異なる。

    引数

    • first -- 入力範囲の先頭イテレータ
    • last -- 入力範囲の番兵（終端イテレータ）
    • r -- 入力範囲のオブジェクト
    • init -- 初期値
    • f -- 適用する二項演算
      • f(std::move(init), *first)のような呼び出しが可能であり、その戻り値型のオブジェクトをaccとすると
      • acc = f(std::move(acc), *first)のような呼び出しも可能である必要がある

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

    indirectly-binary-left-foldableは次のように定義される説明専用のコンセプトである

    template<class F, class T, class I, class U>
concept indirectly-binary-left-foldable-impl =
  movable<T> &&
  movable<U> &&
  convertible_to<T, U> &&
  invocable<F&, U, iter_reference_t<I>> &&
  assignable_from<U&, invoke_result_t<F&, U, iter_reference_t<I>>>;

template<class F, class T, class I>
concept indirectly-binary-left-foldable =
  copy_constructible<F> &&
  indirectly_readable<I> &&
  invocable<F&, T, iter_reference_t<I>> &&
  convertible_to<invoke_result_t<F&, T, iter_reference_t<I>>,
         decay_t<invoke_result_t<F&, T, iter_reference_t<I>>>> &&
  indirectly-binary-left-foldable-impl<F, T, I,
                  decay_t<invoke_result_t<F&, T, iter_reference_t<I>>>>;

    ここでのテンプレートパラメータはそれぞれ、二項演算を指定する呼出可能な型F、初期値の型T、イテレータ型I、戻り値型（積算値の型）Uである。

    二項演算（F）は初期値・積算値と入力範囲の参照型に対してinvocableであることしか求められていない（regular_invocableではない）ため、適用する二項演算は任意の副作用を伴っていても良い。

    戻り値

    • (1) : 以下と等価 

      return ranges::fold_left_with_iter(std::move(first), last, std::move(init), f).value;

    • (2) : rからイテレータを取得して(1)に委譲 

      return ranges::fold_left(ranges::begin(r), ranges::end(r), std::move(init), f);

    空の入力範囲に対しては初期値initを返す。

    計算量

    入力範囲r（[first, last)）の要素数をNとすると、正確にN回のfの適用が行われる。

    備考

    • この関数の戻り値型は、入力の型F, T, Iから次のようなUとして取得される 

      using U = decay_t<invoke_result_t<F&, T, iter_reference_t<I>>>;

      • すなわち、指定した二項演算を初期値とイテレータによってf(std::move(init), *first)のように呼び出した時の戻り値型がこの関数の戻り値型となる。
      • また、この型Uはfold_leftの処理内部で積算値の型として使用されるものでもあり、fはinitの代わりにUの右辺値も受け取れる必要がある。二項演算の呼び出しにおいては、第一引数に初期値もしくは積算値が渡され、第二引数にイテレータの間接参照結果が直接渡される。そして、二項演算の適用結果は積算値を保存する変数に直接代入される（つまり、結果を次のステップに引き継ぎたい場合は積算処理も二項演算内で行う必要がある）。詳細は下の実装例を参照。

    • (1), (2) :

      • C++26 : 引数として波カッコ初期化{}を受け付ける 
        std::vector<T> v;
T sum = std::ranges::fold_left(v, {a, b}, op);

    例

    基本的な数値集計処理の例

    #include <ranges>
#include <algorithm>
#include <functional>
#include <print>
#include <vector>
#include <concepts>

using namespace std::ranges;

int main() {
  // 入力
  range auto rng = views::iota(1, 11);
  // 初期値
  const int init = 0;
  // 二項演算
  auto op = std::plus<>{};

  int resl = fold_left(rng, init, op);

  std::println("{:d}", resl);


  // 入力範囲はfloatのvector
  std::vector<float> rngf = { 0.125f, 0.25f, 0.75f };

  // 計算結果はfloat
  std::same_as<float> auto reslf = fold_left(rngf, init, op);

  std::println("{:g}", reslf);
}

    出力

    55
1.125

    処理順序を表示する例

    #include <ranges>
#include <algorithm>
#include <functional>
#include <print>
#include <vector>

using namespace std::ranges;

int main() {
  // [a, b, c, d, e, f]
  range auto rng = views::iota('a', 'g');

  const std::string init = "init";

  // fold_leftの二項演算op
  auto op_left = [](std::string acc, char elem) {
    acc += " -> ";
    acc += elem;
    return acc;
  };
  // fold_rightの二項演算op
  auto op_right = [op_left](char elem, std::string acc) {
    return op_left(std::move(acc), elem);
  };

  auto resl = fold_left(rng, init, op_left);
  auto resr = fold_right(rng, init, op_right);

  std::println("{:s}", resl);
  std::println("{:s}", resr);
}

    出力

    init -> a -> b -> c -> d -> e -> f
init -> f -> e -> d -> c -> b -> a

    波カッコ初期化を入力として使用する (C++26)

    #include <algorithm>
#include <print>
#include <vector>

int main() {
  std::vector<int> v = {1, 2, 3};

  int sum = std::ranges::fold_left(
    v,
    {},
    [](auto&& a, auto&& b) { return a + b; }
  );
  std::println("{}", sum);
}

    出力

    6

    実装例

    template<input_iterator I, sentinel_for<I> S, class T,
         indirectly-binary-left-foldable<T, I> F>
constexpr auto fold_left(I first, S last, T init, F f) {
  using U = decay_t<invoke_result_t<F&, T, iter_reference_t<I>>>;

  if (first == last) {
    return U(std::move(init));
  }

  U accum = invoke(f, std::move(init), *first);

  ++first;

  for (; first != last; ++first) {
    accum = invoke(f, std::move(accum), *first);
  }

  return accum; // 暗黙ムーブ or NRVO
}

    バージョン

    言語

    • C++23

    処理系

    関連項目

    参照