Spec-Zone.ru › C++

std::partial_sum

Определено в заголовке <numeric>
(1)
template< class InputIt, class OutputIt >
OutputIt partial_sum( InputIt first, InputIt last, OutputIt d_first );
(до C++20)
template< class InputIt, class OutputIt >
constexpr OutputIt partial_sum( InputIt first, InputIt last,
                                OutputIt d_first );
(с C++20)
(2)
template< class InputIt, class OutputIt, class BinaryOperation >
OutputIt partial_sum( InputIt first, InputIt last,
                      OutputIt d_first, BinaryOperation op );
(до C++20)
template< class InputIt, class OutputIt, class BinaryOperation >
constexpr OutputIt partial_sum( InputIt first, InputIt last,
                                OutputIt d_first, BinaryOperation op );
(с C++20)

Если [first, last) не пусто, вычисляет частичные суммы элементов в его поддиапазонах и записывает суммы в диапазон, начинающийся с d_first, при этом применяя std::move к своим операндам слева(с C++11).

Внутренне используется переменная acc, тип которой соответствует типу значения InputIt, в качестве аккумулятора для промежуточных результатов.

1) Использует operator+ для суммирования элементов. Эквивалентно:
std::iterator_traits<InputIt>::value_type acc = *first;
*d_first = acc;
 
acc = std::move(acc) + *(first + 1);
*(d_first + 1) = acc;
 
acc = std::move(acc) + *(first + 2);
*(d_first + 2) = acc;
 
acc = std::move(acc) + *(first + 3);
*(d_first + 3) = acc;
// ...
2) Использует заданную бинарную функцию op. Эквивалентно:
std::iterator_traits<InputIt>::value_type acc = *first;
*d_first = acc;
 
acc = op(std::move(acc), *(first + 1));
*(d_first + 1) = acc;
 
acc = op(std::move(acc), *(first + 2));
*(d_first + 2) = acc;
 
acc = op(std::move(acc), *(first + 3));
*(d_first + 3) = acc;
// ...
Если op делает недействительными какие-либо итераторы (включая конечные итераторы) или изменяет любые элементы вовлеченного диапазона, поведение является неопределённым.

Параметры

first, last - диапазон элементов для суммирования
d_first - начало целевого диапазона; может быть равно first
op - бинарный функциональный объект, который будет применяться.

Подпись функции должна быть эквивалентной следующей:

Ret fun(const Type1 &a, const Type2 &b);

Подпись не должна содержать const &.
Тип Type1 должен быть таким, чтобы объект типа std::iterator_traits<InputIt>::value_type можно было неявно преобразовать в Type1. Тип Type2 должен быть таким, чтобы объект типа InputIt можно было дереференсировать, а затем неявно преобразовать в Type2. Тип Ret должен быть таким, чтобы объект типа InputIt можно было дереференсировать и присвоить значение типа Ret. ​

Требования к типу
-InputIt должен соответствовать требованиям LegacyInputIterator. Его тип значения должен быть создаваемым из *first.
-OutputIt должен соответствовать требованиям LegacyOutputIterator. acc (определенный выше) должен быть записываемым в d_first.

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

Итератор на элемент после последнего записанного элемента или d_first если [first, last) пусто.

Сложность

Учитывая N как std::distance(first, last) - 1:

1) ровно N применений operator+
2) ровно N применений бинарной функции op

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

partial_sum (1)
template<class InputIt, class OutputIt>
constexpr // since C++20
OutputIt partial_sum(InputIt first, InputIt last, OutputIt d_first)
{
    if (first == last)
        return d_first;
 
    typename std::iterator_traits<InputIt>::value_type sum = *first;
    *d_first = sum;
 
    while (++first != last)
    {
        sum = std::move(sum) + *first; // std::move since C++11
        *++d_first = sum;
    }
 
    return ++d_first;
 
    // or, since C++14:
    // return std::partial_sum(first, last, d_first, std::plus<>());
}
partial_sum (2)
template<class InputIt, class OutputIt, class BinaryOperation>
constexpr // since C++20
OutputIt partial_sum(InputIt first, InputIt last, 
                     OutputIt d_first, BinaryOperation op)
{
    if (first == last)
        return d_first;
 
    typename std::iterator_traits<InputIt>::value_type acc = *first;
    *d_first = acc;
 
    while (++first != last)
    {
        acc = op(std::move(acc), *first); // std::move since C++11
        *++d_first = acc;
    }
 
    return ++d_first;
}

Примечания

acc был введён из-за решения LWG issue 539. Причина использования acc вместо непосредственного суммирования результатов (т.е. *(d_first + 2) = (*first + *(first + 1)) + *(first + 2);) заключается в том, что семантика последнего является неясной, если типы не совпадают:

  • тип значения InputIt
  • тип(ы) записи OutputIt
  • типы параметров оператора+ или op
  • тип возвращаемого значения оператора+ или op

acc служит промежуточным объектом для хранения и предоставления значений на каждом шаге вычисления:

  • его тип равен типу значения InputIt
  • он записывается в d_first
  • его значение передаётся оператору+ или op
  • он хранит возвращаемое значение оператора+ или op
enum not_int { x = 1, y = 2 };
 
char i_array[4] = {100, 100, 100, 100};
not_int e_array[4] = {x, x, y, y};
int  o_array[4];
 
// OK: uses operator+(char, char) and assigns char values to int array
std::partial_sum(i_array, i_array + 4, o_array);
 
// Error: cannot assign not_int values to int array
std::partial_sum(e_array, e_array + 4, o_array);
 
// OK: performs conversions when needed
// 1. creates `acc` of type char (the value type)
// 2. the char arguments are used for long multiplication (char -> long)
// 3. the long product is assigned to `acc` (long -> char)
// 4. `acc` is assigned to an element of `o_array` (char -> int)
// 5. go back to step 2 to process the remaining elements in the input range
std::partial_sum(i_array, i_array + 4, o_array, std::multiplies<long>{});

Пример

#include <functional>
#include <iostream>
#include <iterator>
#include <numeric>
#include <vector>
 
int main()
{
    std::vector<int> v(10, 2); // v = {2, 2, 2, 2, 2, 2, 2, 2, 2, 2}
 
    std::cout << "The first " << v.size() << " even numbers are: ";
    // write the result to the cout stream
    std::partial_sum(v.cbegin(), v.cend(), 
                     std::ostream_iterator<int>(std::cout, " "));
    std::cout << '\n';
 
    // write the result back to the vector v
    std::partial_sum(v.cbegin(), v.cend(),
                     v.begin(), std::multiplies<int>());
 
    std::cout << "The first " << v.size() << " powers of 2 are: ";
    for (int n : v)
        std::cout << n << ' ';
    std::cout << '\n';
}

Вывод:

The first 10 even numbers are: 2 4 6 8 10 12 14 16 18 20 
The first 10 powers of 2 are: 2 4 8 16 32 64 128 256 512 1024

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR Применено к Поведение при публикации Правильное поведение
LWG 242 C++98 op не мог иметь побочных эффектов не может изменять вовлечённые диапазоны
LWG 539 C++98 не хватало требований к типу для валидных вычислений результатов
и присваиваний
добавлены
LWG 2055
(P0616R0)
C++11 acc не перемещался во время накопления он перемещается

См. также

adjacent_difference
вычисляет разности между смежными элементами в диапазоне
(шаблон функции)
accumulate
суммирует или сворачивает диапазон элементов
(шаблон функции)
inclusive_scan
(C++17)
подобно std::partial_sum, включает i-ый элемент входных данных в i-ую сумму
(шаблон функции)
exclusive_scan
(C++17)
подобно std::partial_sum, исключает i-ый элемент входных данных из i-ой суммы
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/algorithm/partial_sum

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API