std::ranges::fold_left
| Definido en el encabezado <algorithm>
|
||
| Firma de llamada |
||
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) | (desde C++23) (hasta 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 );
|
(desde 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) | (desde C++23) (hasta 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 );
|
(desde C++26) | |
| Conceptos auxiliares |
||
template< class F, class T, class I >
concept /* indirectly-binary-left-foldable */ = /* see description */;
|
(3) | (solo para exposición*) |
Realiza un pliegue izquierdo- (pliega) los elementos del rango dado, es decir, devuelve el resultado de la evaluación de la expresión en cadena:f(f(f(f(init, x1), x2), ...), xn), donde x1, x2, ..., xn son elementos del rango.
Informalmente, ranges::fold_leftfold_left se comporta como la sobrecarga de std::accumulate que acepta un predicado binario.
El comportamiento no está definido si [first, last) no es un rango válido.
[first, last). Equivalente a return ranges::fold_left_with_iter(std::move(first), last, std::move(init), f).value.r como rango, como si se usara ranges::begin(r) como first y ranges::end(r) como last.| Conceptos auxiliares |
||
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) | (solo para exposición*) |
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) | (solo para exposición*) |
Las entidades similares a funciones descritas en esta página son objetos función de algoritmo (informalmente conocidos como niebloides), es decir:
- No se pueden especificar listas explícitas de argumentos de plantilla al llamar a ninguno de ellos.
- Ninguno de ellos es visible para la búsqueda dependiente de argumentos.
- Cuando cualquiera de ellos es encontrado por búsqueda normal no calificada como el nombre a la izquierda del operador de llamada a función, la búsqueda dependiente de argumentos se inhibe.
Parámetros
| first, last | - | el par iterador-centinela que define el rango de elementos a plegar |
| r | - | el rango de elementos a plegar |
| init | - | el valor inicial del plegado |
| f | - | el objeto de función binaria |
Valor de retorno
Un objeto de tipo U que contiene el resultado del plegado izquierdo del rango dado sobre f , donde U es equivalente a std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>> .
Si el rango está vacío, U ( std :: move ( init ) ) es retornado.
Posibles implementaciones
struct fold_left_fn { template<std::input_iterator I, std::sentinel_for<I> S, class T = std::iter_value_t<I>, /* indirectamente-binario-plegable-por-la-izquierda */<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>, /* indirectamente-binario-plegable-por-la-izquierda */<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; |
Complejidad
Exactamente ranges:: distance ( first, last ) aplicaciones del objeto función f .
Notas
La siguiente tabla compara todos los algoritmos de plegado restringido:
| Plantilla de función fold | Comienza desde | Valor inicial | Tipo de retorno |
|---|---|---|---|
| ranges :: fold_left | izquierda | init | U |
| ranges:: fold_left_first | izquierda | primer elemento | std:: optional < U > |
| ranges:: fold_right | derecha | init | U |
| ranges:: fold_right_last | derecha | último elemento | std:: optional < U > |
| ranges:: fold_left_with_iter | izquierda | init |
(1) ranges:: in_value_result < I, U > (2) ranges:: in_value_result < BR, U > , donde BR es ranges:: borrowed_iterator_t < R > |
| ranges:: fold_left_first_with_iter | izquierda | primer elemento |
(1) ranges:: in_value_result < I, std:: optional < U >> (2) ranges:: in_value_result < BR, std:: optional < U >> donde BR es ranges:: borrowed_iterator_t < R > |
| Macro de prueba de características | Valor | Estándar | Característica |
|---|---|---|---|
__cpp_lib_ranges_fold
|
202207L
|
(C++23) |
std::ranges
algoritmos de plegado
|
__cpp_lib_algorithm_default_value_type
|
202403L
|
(C++26) | Inicialización de lista para algoritmos ( 1,2 ) |
Ejemplo
#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'; // obtener el producto de std::pair::second de todos los pares en el 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'; // usar un objeto función definido por el programa (expresión lambda): 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'; }
Salida:
sum: 36 mul: 40320 sec: 42 str: A:1:2:3:4:5:6:7:8 res: (42,42)
Referencias
- Estándar C++23 (ISO/IEC 14882:2024):
-
- 27.6.18 Fold [alg.fold]
Véase también
|
(C++23)
|
pliega hacia la izquierda un rango de elementos usando el primer elemento como valor inicial
(objeto función de algoritmo) |
|
(C++23)
|
pliega hacia la derecha un rango de elementos
(objeto función de algoritmo) |
|
(C++23)
|
pliega hacia la derecha un rango de elementos usando el último elemento como valor inicial
(objeto función de algoritmo) |
|
(C++23)
|
pliega hacia la izquierda un rango de elementos, y retorna un
par
(iterador, valor)
(objeto función de algoritmo) |
|
pliega hacia la izquierda un rango de elementos usando el primer elemento como valor inicial, y retorna un
par
(iterador,
optional
)
(objeto función de algoritmo) |
|
|
suma o pliega un rango de elementos
(plantilla de función) |
|
|
(C++17)
|
similar a
std::accumulate
, excepto fuera de orden
(plantilla de función) |