Spec-Zone.ru › C++

std::accumulate

Defined in header <numeric>
(1)
template< class InputIt, class T >
T accumulate( InputIt first, InputIt last, T init );
(до C++20)
template< class InputIt, class T >
constexpr T accumulate( InputIt first, InputIt last, T init );
(с C++20)
(2)
template< class InputIt, class T, class BinaryOperation >
T accumulate( InputIt first, InputIt last, T init,
              BinaryOperation op );
(до C++20)
template< class InputIt, class T, class BinaryOperation >
constexpr T accumulate( InputIt first, InputIt last, T init,
                        BinaryOperation op );
(с C++20)

Вычисляет сумму заданного значения init и элементов в диапазоне [first, last).

1) Инициализирует накопитель acc (типа T) начальным значением init и затем изменяет его с помощью acc = acc + *i(до C++20)acc = std::move(acc) + *i(с C++20) для каждого итератора i в диапазоне [first, last) в порядке следования.
2) Инициализирует накопитель acc (типа T) начальным значением init и затем изменяет его с помощью acc = op(acc, *i)(до C++20)acc = op(std::move(acc), *i)(с C++20) для каждого итератора i в диапазоне [first, last) в порядке следования.
Если op делает какие-либо итераторы недействительными (включая конечные итераторы) или изменяет какие-либо элементы в участвующем диапазоне, поведение не определено.

Параметры

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

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

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

Подпись не должна содержать const &.
Тип Type1 должен быть таким, чтобы объект типа T мог быть неявно преобразован к Type1. Тип Type2 должен быть таким, чтобы объект типа InputIt мог быть обращён и неявно преобразован в Type2. Тип Ret должен быть таким, чтобы объекту типа T можно было присвоить значение типа Ret.

Требования к типу
-InputIt должен удовлетворять требованиям LegacyInputIterator.
-T должен удовлетворять требованиям CopyAssignable и CopyConstructible.

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

acc после всех изменений.

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

accumulate (1)
template<class InputIt, class T>
constexpr // since C++20
T accumulate(InputIt first, InputIt last, T init)
{
    for (; first != last; ++first)
        init = std::move(init) + *first; // std::move since C++20
 
    return init;
}
accumulate (2)
template<class InputIt, class T, class BinaryOperation>
constexpr // since C++20
T accumulate(InputIt first, InputIt last, T init, BinaryOperation op)
{
    for (; first != last; ++first)
        init = op(std::move(init), *first); // std::move since C++20
 
    return init;
}

Примечания

std::accumulate выполняет левое складывание. Для выполнения правого складывания необходимо изменить порядок аргументов бинарной операции и использовать обратные итераторы.

Распространённые ошибки

Если оставить тип для вывода, op работает со значениями того же типа, что и init, что может привести к нежелательному преобразованию элементов итератора. Например, std::accumulate(v.begin(), v.end(), 0), вероятно, не даст желаемого результата, когда v имеет тип std::vector<double>.

Пример

#include <functional>
#include <iostream>
#include <numeric>
#include <string>
#include <vector>
 
int main()
{
    std::vector<int> v {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
 
    int sum = std::accumulate(v.begin(), v.end(), 0);
    int product = std::accumulate(v.begin(), v.end(), 1, std::multiplies<int>());
 
    auto dash_fold = [](std::string a, int b)
    {
        return std::move(a) + '-' + std::to_string(b);
    };
 
    std::string s = std::accumulate(std::next(v.begin()), v.end(),
                                    std::to_string(v[0]), // start with first element
                                    dash_fold);
 
    // Right fold using reverse iterators
    std::string rs = std::accumulate(std::next(v.rbegin()), v.rend(),
                                     std::to_string(v.back()), // start with last element
                                     dash_fold);
 
    std::cout << "sum: " << sum << '\n'
              << "product: " << product << '\n'
              << "dash-separated string: " << s << '\n'
              << "dash-separated string (right-folded): " << rs << '\n';
}

Вывод:

sum: 55
product: 3628800
dash-separated string: 1-2-3-4-5-6-7-8-9-10
dash-separated string (right-folded): 10-9-8-7-6-5-4-3-2-1

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

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

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

См. также

adjacent_difference
вычисляет разности между смежными элементами в диапазоне
(шаблон функции)
inner_product
вычисляет скалярное произведение двух диапазонов элементов
(шаблон функции)
partial_sum
вычисляет частичную сумму диапазона элементов
(шаблон функции)
reduce
(C++17)
аналогично std::accumulate, за исключением порядка
(шаблон функции)
ranges::fold_left
(C++23)
левое складывание диапазона элементов
(неблочный)

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

Spec-Zone.ru

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