Namespaces
Variants

std::ranges::fold_left

Von de.cppreference.net
 
 
Algorithmenbibliothek
Eingeschränkte Algorithmen und Algorithmen auf Bereichen (C++20)
Eingeschränkte Algorithmen, z.B. ranges::copy, ranges::sort, ...
Nicht modifizierende Sequenzoperationen    
Batch-Operationen
(C++17)
Suchoperationen
Modifizierende Sequenzoperationen
Kopieroperationen
(C++11)
(C++11)
Tauschoperationen
Transformationsoperationen
Generierungsoperationen
Entfernungsoperationen
Reihenfolgeänderungsoperationen
(bis C++17)(C++11)
(C++20)(C++20)
Stichprobenoperationen
(C++17)

Sortier- und verwandte Operationen
Partitionierungsoperationen
(C++11)    

Sortieroperationen
Binäre Suchoperationen
(auf partitionierten Bereichen)
Mengenoperationen (auf sortierten Bereichen)
Mischoperationen (auf sortierten Bereichen)
Heap-Operationen
Minimum-/Maximumoperationen
(C++11)
(C++17)
Lexikografische Vergleichsoperationen
Permutationsoperationen


 
Eingeschränkte Algorithmen
Alle Namen in diesem Menü gehören zum Namensraum std::ranges
Nicht modifizierende Sequenzoperationen
Modifizierende Sequenzoperationen
Partitionierungsoperationen
Sortieroperationen
Binäre Suchoperationen (auf sortierten Bereichen)
       
       
Mengenoperationen (auf sortierten Bereichen)
Heap-Operationen
Minimum-/Maximumoperationen
       
       
Permutationsoperationen
Faltungsoperationen
Operationen auf nicht initialisiertem Speicher
Rückgabetypen
 
Definiert in Header <algorithm>
Aufrufsignatur
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 );
(1) (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)
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 );
(2) (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 */ = /* see description */;
(3) (nur zur Darstellung*)

Links-faltet die Elemente des angegebenen Bereichs, d.h. gibt das Ergebnis der Auswertung des Kettenausdrucks zurück:
f(f(f(f(init, x1), x2), ...), xn), wobei x1, x2, ..., xn Elemente des Bereichs sind.

Informell gesehen ranges::fold_left verhält sich wie std::accumulate's Überladung, die ein binäres Prädikat akzeptiert.

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

1) Der Bereich ist [first, last). Äquivalent zu return ranges::fold_left_with_iter(std::move(first), last, std::move(init), f).value.
2) Genauso wie (1), außer dass r als Bereich verwendet wird, als ob ranges::begin(r) als first und ranges::end(r) als last.
3) Äquivalent zu:
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 Algorithmus-Funktionsobjekte (informell bekannt als Niebloids), das heißt:

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, wobei U äquivalent zu std::decay_t<std::invoke_result_t<F&, T, std::iter_reference_t<I>>> ist.

Wenn der Bereich leer ist, wird U(std::move(init)) 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>,
             /* indirectly-binary-left-foldable */<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>,
             /* indirectly-binary-left-foldable */<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.

Anmerkungen

Die folgende Tabelle vergleicht alle eingeschränkten Faltungsalgorithmen:

Faltungsfunktionsvorlage Beginnt 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 Faltungsalgorithmen
__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';
    
    // get the product of the std::pair::second of all pairs in the vector:
    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';
    
    // use a program defined function object (lambda-expression):
    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 einen Bereich von Elementen von links unter Verwendung des ersten Elements als Anfangswert
(Algorithmus-Funktionsobjekt)
faltet einen Bereich von Elementen von rechts
(Algorithmus-Funktionsobjekt)
faltet einen Bereich von Elementen von rechts unter Verwendung des letzten Elements als Anfangswert
(Algorithmus-Funktionsobjekt)
faltet einen Bereich von Elementen von links und gibt ein pair (iterator, value) zurück
(Algorithmus-Funktionsobjekt)
faltet einen Bereich von Elementen von links unter Verwendung des ersten Elements als Anfangswert und gibt ein pair (iterator, optional) zurück
(Algorithmus-Funktionsobjekt)
summiert oder faltet einen Bereich von Elementen
(Funktionsvorlage)
(C++17)
ähnlich wie std::accumulate, aber in beliebiger Reihenfolge
(Funktionsvorlage)