std::partial_sum

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

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

Étant donné binary_op comme opération binaire réelle :

• Si l'une des conditions suivantes est satisfaite, le programme est mal formé :

• Le type valeur de InputIt n'est pas constructible à partir de *first.
• acc n'est pas inscriptible dans d_first.
• Le résultat de binary_op(acc, *iter)(jusqu'à C++20)binary_op(std::move(acc), *iter)(depuis C++20) n'est pas implicitement convertible au type valeur de InputIt.

• Étant donné d_last comme l'itérateur à retourner, si l'une des conditions suivantes est satisfaite, le comportement est indéfini :

• binary_op modifie tout élément de [first, last) ou [d_first, d_last).
• binary_op invalide un itérateur ou une sous-plage dans [first, last] ou [d_first, d_last].

Paramètres

Valeur de retour

Itérateur vers l'élément après le dernier élément écrit, ou d_first si [first, last) est vide.

Complexité

Étant donné \(\scriptsize N\)N comme std::distance(first, last) :

Implémentation possible

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++20
        *++d_first = sum;
    }
    
    return ++d_first;
    
    // or, since C++14:
    // return std::partial_sum(first, last, d_first, std::plus<>());
}

template<class InputIt, class OutputIt, class BinaryOp>
constexpr // since C++20
OutputIt partial_sum(InputIt first, InputIt last, 
                     OutputIt d_first, BinaryOp 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++20
        *++d_first = acc;
    }
    
    return ++d_first;
}

Notes

acc a été introduit à cause de la résolution de LWG issue 539. La raison d'utiliser acc plutôt que de sommer directement les résultats (c'est-à-dire *(d_first + 2) = (*first + *(first + 1)) + *(first + 2);) est que la sémantique de ce dernier est déroutante si les types suivants ne correspondent pas :

• le type valeur de InputIt
• les types inscriptibles de OutputIt
• les types des paramètres de operator+ ou op
• le type de retour de operator+ ou op

acc sert d'objet intermédiaire pour stocker et fournir les valeurs à chaque étape du calcul :

• son type est le type valeur de InputIt
• il est écrit dans d_first
• sa valeur est passée à operator+ ou op
• il stocke la valeur de retour de operator+ ou 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>{});

Exemple

#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

Rapports de bogues

Les rapports de bogues suivants modifiant le comportement ont été appliqués rétroactivement aux normes C++ précédemment publiées.

Voir aussi