Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a basic example of std::accumulate. #64

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions 1-common-tasks/algorithms/accumulate-values.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Accumulate values from a range
// C++11

#include <deque>
#include <forward_list>
#include <numeric>
#include <vector>

template <typename Collection>
typename Collection::value_type
sum_numbers(Collection const& collection)
{
using ReturnType = typename Collection::value_type;
return std::accumulate(std::begin(collection), std::end(collection), static_cast<ReturnType>(0));
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious, why use std::begin and std::end instead of collection.begin() and collection.end()?

Copy link
Contributor Author

@janoma janoma Sep 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it's a generic free function that will call what you expect without any overload (for any decent compiler). It also support arrays, so you can call sum_numbers on an array as well. And of course you can call it with any non-STL container for which an appropriate overload of the functions has been created.

}

// Sums elements in a collection
//
// Here is the simplest usage of [`std::accumulate`](cpp/algorithm/accumulate):
// take a collection of numbers and calculate their cumulative sum.
//
// The template on [8] allows us to consider any collection of numbers, not
// necessarily a vector. The return type is the same type of elements contained
// in the collection, so for example a collection of `double`s will calculate and
// return the sum in a `double`, while a collection of `int` will return an
// `int`.
//
// The third argument passed to [`std::accumulate`](cpp/algorithm/accumulate)
// corresponds to the initial value that will be used while _accumulating_. The
// type of this value will be the return type of the function. Thus, we
// make the return type explicit with the `static_cast` at the end of [14],
// because just writing 0 with no type will make the compiler treat it as `int`,
// and that will produce loss of precision when the numbers are of floating
// point type.
//
// To use [`std::accumulate`](cpp/algorithm/accumulate) you need to `#include`
// the `<numeric>` header.

int main()
{
std::vector<int> int_vec = {-1, 0, 1, 2, 3, 4, 5, 6, -6};
int int_sum = sum_numbers(int_vec); // 14

std::forward_list<double> double_vec = {1.0, 2.1, 3.3, 4.4, 5.5};
double double_sum = sum_numbers(double_vec); // 16.3

std::deque<unsigned int> unsigned_vec = {0, 2, 4, 6};
unsigned int unsigned_sum = sum_numbers(unsigned_vec); // 12
}