Skip to content

Latest commit

 

History

History
130 lines (92 loc) · 8.13 KB

README.md

File metadata and controls

130 lines (92 loc) · 8.13 KB
Raw

Multi-dimensional generalised histograms with convenient interface

Coded with ❤. Powered by the Boost community and the Scikit-HEP Project.

License

Distributed under the Boost Software License, Version 1.0.

Properties

Supported compiler versions gcc >= 5.5, clang >= 3.8, msvc >= 14.1 Supported C++ versions 14, 17, 20

Branch Linux, OSX, Windows Coverage
develop Fast Coveralls
master Fast Coveralls

Boost.Histogram is a very fast state-of-the-art multi-dimensional generalised histogram class for the beginner and expert alike.

  • Header-only
  • Easy to use, easy to customise
  • Designed for performance
  • Just count or use accumulators to compute means, minimum, maximum, ...
  • Supports multi-threading and restricted environments (no heap allocation, exceptions or RTTI)
  • Open hacker-friendly modular design
  • Has official Python bindings

Check out the full documentation.

💡 Boost.Histogram is a mature library with 100 % of code lines covered by unit tests, is benchmarked for performance, and has extensive documentation. If you still find some issue or find the documentation lacking, tell us about it by submitting an issue. Chat with us on the Boost channel on Slack and Gitter.

Code example

The following stripped-down example was taken from the Getting started section in the documentation. Have a look into the docs to see the full version with comments and more examples.

Example: Make and fill a 1d-histogram (try it live on Wandbox). The core of this example compiles into 53 lines of assembly code.

#include <boost/histogram.hpp>
#include <boost/format.hpp> // used here for printing
#include <iostream>

int main() {
    using namespace boost::histogram;

    // make 1d histogram with 4 regular bins from 0 to 2
    auto h = make_histogram( axis::regular<>(4, 0.0, 2.0) );

    // push some values into the histogram
    for (auto&& value : { 0.4, 1.1, 0.3, 1.7, 10. })
      h(value);

    // iterate over bins
    for (auto&& x : indexed(h)) {
      std::cout << boost::format("bin %i [ %.1f, %.1f ): %i\n")
        % x.index() % x.bin().lower() % x.bin().upper() % *x;
    }

    std::cout << std::flush;

    /* program output:

    bin 0 [ 0.0, 0.5 ): 2
    bin 1 [ 0.5, 1.0 ): 0
    bin 2 [ 1.0, 1.5 ): 1
    bin 3 [ 1.5, 2.0 ): 1
    */
}

Features

  • Extremely customisable multi-dimensional histogram
  • Simple, convenient, STL and Boost-compatible interface
  • Counters with high dynamic range, cannot overflow or be capped [1]
  • Better performance than other libraries (see benchmarks for details)
  • Efficient use of memory [1]
  • Hand-crafted C++17 deduction guides for axes and histogram types
  • Support for custom axis types: define how input values should map to indices
  • Support for under-/overflow bins (can be disabled individually to reduce memory consumption)
  • Support for axes that grow automatically with input values [2]
  • Support for weighted increments
  • Support for profiles and more generally, user-defined accumulators in cells [3]
  • Support for completely stack-based histograms
  • Support for compilation without exceptions or RTTI [4]
  • Support for adding, subtracting, multiplying, dividing, and scaling histograms
  • Support for custom allocators
  • Support for programming with units [5]
  • Optional serialization based on Boost.Serialization

Note 1 In the standard configuration, if you don't use weighted increments. The counter capacity is increased dynamically as the cell counts grow. When even the largest plain integral type would overflow, the storage switches to a multiprecision integer similar to those in Boost.Multiprecision, which is only limited by available memory.

Note 2 An axis can be configured to grow when a value is encountered that is outside of its range. It then grows new bins towards this value so that the value ends up in the new highest or lowest bin.

Note 3 The histogram can be configured to hold an arbitrary accumulator in each cell instead of a simple counter. Extra values can be passed to the histogram, for example, to compute the mean and variance of values which fall into the same cell. This feature can be used to calculate variance estimates for each cell, which are useful when you need to fit a statistical model to the cell values.

Note 4 The library throws exceptions when exceptions are enabled. When exceptions are disabled, a user-defined exception handler is called instead upon a throw and the program terminates, see boost::throw_exception for details. Disabling exceptions improves performance by 10 % to 20 % in benchmarks. The library does not use RTTI (only CTTI) so disabling it has no effect.

Note 5 Builtin axis types can be configured to only accept dimensional quantities, like those from Boost.Units. This means you get a useful error if you accidentally try to fill a length where the histogram axis expects a time, for example.

Benchmarks

Boost.Histogram is more flexible and faster than other C/C++ libraries. It was compared to:

Details on the benchmark are given in the documentation.

What users say

John Buonagurio | Manager at Exponent®

"I just wanted to say 'thanks' for your awesome Histogram library. I'm working on a software package for processing meteorology data and I'm using it to generate wind roses with the help of Qt and QwtPolar. Looks like you thought of just about everything here – the circular axis type was practically designed for this application, everything 'just worked'."

More information

  • Ask questions
  • Report bugs: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.
  • Submit your patches as pull requests against develop branch. Note that by submitting patches you agree to license your modifications under the Boost Software License, Version 1.0.
  • Discussions about the library are held on the Boost developers mailing list. Be sure to read the discussion policy before posting and add the [template] tag at the beginning of the subject line.