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

From cppreference.net

Definiert im Header `<algorithm>`
Aufrufsignatur
	(1)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T, /* indirekt-links-faltbar / < T, I > F > constexpr / siehe Beschreibung */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(seit C++23) (bis C++26)
template < std:: input_iterator I, std:: sentinel_for < I > S, class T = std:: iter_value_t < I > , /* indirekt-links-faltbar / < T, I > F > constexpr / siehe Beschreibung */ fold_left_with_iter ( I first, S last, T init, F f ) ;			(seit C++26)
		(2)
template < ranges:: input_range R, class T, /* indirekt-binär-links-faltbar / < T, ranges:: iterator_t < R >> F > constexpr / siehe Beschreibung */ fold_left_with_iter ( R && r, T init, F f ) ;				(seit C++23) (bis C++26)
template < ranges:: input_range R, class T = ranges:: range_value_t < R > , /* indirekt-binär-links-faltbar / < T, ranges:: iterator_t < R >> F > constexpr / siehe Beschreibung */ fold_left_with_iter ( R && r, T init, F f ) ;				(seit C++26)
Hilfskonzepte
template < class F, class T, class I > concept /* indirectly-binary-left-foldable / = / siehe Beschreibung */ ;			(3)	( Nur zur Darstellung* )
Hilfsklassen-Template
template < class I, class T > using fold_left_with_iter_result = ranges:: in_value_result < I, T > ;			(4)	(seit C++23)

Faltet die Elemente des gegebenen Bereichs von links, gibt also das Ergebnis der Auswertung des Kettenausdrucks zurück:
f(f(f(f(init, x ₁ ), x ₂ ), ...), x _n ) , wobei x ₁ , x ₂ , ..., x _n die Elemente des Bereichs sind.

Informell verhält sich ranges::fold_left_with_iter wie die Überladung von std::accumulate , die ein binäres Prädikat akzeptiert.

Das Verhalten ist undefiniert, falls [ first , last ) kein gültiger Bereich ist.

1) Der Bereich ist

first

last

2) Gleich wie (1) , außer dass r als Bereich verwendet wird, als ob ranges:: begin ( r ) als first und ranges:: end ( r ) als last verwendet würde.

3) Entspricht:

Hilfskonzepte
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)	( Nur zur Darstellung* )
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)	( Nur zur Darstellung* )

4) Der Rückgabetyp-Alias. Siehe Abschnitt " Return value " für Details.

Die auf dieser Seite beschriebenen funktionsähnlichen Entitäten sind algorithm function objects (informell bekannt als niebloids ), das heißt:

Explizite Template-Argumentlisten können beim Aufruf keiner von ihnen angegeben werden.
Keiner von ihnen ist sichtbar für argument-dependent lookup .
Wenn einer von ihnen durch normal unqualified lookup als Name links vom Funktionsaufruf-Operator gefunden wird, wird argument-dependent lookup unterdrückt.

Inhaltsverzeichnis

Parameter

first, last	-	das Iterator-Sentinel-Paar, das den Bereich der zu faltenden Elemente definiert
r	-	der Bereich der zu faltenden Elemente
init	-	der Anfangswert der Faltung
f	-	das binäre Funktionsobjekt

Rückgabewert

Sei U definiert als std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> .

1) Ein Objekt vom Typ ranges :: fold_left_with_iter_result < I, U > .

Das Mitglied ranges :: in_value_result :: in enthält einen Iterator zum Ende des Bereichs.
Das Mitglied ranges :: in_value_result :: value enthält das Ergebnis der Links- Faltung des gegebenen Bereichs über f .

Wenn der Bereich leer ist, wird der Rückgabewert durch einen Ausdruck erhalten, der äquivalent zu return { std :: move ( first ) , U ( std :: move ( init ) ) } ; ist.

2) Gleich wie (1) , außer dass der Rückgabetyp ranges :: fold_left_with_iter_result < ranges:: borrowed_iterator_t < R > , U > ist.

Mögliche Implementierungen

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>,
             /* indirekt-binär-links-faltbar */<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>,
             /* indirekt-binär-links-faltbar */<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;

Komplexität

Genau ranges:: distance ( first, last ) Anwendungen des Funktionsobjekts f .

Hinweise

Die folgende Tabelle vergleicht alle Algorithmen für beschränktes Falten:

Fold-Funktionsvorlage	Startet von	Anfangswert	Rückgabetyp
ranges:: fold_left	links	init	U
ranges:: fold_left_first	links	erstes Element	std:: optional < U >
ranges:: fold_right	rechts	init	U
ranges:: fold_right_last	rechts	letztes Element	std:: optional < U >
ranges :: fold_left_with_iter	links	init	(1) ranges:: in_value_result < I, U > (2) ranges:: in_value_result < BR, U > , wobei BR ist ranges:: borrowed_iterator_t < R >
ranges:: fold_left_first_with_iter	links	erstes Element	(1) ranges:: in_value_result < I, std:: optional < U >> (2) ranges:: in_value_result < BR, std:: optional < U >> wobei BR ist ranges:: borrowed_iterator_t < R >

Feature-Test Makro	Wert	Std	Funktion
`__cpp_lib_ranges_fold`	`202207L`	(C++23)	`std::ranges` Fold-Algorithmen
`__cpp_lib_algorithm_default_value_type`	`202403L`	(C++26)	Listeninitialisierung für Algorithmen ( 1,2 )

Beispiel

Diesen Code ausführen

#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());
    // Produkt der std::pair::second aller Paare im Vektor ermitteln:
    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);
    // Benutzerdefiniertes Funktionsobjekt (Lambda-Ausdruck) verwenden:
    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}));
}

Referenzen

C++23-Standard (ISO/IEC 14882:2024):

27.6.18 Fold [alg.fold]

Siehe auch

ranges::fold_left (C++23)	Faltet eine Reihe von Elementen von links (Algorithmus-Funktionsobjekt)
ranges::fold_left_first (C++23)	Faltet eine Reihe von Elementen von links unter Verwendung des ersten Elements als Anfangswert (Algorithmus-Funktionsobjekt)
ranges::fold_right (C++23)	Faltet eine Reihe von Elementen von rechts (Algorithmus-Funktionsobjekt)
ranges::fold_right_last (C++23)	Faltet eine Reihe von Elementen von rechts unter Verwendung des letzten Elements als Anfangswert (Algorithmus-Funktionsobjekt)
ranges::fold_left_first_with_iter (C++23)	Faltet eine Reihe von Elementen von links unter Verwendung des ersten Elements als Anfangswert und gibt ein pair (Iterator, optional ) zurück (Algorithmus-Funktionsobjekt)
accumulate	Summiert oder faltet eine Reihe von Elementen (Funktions-Template)
reduce (C++17)	Ähnlich wie std::accumulate , jedoch außerhalb der Reihenfolge (Funktions-Template)

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