Namespaces
Variants

std::ranges::fold_right

ja.cppreference.net より
 
 
アルゴリズムライブラリ
制約付きアルゴリズムと範囲に対するアルゴリズム (C++20)
制約付きアルゴリズム、例: ranges::copy、ranges::sort、...
変更操作を行わないシーケンス操作    
一括操作
(C++17)
検索操作
変更操作を行うシーケンス操作
コピー操作
(C++11)
(C++11)
スワップ操作
変換操作
生成操作
削除操作
順序変更操作
(C++17 まで)(C++11)
(C++20)(C++20)
サンプリング操作
(C++17)

ソートと関連操作
分割操作
(C++11)    

ソート操作
二分探索操作
(分割された範囲に対する)
集合操作 (ソート済み範囲に対する)
マージ操作 (ソート済み範囲に対する)
ヒープ操作
最小/最大操作
(C++11)
(C++17)
辞書比較操作
順列操作


 
制約付きアルゴリズム
このメニュー内のすべての名前は名前空間 std::ranges
に属する
(C++23)
unique_copy
stable_partition
partial_sort_copy
equal_range
set_symmetric_difference
pop_heap
clamp
prev_permutation
fold_left_first  
fold_right
fold_right_last  
fold_left_with_iter
fold_left_first_with_iter
(C++23)
iota            
(C++23)
generate_random
(C++26)
uninitialized_value_construct_n
 
(C++23)<algorithm>
ヘッダ
template< std::bidirectional_iterator I, std::sentinel_for<I> S, class T,
          /* indirectly-binary-right-foldable */<T, I> F >
constexpr auto fold_right( I first, S last, T init, F f );
で定義 呼び出しシグネチャ
(1)
template< std::bidirectional_iterator I, std::sentinel_for<I> S,
          class T = std::iter_value_t<I>,
          /* indirectly-binary-right-foldable */<T, I> F >
constexpr auto fold_right( I first, S last, T init, F f );
(C++23 から)
template< ranges::bidirectional_range R, class T,
          /* indirectly-binary-right-foldable */
              <T, ranges::iterator_t<R>> F >
constexpr auto fold_right( R&& r, T init, F f );
(C++26 まで) (C++26 から)
(2)
template< ranges::bidirectional_range R, class T = ranges::range_value_t<R>,
          /* indirectly-binary-right-foldable */
              <T, ranges::iterator_t<R>> F >
constexpr auto fold_right( R&& r, T init, F f );
(C++23 から)
(C++26 まで)
template< class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* see description */;
(C++26 から) ヘルパーコンセプト (3) (
template< class F, class T, class I >
concept /* indirectly-binary-right-foldable */ = /* see description */;
説明専用* ) (4) (

説明専用*)指定された範囲の要素を右
f(x1, f(x2, ...f(xn, init)))畳み込みx1します。つまり、次の連鎖式の評価結果を返します:x2、ここで xn、

、...、ranges::fold_right は範囲の要素です。 ranges::fold_left(views::reverse(r), init, /*flipped*/(f))非形式的には、

は [first, last) のように動作します。

が有効な範囲でない場合、動作は未定義です。 [first, last)1)
範囲は です。2) (1) と同じですが、r を範囲として使用し、ranges::begin(r) を first として、ranges::end(r) を last として使用するのと同様です。
3) 以下と等価:
ヘルパーコンセプト
template< class F, class T, class I, class U >
concept /*indirectly-binary-left-foldable-impl*/ =
    std::movable<T> &&
    std::movable<U> &&
    std::convertible_to<T, U> &&
    std::invocable<F&, U, std::iter_reference_t<I>> &&
    std::assignable_from<U&,
        std::invoke_result_t<F&, U, std::iter_reference_t<I>>>;
(3A) (説明専用*)
template< class F, class T, class I >
concept /*indirectly-binary-left-foldable*/ =
    std::copy_constructible<F> &&
    std::indirectly_readable<I> &&
    std::invocable<F&, T, std::iter_reference_t<I>> &&
    std::convertible_to<std::invoke_result_t<F&, T, std::iter_reference_t<I>>,
        std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>> &&
    /*indirectly-binary-left-foldable-impl*/<F, T, I,
        std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>>>;
(3B) (説明専用*)
4) 以下と等価:
ヘルパーコンセプト
template< class F, class T, class I >
concept /*indirectly-binary-right-foldable*/ =
    /*indirectly-binary-left-foldable*/</*flipped*/<F>, T, I>;
(4A) (説明専用*)
ヘルパークラステンプレート
template< class F >
class /*flipped*/
{
    F f;    // exposition only
public:
    template< class T, class U >
        requires std::invocable<F&, U, T>
    std::invoke_result_t<F&, U, T> operator()( T&&, U&& );
};
(4B) (説明専用*)

このページで説明する関数のようなエンティティは アルゴリズム関数オブジェクト (通称 niebloid) です。つまり:

パラメータ

first, last - 畳み込みを行う要素の 範囲 を定義するイテレータ-センチネルペア
r - 畳み込みを行う要素の範囲
init - 畳み込みの初期値
f - 二項関数オブジェクト

戻り値

指定された範囲を f で右 畳み込み した結果を保持する型 U のオブジェクト。ここで U は std:: decay_t < std:: invoke_result_t < F & , std:: iter_reference_t < I > , T >> ; と等価です。

範囲が空の場合、 U ( std :: move ( init ) ) が返されます。

実装例

struct fold_right_fn
{
    template<std::bidirectional_iterator I, std::sentinel_for<I> S,
             class T = std::iter_value_t<I>,
             /* 間接的に二項右畳み込み可能 */<T, I> F>
    constexpr auto operator()(I first, S last, T init, F f) const
    {
        using U = std::decay_t<std::invoke_result_t<F&, std::iter_reference_t<I>, T>>;
        if (first == last)
            return U(std::move(init));
        I tail = ranges::next(first, last);
        U accum = std::invoke(f, *--tail, std::move(init));
        while (first != tail)
            accum = std::invoke(f, *--tail, std::move(accum));
        return accum;
    }
    template<ranges::bidirectional_range R, class T = ranges::range_value_t<R>,
             /* 間接的に二項右畳み込み可能 */<T, ranges::iterator_t<R>> F>
    constexpr auto operator()(R&& r, T init, F f) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::move(init), std::ref(f));
    }
};
inline constexpr fold_right_fn fold_right;

計算量

正確に ranges:: distance ( first, last ) 回、関数オブジェクト f を適用します。

注記

以下の表は、すべての制約付き折りたたみアルゴリズムを比較したものです:

畳み込み関数テンプレート 開始方向 初期値 戻り値の型
ranges:: fold_left 左 init U
ranges:: fold_left_first 左 最初の要素 std:: optional < U >
ranges :: fold_right 右 init U
ranges:: fold_right_last 右 最後の要素 std:: optional < U >
ranges:: fold_left_with_iter 左 init

(1) ranges:: in_value_result < I, U >

(2) ranges:: in_value_result < BR, U > ,

ここで BR は ranges:: borrowed_iterator_t < R >

ranges:: fold_left_first_with_iter 左 最初の要素

(1) ranges:: in_value_result < I, std:: optional < U >>

(2) ranges:: in_value_result < BR, std:: optional < U >>

ここで BR は ranges:: borrowed_iterator_t < R >

機能テスト マクロ 値 標準 機能
__cpp_lib_ranges_fold 202207L (C++23) std::ranges foldアルゴリズム
__cpp_lib_algorithm_default_value_type 202403L (C++26) リスト初期化 アルゴリズム用 ( 1,2 )

例

#include <algorithm>
#include <complex>
#include <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
using namespace std::literals;
namespace ranges = std::ranges;
int main()
{
    auto v = {1, 2, 3, 4, 5, 6, 7, 8};
    std::vector<std::string> vs{"A", "B", "C", "D"};
    auto r1 = ranges::fold_right(v.begin(), v.end(), 6, std::plus<>()); // (1)
    std::cout << "r1: " << r1 << '\n';
    auto r2 = ranges::fold_right(vs, "!"s, std::plus<>()); // (2)
    std::cout << "r2: " << r2 << '\n';
    // プログラム定義の関数オブジェクト(ラムダ式)を使用:
    std::string r3 = ranges::fold_right
    (
        v, "A", [](int x, std::string s) { return s + ':' + std::to_string(x); }
    );
    std::cout << "r3: " << r3 << '\n';
    // ベクター内のすべてのペアのstd::pair::secondの積を取得:
    std::vector<std::pair<char, float>> data{{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    float r4 = ranges::fold_right
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "r4: " << r4 << '\n';
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 0}, {3, 0}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto r5 = ranges::fold_right(nums, {7, 0}, std::multiplies{});
    #else
        auto r5 = ranges::fold_right(nums, CD{7, 0}, std::multiplies{});
    #endif
    std::cout << "r5: " << r5 << '\n';
}

出力:

r1: 42
r2: ABCD!
r3: A:8:7:6:5:4:3:2:1
r4: 42
r5: (42,42)

参考文献

  • C++23標準 (ISO/IEC 14882:2024):
  • 27.6.18 畳み込み [alg.fold]

関連項目

要素の範囲を右畳み込みし、最後の要素を初期値として使用する
(アルゴリズム関数オブジェクト)
要素の範囲を左畳み込みする
(アルゴリズム関数オブジェクト)
要素の範囲を左畳み込みし、最初の要素を初期値として使用する
(アルゴリズム関数オブジェクト)
要素の範囲を左畳み込みし、 pair (イテレータ, 値) を返す
(アルゴリズム関数オブジェクト)
要素の範囲を左畳み込みし、最初の要素を初期値として使用し、 pair (イテレータ, optional ) を返す
(アルゴリズム関数オブジェクト)
要素の範囲を合計または畳み込む
(関数テンプレート)
(C++17)
std::accumulate と類似しているが、順序不同
(関数テンプレート)