File: guide_custom_accumulators_builtin.cpp

package info (click to toggle)
boost1.74 1.74.0%2Bds1-21
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 463,588 kB
  • sloc: cpp: 3,338,117; xml: 131,293; python: 33,088; ansic: 14,292; asm: 4,038; sh: 3,353; makefile: 1,193; perl: 1,036; yacc: 478; php: 212; ruby: 102; lisp: 24; sql: 13; csh: 6
file content (43 lines) | stat: -rw-r--r-- 1,633 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright 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_custom_accumulators_builtin

#include <boost/format.hpp>
#include <boost/histogram.hpp>
#include <cassert>
#include <iostream>
#include <sstream>

int main() {
  using namespace boost::histogram;
  using mean = accumulators::mean<>;

  // Create a 1D-profile, which computes the mean of samples in each bin.
  auto h = make_histogram_with(dense_storage<mean>(), axis::integer<>(0, 2));
  // The factory function `make_profile` is provided as a shorthand for this, so this is
  // equivalent to the previous line: auto h = make_profile(axis::integer<>(0, 2));

  // An argument marked as `sample` is passed to the accumulator.
  h(0, sample(1)); // sample goes to first cell
  h(0, sample(2)); // sample goes to first cell
  h(1, sample(3)); // sample goes to second cell
  h(1, sample(4)); // sample goes to second cell

  std::ostringstream os;
  for (auto&& x : indexed(h)) {
    // Accumulators usually have methods to access their state. Use the arrow
    // operator to access them. Here, `count()` gives the number of samples,
    // `value()` the mean, and `variance()` the variance estimate of the mean.
    os << boost::format("index %i count %i mean %.1f variance %.1f\n") % x.index() %
              x->count() % x->value() % x->variance();
  }
  std::cout << os.str() << std::flush;
  assert(os.str() == "index 0 count 2 mean 1.5 variance 0.5\n"
                     "index 1 count 2 mean 3.5 variance 0.5\n");
}

//]