std::inclusive_scan

template< class InputIt, class OutputIt >
OutputIt inclusive_scan( InputIt first, InputIt last,
                         OutputIt d_first );

template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2 >
ForwardIt2 inclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,
                           ForwardIt2 d_first );

template< class InputIt, class OutputIt, class BinaryOp >
OutputIt inclusive_scan( InputIt first, InputIt last,
                         OutputIt d_first, BinaryOp op );

template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2, class BinaryOp >
ForwardIt2 inclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,
                           ForwardIt2 d_first, BinaryOp op );

template< class InputIt, class OutputIt,
          class BinaryOp, class T >
OutputIt inclusive_scan( InputIt first, InputIt last,
                         OutputIt d_first, BinaryOp op, T init );

template< class ExecutionPolicy,
          class ForwardIt1, class ForwardIt2,
          class BinaryOp, class T >
ForwardIt2 inclusive_scan( ExecutionPolicy&& policy,
                           ForwardIt1 first, ForwardIt1 last,
                           ForwardIt2 d_first, BinaryOp op, T init );

La suma generalizada no conmutativa de una secuencia de elementos sobre una operación binaria binary_op se define de la siguiente manera:

• Si la secuencia solo tiene un elemento, la suma es el valor del elemento.
• En caso contrario, realiza las siguientes operaciones en orden:

1. Selecciona dos elementos adyacentes cualesquiera elem1 y elem2 de la secuencia.
2. Calcula binary_op(elem1, elem2) y reemplaza los dos elementos en la secuencia con el resultado.
3. Repite los pasos 1 y 2 hasta que solo quede un elemento en la secuencia.

Dado binary_op como la operación binaria real:

• El resultado es no determinista si binary_op no es asociativa (como la suma de punto flotante).

• Para las sobrecargas (1-4), si binary_op(*first, *first) no es convertible al tipo de valor de decltype(first), el programa está mal formado.

• Para las sobrecargas (5,6), si alguno de los siguientes valores no es convertible a T, el programa está mal formado:

• binary_op(init, *first)
• binary_op(init, init)
• binary_op(*first, *first)

• Si se cumple alguna de las siguientes condiciones, el comportamiento no está definido:

• Para las sobrecargas (1-4), el tipo de valor de decltype(first) no es MoveConstructible.
• Para las sobrecargas (5,6), T no es MoveConstructible.
• binary_op modifica cualquier elemento de [first, last).
• binary_op invalida cualquier iterador o subrango de [first, last].

Parámetros

Valor de retorno

Iterador al elemento después del último elemento escrito.

Complejidad

Dado \(\scriptsize N\)N como std::distance(first, last):

Excepciones

Las sobrecargas con un parámetro de plantilla llamado ExecutionPolicy reportan errores de la siguiente manera:

• Si la ejecución de una función invocada como parte del algoritmo lanza una excepción y ExecutionPolicy es una de las políticas estándar, se llama a std::terminate. Para cualquier otro ExecutionPolicy, el comportamiento está definido por la implementación.
• Si el algoritmo falla al asignar memoria, se lanza std::bad_alloc.

Ejemplo

#include <functional>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>

int main()
{
    std::vector data{3, 1, 4, 1, 5, 9, 2, 6};
    
    std::cout << "Exclusive sum: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        0);
    
    std::cout << "\nInclusive sum: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "));
    
    std::cout << "\n\nExclusive product: ";
    std::exclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        1, std::multiplies<>{});
    
    std::cout << "\nInclusive product: ";
    std::inclusive_scan(data.begin(), data.end(),
                        std::ostream_iterator<int>(std::cout, " "),
                        std::multiplies<>{});
}

Exclusive sum: 0 3 4 8 9 14 23 25
Inclusive sum: 3 4 8 9 14 23 25 31

Exclusive product: 1 3 3 12 12 60 540 1080
Inclusive product: 3 3 12 12 60 540 1080 6480

Véase también