Namespaces
Variants

std::ranges:: fold_left

From cppreference.net
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy , ranges::sort , ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
Modifying sequence operations
Copy operations
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17) (C++11)
(C++20) (C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
Constrained algorithms
All names in this menu belong to namespace std::ranges
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations (on sorted ranges)
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Permutation operations
Fold operations
Operations on uninitialized storage
Return types
Défini dans l'en-tête <algorithm>
Signature d'appel
(1)
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 ) ;
(depuis C++23)
(jusqu'à C++26)
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 ) ;
(depuis C++26)
(2)
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 ) ;
(depuis C++23)
(jusqu'à C++26)
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 ) ;
(depuis C++26)
Concepts auxiliaires
template < class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* voir description */ ;
(3) ( exposition uniquement* )

Plie à gauche les éléments de la plage donnée, c'est-à-dire retourne le résultat de l'évaluation de l'expression en chaîne :
f(f(f(f(init, x 1 ), x 2 ), ...), x n ) , où x 1 , x 2 , ..., x n sont les éléments de la plage.

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 une plage valide.

1) La plage est [ first , last ) . Équivalent à return ranges:: fold_left_with_iter ( std :: move ( first ) , last, std :: move ( init ) , f ) . value .
2) Identique à (1) , sauf qu'il utilise r comme plage, comme s'il utilisait ranges:: begin ( r ) comme first et ranges:: end ( r ) comme last .
3) Équivalent à :
Concepts auxiliaires
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) ( exposition uniquement* )
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) ( exposition uniquement* )

Les entités de type fonction décrites sur cette page sont des objets fonction d'algorithmes (informellement appelés niebloids ), c'est-à-dire :

Table des matières

Paramètres

first, last - la paire itérateur-sentinelle définissant l'intervalle des éléments à plier
r - l'intervalle des éléments à plier
init - la valeur initiale du pli
f - l'objet fonction binaire

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 :

Modèle de fonction de pliage Commence par Valeur initiale Type de retour
ranges :: fold_left gauche init U
ranges:: fold_left_first gauche premier élément std:: optional < U >
ranges:: fold_right droite init U
ranges:: fold_right_last droite dernier élément std:: optional < U >
ranges:: fold_left_with_iter gauche init

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

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

BR est ranges:: borrowed_iterator_t < R >

ranges:: fold_left_first_with_iter gauche premier élément

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

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

BR est ranges:: borrowed_iterator_t < R >

Macro de test de fonctionnalité Valeur Std Fonctionnalité
__cpp_lib_ranges_fold 202207L (C++23) std::ranges algorithmes de pliage
__cpp_lib_algorithm_default_value_type 202403L (C++26) Initialisation par liste pour les algorithmes ( 1,2 )

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

Sortie :

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

Références

  • Norme C++23 (ISO/CEI 14882:2024) :
  • 27.6.18 Fold [alg.fold]

Voir aussi

réduit par la gauche une plage d'éléments en utilisant le premier élément comme valeur initiale
(objet fonction algorithme)
réduit par la droite une plage d'éléments
(objet fonction algorithme)
réduit par la droite une plage d'éléments en utilisant le dernier élément comme valeur initiale
(objet fonction algorithme)
réduit par la gauche une plage d'éléments et retourne une paire (itérateur, valeur)
(objet fonction algorithme)
réduit par la gauche une plage d'éléments en utilisant le premier élément comme valeur initiale et retourne une paire (itérateur, optional )
(objet fonction algorithme)
additionne ou réduit une plage d'éléments
(modèle de fonction)
(C++17)
similaire à std::accumulate , sauf sans ordre
(modèle de fonction)