std::ranges::fold_left

template< std::input_iterator I, std::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 );

template< std::input_iterator I, std::sentinel_for<I> S,
          class T = std::iter_value_t<I>,
          /* indirectly-binary-left-foldable */<T, I> F >
constexpr auto fold_left( I first, S last, T init, F f );

template< ranges::input_range R, class T,
          /* indirectly-binary-left-foldable */
              <T, ranges::iterator_t<R>> F >
constexpr auto fold_left( R&& r, T init, F f );

template< ranges::input_range R, class T = ranges::range_value_t<R>,
          /* indirectly-binary-left-foldable */
              <T, ranges::iterator_t<R>> F >
constexpr auto fold_left( R&& r, T init, F f );

template< class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* see description */;

Pliage à gauche (left-fold) des éléments d'un range donné, c'est-à-dire retourne le résultat de l'évaluation de l'expression en chaîne :
f(f(f(f(init, x1), x2), ...), xn), où x1, x2, ..., xn sont les éléments du range.

Informellement, ranges::fold_left se comporte comme la surcharge de std::accumulate qui accepte un prédicat binaire.

Le comportement est indéfini si [first, last) n'est pas un range valide.

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

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

Les entités de type fonction décrites sur cette page sont des objets fonctions d'algorithme (informellement connus sous le nom de niebloids), c'est-à-dire :

• Les listes explicites d'arguments template ne peuvent pas être spécifiées lors de l'appel de l'un d'eux.
• Aucun d'entre eux n'est visible par recherche dépendante des arguments.
• Lorsque l'un d'eux est trouvé par recherche normale non qualifiée comme nom à gauche de l'opérateur d'appel de fonction, la recherche dépendante des arguments est inhibée.

Paramètres

Valeur de retour

Un objet de type U qui contient le résultat du pliage gauche de la plage donnée sur f , où U est équivalent à std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> .

Si la plage est vide, U ( std :: move ( init ) ) est retourné.

Implémentations possibles

struct fold_left_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>,
             /* indirectement-pliable-binaire-gauche */<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&, T, std::iter_reference_t<I>>>;
        if (first == last)
            return U(std::move(init));
        U accum = std::invoke(f, std::move(init), *first);
        for (++first; first != last; ++first)
            accum = std::invoke(f, std::move(accum), *first);
        return std::move(accum);
    }
    template<ranges::input_range R, class T = ranges::range_value_t<R>,
             /* indirectement-pliable-binaire-gauche */<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_left_fn fold_left;

Complexité

Exactement ranges:: distance ( first, last ) applications de l'objet fonction f .

Notes

Le tableau suivant compare tous les algorithmes de pliage contraint :

Exemple

#include <algorithm>
#include <complex>
#include <functional>
#include <iostream>
#include <ranges>
#include <string>
#include <utility>
#include <vector>
int main()
{
    namespace ranges = std::ranges;
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
    int sum = ranges::fold_left(v.begin(), v.end(), 0, std::plus<int>()); // (1)
    std::cout << "sum: " << sum << '\n';
    int mul = ranges::fold_left(v, 1, std::multiplies<int>()); // (2)
    std::cout << "mul: " << mul << '\n';
    // obtenir le produit des std::pair::second de toutes les paires dans le vecteur :
    std::vector<std::pair<char, float>> data {{'A', 2.f}, {'B', 3.f}, {'C', 3.5f}};
    float sec = ranges::fold_left
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    std::cout << "sec: " << sec << '\n';
    // utiliser un objet fonction défini par programme (expression lambda) :
    std::string str = ranges::fold_left
    (
        v, "A", [](std::string s, int x) { return s + ':' + std::to_string(x); }
    );
    std::cout << "str: " << str << '\n';
    using CD = std::complex<double>;
    std::vector<CD> nums{{1, 1}, {2, 0}, {3, 0}};
    #ifdef __cpp_lib_algorithm_default_value_type
        auto res = ranges::fold_left(nums, {7, 0}, std::multiplies{}); // (2)
    #else
        auto res = ranges::fold_left(nums, CD{7, 0}, std::multiplies{}); // (2)
    #endif
    std::cout << "res: " << res << '\n';
}

sum: 36
mul: 40320
sec: 42
str: A:1:2:3:4:5:6:7:8
res: (42,42)

Références

Voir aussi