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 );

Обобщённая некоммутативная сумма последовательности элементов относительно бинарной операции binary_op определяется следующим образом:

• Если последовательность содержит только один элемент, сумма равна значению этого элемента.
• В противном случае последовательно выполняются следующие операции:

1. Выбираются любые два соседних элемента elem1 и elem2 из последовательности.
2. Вычисляется binary_op(elem1, elem2), а два элемента в последовательности заменяются результатом.
3. Шаги 1 и 2 повторяются, пока в последовательности не останется только один элемент.

Пусть binary_op — фактическая бинарная операция:

• Результат недетерминирован, если binary_op не является ассоциативной (например, сложение чисел с плавающей точкой).
• Для перегрузок (1-4), если binary_op(*first, *first) не преобразуется к типу значения выражения decltype(first), программа некорректна.
• Для перегрузок (5,6), если какое-либо из следующих значений не преобразуется к T, программа некорректна:
• binary_op(init, *first)
• binary_op(init, init)
• binary_op(*first, *first)
• Поведение не определено, если выполняется любое из следующих условий:
• Для перегрузок (1-4) тип значения выражения decltype(first) не удовлетворяет требованиям MoveConstructible.
• Для перегрузок (5,6) T не удовлетворяет требованиям MoveConstructible.
• binary_op изменяет любой элемент [first, last).
• binary_op делает недействительным любой итератор или поддиапазон [first, last].

Параметры

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

Итератор на элемент, следующий за последним записанным элементом.

Сложность

Пусть \(\scriptsize N\)N — это std::distance(first, last):

Исключения

Перегрузки с параметром шаблона с именем ExecutionPolicy сообщают об ошибках следующим образом:

• Если при выполнении функции, вызванной в рамках алгоритма, возникает исключение и ExecutionPolicy является одной из стандартных политик, вызывается std::terminate. Для любого другого ExecutionPolicy поведение определяется реализацией.
• Если алгоритму не удаётся выделить память, генерируется std::bad_alloc.

Пример

#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

См. также