Spec-Zone.ru › C++

std::accumulate

Определён в заголовочном файле <numeric>
template< class InputIt, class T >
T accumulate( InputIt first, InputIt last, T init );
(1) (constexpr начиная с C++20)
template< class InputIt, class T, class BinaryOp >
T accumulate( InputIt first, InputIt last, T init, BinaryOp op );
(2) (constexpr начиная с 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) по порядку.

Если выполняется любое из следующих условий, поведение не определено:

  • T не удовлетворяет требованиям CopyConstructible.
  • T не удовлетворяет требованиям CopyAssignable.
  • op изменяет какой-либо элемент [first, last).
  • op делает недействительным любой итератор или поддиапазон в [first, last].

Параметры

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

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

Retfun(constType1&a,constType2&b);

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

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

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

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 не мог иметь побочных эффектов он не может изменять задействованные диапазоны

См. также

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/cpp/algorithm/accumulate

Spec-Zone.ru

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