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
Определено в заголовке <algorithm>
Сигнатура вызова
(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 ) ;
(начиная с C++23)
(до 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 ) ;
(начиная с 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 ) ;
(начиная с C++23)
(до 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 ) ;
(начиная с C++26)
Вспомогательные концепты
template < class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* см. описание */ ;
(3) ( только для демонстрации* )

Сворачивает элементы заданного диапазона слева, то есть возвращает результат вычисления цепочки выражений:
f(f(f(f(init, x 1 ), x 2 ), ...), x n ) , где x 1 , x 2 , ..., x n являются элементами диапазона.

Неформально говоря, ranges::fold_left ведёт себя подобно перегрузке std::accumulate , принимающей бинарный предикат.

Поведение не определено, если [ first , last ) не является корректным диапазоном.

1) Диапазон [ first , last ) . Эквивалентно return ranges:: fold_left_with_iter ( std :: move ( first ) , last, std :: move ( init ) , f ) . value .
2) То же, что и (1) , за исключением того, что использует r в качестве диапазона, как если бы использовались ranges:: begin ( r ) в качестве first и ranges:: end ( r ) в качестве last .
3) Эквивалентно:
Вспомогательные концепты
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) ( только для демонстрации* )
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) ( только для демонстрации* )

Функциональные сущности, описанные на этой странице, являются алгоритмическими функциональными объектами (неформально известными как niebloids ), то есть:

Содержание

Параметры

first, last - пара итератор-страж, определяющая диапазон элементов для свертки
r - диапазон элементов для свертки
init - начальное значение свертки
f - бинарный функциональный объект

Возвращаемое значение

Объект типа U , содержащий результат левого свертывания заданного диапазона с помощью f , где U эквивалентен std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> .

Если диапазон пуст, U ( std :: move ( init ) ) возвращается.

Возможные реализации

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;
**Примечание:** Весь код C++ внутри тегов `
` и `` оставлен без изменений, как и требовалось. HTML-теги и атрибуты также сохранены в оригинальном виде.

Сложность

Ровно ranges:: distance ( first, last ) применений функционального объекта f .

Примечания

В следующей таблице представлено сравнение всех алгоритмов ограниченного фолдинга:

Шаблон функции свертки Начинается с Начальное значение Тип возвращаемого значения
ranges :: fold_left слева init U
ranges:: fold_left_first слева первого элемента std:: optional < U >
ranges:: fold_right справа init U
ranges:: fold_right_last справа последнего элемента std:: optional < U >
ranges:: fold_left_with_iter слева init

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

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

где BR это ranges:: borrowed_iterator_t < R >

ranges:: fold_left_first_with_iter слева первого элемента

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

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

где BR это ranges:: borrowed_iterator_t < R >

Макрос тестирования возможностей Значение Стандарт Функция
__cpp_lib_ranges_fold 202207L (C++23) std::ranges алгоритмы свёртки
__cpp_lib_algorithm_default_value_type 202403L (C++26) Списковая инициализация для алгоритмов ( 1,2 )

Пример

#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';
    // получить произведение std::pair::second всех пар в векторе:
    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';
    // использовать програмно-определенный функциональный объект (лямбда-выражение):
    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';
}

Вывод:

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

Ссылки

  • Стандарт C++23 (ISO/IEC 14882:2024):
  • 27.6.18 Свёртка [alg.fold]

Смотрите также

выполняет левую свертку диапазона элементов, используя первый элемент в качестве начального значения
(объект-функция алгоритма)
выполняет правую свертку диапазона элементов
(объект-функция алгоритма)
выполняет правую свертку диапазона элементов, используя последний элемент в качестве начального значения
(объект-функция алгоритма)
выполняет левую свертку диапазона элементов и возвращает pair (итератор, значение)
(объект-функция алгоритма)
выполняет левую свертку диапазона элементов, используя первый элемент в качестве начального значения, и возвращает pair (итератор, optional )
(объект-функция алгоритма)
суммирует или сворачивает диапазон элементов
(шаблон функции)
(C++17)
аналогично std::accumulate , но без сохранения порядка
(шаблон функции)