std::ranges::fold_left
| Определён в заголовке <algorithm>
|
||
| Сигнатура вызова |
||
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) | (начиная с 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) | |
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) | (начиная с 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 */ = /* see description */;
|
(3) | (только для демонстрации*) |
Левосторонне сворачивает элементов заданного диапазона, то есть возвращает результат вычисления цепочки выражений:f(f(f(f(init, x1), x2), ...), xn), где x1, x2, ..., xn — элементы диапазона.
Неформально, ranges::fold_left ведёт себя как std::accumulate перегрузка, принимающая бинарный предикат.
Поведение не определено, если [first, last) не является допустимым диапазоном.
[first, last). Эквивалентно
return ranges::fold_left_with_iter(std::move(first), last, std::move(init), f).value.r в качестве диапазона, как если бы с использованием ranges::begin(r) в качестве first и ranges::end(r) в качестве last.| Вспомогательные концепты |
||
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; |
` и `` оставлен без изменений, как и требовалось. 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]
Смотрите также
|
(C++23)
|
выполняет левую свертку диапазона элементов, используя первый элемент в качестве начального значения
(объект-функция алгоритма) |
|
(C++23)
|
выполняет правую свертку диапазона элементов
(объект-функция алгоритма) |
|
(C++23)
|
выполняет правую свертку диапазона элементов, используя последний элемент в качестве начального значения
(объект-функция алгоритма) |
|
(C++23)
|
выполняет левую свертку диапазона элементов и возвращает
pair
(итератор, значение)
(объект-функция алгоритма) |
|
выполняет левую свертку диапазона элементов, используя первый элемент в качестве начального значения, и возвращает
pair
(итератор,
optional
)
(объект-функция алгоритма) |
|
|
суммирует или сворачивает диапазон элементов
(шаблон функции) |
|
|
(C++17)
|
аналогично
std::accumulate
, но без сохранения порядка
(шаблон функции) |