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
Definiert in Header <algorithm>
Aufrufsignatur
(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 ) ;
(seit C++23)
(bis 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 ) ;
(seit 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 ) ;
(seit C++23)
(bis 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 ) ;
(seit C++26)
Hilfskonzepte
template < class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* siehe Beschreibung */ ;
(3) ( nur zur Darstellung* )

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

Informell verhält sich ranges::fold_left 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 ) . Entspricht return ranges:: fold_left_with_iter ( std :: move ( first ) , last, std :: move ( init ) , f ) . value .
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* )

Die auf dieser Seite beschriebenen funktionsähnlichen Entitäten sind Algorithm Function Objects (informell bekannt als Niebloids ), das heißt:

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

Ein Objekt vom Typ U , das das Ergebnis der Links- Faltung des gegebenen Bereichs über f enthält, wobei U äquivalent zu std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> ist.

Wenn der Bereich leer ist, U ( std :: move ( init ) ) wird zurückgegeben.

Mögliche Implementierungen

struct fold_left_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>,
             /* indirekt-links-faltbar */<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>,
             /* indirekt-links-faltbar */<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;

Komplexität

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

Hinweise

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

Faltfunktions-Template 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 Feature
__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

#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';
    // Berechne das Produkt der std::pair::second aller Paare im Vektor:
    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';
    // Verwende ein programmdefiniertes Funktionsobjekt (Lambda-Ausdruck):
    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';
}

Ausgabe:

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

Referenzen

  • C++23-Standard (ISO/IEC 14882:2024):
  • 27.6.18 Fold [alg.fold]

Siehe auch

Faltet eine Reihe von Elementen linksseitig unter Verwendung des ersten Elements als Anfangswert
(Algorithmus-Funktionsobjekt)
Faltet eine Reihe von Elementen rechtsseitig
(Algorithmus-Funktionsobjekt)
Faltet eine Reihe von Elementen rechtsseitig unter Verwendung des letzten Elements als Anfangswert
(Algorithmus-Funktionsobjekt)
Faltet eine Reihe von Elementen linksseitig und gibt ein Paar (Iterator, Wert) zurück
(Algorithmus-Funktionsobjekt)
Faltet eine Reihe von Elementen linksseitig unter Verwendung des ersten Elements als Anfangswert und gibt ein Paar (Iterator, optional ) zurück
(Algorithmus-Funktionsobjekt)
Summiert oder faltet eine Reihe von Elementen
(Funktions-Template)
(C++17)
Ähnlich wie std::accumulate , jedoch außerhalb der Reihenfolge
(Funktions-Template)