histogram/examples/guide_histogram_operators.cpp
2019-01-11 00:06:26 +01:00

64 lines
1.9 KiB
C++

// Copyright 2015-2018 Hans Dembinski
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt
// or copy at http://www.boost.org/LICENSE_1_0.txt)
//[ guide_histogram_operators
#include <boost/histogram.hpp>
#include <cassert>
#include <vector>
namespace bh = boost::histogram;
int main() {
// make two histograms
auto h1 = bh::make_histogram(bh::axis::regular<>(2, -1, 1));
auto h2 = bh::make_histogram(bh::axis::regular<>(2, -1, 1));
h1(-0.5); // counts are: 1 0
h2(0.5); // counts are: 0 1
// add them
auto h3 = h1;
h3 += h2; // counts are: 1 1
// adding multiple histograms at once is likely to be optimized by the compiler so that
// superfluous temporaries avoided, but no guarantees are given; use this equivalent
// code when you want to make sure: h4 = h1; h4 += h2; h4 += h3;
auto h4 = h1 + h2 + h3; // counts are: 2 2
assert(h4.at(0) == 2 && h4.at(1) == 2);
// multiply by number; h4 *= 2 is not allowed, because the result of a multiplication is
// not a histogram anymore, it has the type boost::histogram::grid<...>)
auto g4 = h4 * 2; // counts are: 4 4
// divide by number; g4 /= 4 also works
auto g5 = g4 / 4; // counts are: 1 1
assert(g5.at(0) == 1 && g5.at(1) == 1);
assert(g4 != g5 && g4 == 4 * g5);
// note special effect of multiplication on weighted_sum
auto h = bh::make_histogram_with(std::vector<bh::accumulators::weighted_sum<double>>(),
bh::axis::regular<>(2, -1, 1));
h(-0.5);
// counts are: 1 0
assert(h.at(0).value() == 1 && h.at(1).value() == 0);
auto h_sum = h + h;
auto g_mul = 2 * h;
// equality operator checks variances, so following statement is false
assert(h_sum != g_mul);
// variance is different when histograms are scaled
assert(h_sum.at(0).value() == 2 && g_mul.at(0).value() == 2);
assert(h_sum.at(0).variance() == 2 && g_mul.at(0).variance() == 4);
}
//]