std::ranges:: fold_left_with_iter, std::ranges:: fold_left_with_iter_result

From cppreference.net

Défini dans l'en-tête `<algorithm>`
Signature d'appel
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, /* indirectement-pliable-binaire-gauche / < T, I > F > constexpr / voir description */ fold_left_with_iter ( 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 > , /* indirectement-pliable-binaire-gauche / < T, I > F > constexpr / voir description */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(depuis C++26)
		(2)
template < ranges:: input_range R, class T, /* indirectement-binaire-pliable-à-gauche / < T, ranges:: iterator_t < R >> F > constexpr / voir description */ fold_left_with_iter ( R && r, T init, F f ) ;				(depuis C++23) (jusqu'à C++26)
template < ranges:: input_range R, class T = ranges:: range_value_t < R > , /* indirectement-binaire-pliable-à-gauche / < T, ranges:: iterator_t < R >> F > constexpr / voir description */ fold_left_with_iter ( 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)	( à titre d'illustration seulement )
Modèle de classe auxiliaire
template < class I, class T > using fold_left_with_iter_result = ranges:: in_value_result < I, T > ;			(4)	(depuis C++23)

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 ₁ ), x ₂ ), ...), x _n ) , où x ₁ , x ₂ , ..., x _n sont les éléments de la plage.

Informellement, ranges::fold_left_with_iter 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

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* )

4) L'alias de type de retour. Voir la section " Return value " pour plus de détails.

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

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

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

Soit U le type std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> .

1) Un objet de type ranges :: fold_left_with_iter_result < I, U > .

Le membre ranges :: in_value_result :: in contient un itérateur vers la fin de la plage.
Le membre ranges :: in_value_result :: value contient le résultat du pliage gauche de la plage donnée sur f .

Si la plage est vide, la valeur de retour est obtenue via une expression équivalente à return { std :: move ( first ) , U ( std :: move ( init ) ) } ; .

2) Identique à (1) sauf que le type de retour est ranges :: fold_left_with_iter_result < ranges:: borrowed_iterator_t < R > , U > .

Implémentations possibles

class fold_left_with_iter_fn
{
    template<class O, class I, class S, class T, class F>
    constexpr auto impl(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>>>;
        using Ret = ranges::fold_left_with_iter_result<O, U>;
        if (first == last)
            return Ret{std::move(first), 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 Ret{std::move(first), std::move(accum)};
    }
public:
    template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>,
             /* pliable-binaire-indirectement-à-gauche */<T, I> F>
    constexpr auto operator()(I first, S last, T init, F f) const
    {
        return impl<I>(std::move(first), std::move(last), std::move(init), std::ref(f));
    }
    template<ranges::input_range R, class T = ranges::range_value_t<R>,
             /* pliable-binaire-indirectement-à-gauche */<T, ranges::iterator_t<R>> F>
    constexpr auto operator()(R&& r, T init, F f) const
    {
        return impl<ranges::borrowed_iterator_t<R>>
        (
            ranges::begin(r), ranges::end(r), std::move(init), std::ref(f)
        );
    }
};
inline constexpr fold_left_with_iter_fn fold_left_with_iter;

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 > , où 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 >> où 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 de liste pour les algorithmes ( 1,2 )

Exemple

Exécuter ce code

#include <algorithm>
#include <cassert>
#include <complex>
#include <functional>
#include <ranges>
#include <utility>
#include <vector>
int main()
{
    namespace ranges = std::ranges;
    std::vector v{1, 2, 3, 4, 5, 6, 7, 8};
    auto sum = ranges::fold_left_with_iter(v.begin(), v.end(), 6, std::plus<int>());
    assert(sum.value == 42);
    assert(sum.in == v.end());
    auto mul = ranges::fold_left_with_iter(v, 0X69, std::multiplies<int>());
    assert(mul.value == 4233600);
    assert(mul.in == v.end());
    // 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}};
    auto sec = ranges::fold_left_with_iter
    (
        data | ranges::views::values, 2.0f, std::multiplies<>()
    );
    assert(sec.value == 42);
    // Utiliser un objet fonction défini par le programme (expression lambda) :
    auto lambda = [](int x, int y){ return x + 0B110 + y; };
    auto val = ranges::fold_left_with_iter(v, -42, lambda);
    assert(val.value == 42);
    assert(val.in == v.end());
    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_with_iter(nums, {7, 0}, std::multiplies{});
    #else
        auto res = ranges::fold_left_with_iter(nums, CD{7, 0}, std::multiplies{});
    #endif
    assert((res.value == CD{42, 42}));
}

Références

Norme C++23 (ISO/IEC 14882:2024) :

27.6.18 Fold [alg.fold]

Voir aussi

ranges::fold_left (C++23)	réduit vers la gauche une plage d'éléments (objet fonction algorithme)
ranges::fold_left_first (C++23)	réduit vers la gauche une plage d'éléments en utilisant le premier élément comme valeur initiale (objet fonction algorithme)
ranges::fold_right (C++23)	réduit vers la droite une plage d'éléments (objet fonction algorithme)
ranges::fold_right_last (C++23)	réduit vers la droite une plage d'éléments en utilisant le dernier élément comme valeur initiale (objet fonction algorithme)
ranges::fold_left_first_with_iter (C++23)	réduit vers 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)
accumulate	accumule ou réduit une plage d'éléments (modèle de fonction)
reduce (C++17)	similaire à std::accumulate , mais sans ordre défini (modèle de fonction)

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.net

Namespaces

Variants