-# Histogram
+<!--
+ Copyright Hans Dembinski 2016 - 2019.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ https://www.boost.org/LICENSE_1_0.txt)
+-->
+
+
**Fast multi-dimensional histogram with convenient interface for C++14**
-Coded with ❤. Powered by the [Boost community](https://www.boost.org) and the [Scikit-HEP Project](http://scikit-hep.org).
+Coded with ❤. Powered by the [Boost community](https://www.boost.org) and the [Scikit-HEP Project](http://scikit-hep.org). Licensed under the [Boost Software License](http://www.boost.org/LICENSE_1_0.txt).
-💡 Boost.Histogram is a mature library, but there are still many ways to improve. Tell us what you want to do with Boost.Histogram that can't be done right now, or how to improve the documentation by [submitting an issue](https://github.com/boostorg/histogram/issues). Or chat with us on the [Boost channel on Slack](https://cpplang.slack.com) or on [Gitter](https://gitter.im/boostorg/histogram).
+**Supported compiler versions** gcc >= 5.5, clang >= 3.8, msvc >= 14.1
Branch | Linux and OSX | Windows | Coverage
------- | ------------- |-------- | --------
develop | [](https://travis-ci.org/boostorg/histogram/branches) | [](https://ci.appveyor.com/project/HDembinski/histogram-d5g5k/branch/develop) | [](https://coveralls.io/github/boostorg/histogram?branch=develop)
master | [](https://travis-ci.org/boostorg/histogram/branches) | [](https://ci.appveyor.com/project/HDembinski/histogram-d5g5k/branch/master) | [](https://coveralls.io/github/boostorg/histogram?branch=master)
-**Supported compiler versions** gcc >= 5.5, clang >= 3.8, msvc >= 14.1
+Boost.Histogram is a very fast state-of-the-art multi-dimensional [histogram](https://en.wikipedia.org/wiki/Histogram) class for the beginner and expert alike.
-This **header-only** open-source library provides an easy-to-use state-of-the-art multi-dimensional [histogram](https://en.wikipedia.org/wiki/Histogram) class for the professional statistician and everyone who needs to count things. The histogram is easy to use for the casual user and yet so customizable that it does not restrict the power-user. The library offers a unique safety guarantee: cell counts *cannot overflow* or *be capped* in the standard configuration [[1]](#note1). And it can do more than counting. The histogram can be equipped with arbitrary accumulators to compute means, medians, and whatever you fancy in each cell. The library is very fast single-threaded (see benchmarks) and several parallelization options are provided for multi-threaded programming.
+* Header-only
+* Easy to use, easy to customize
+* Just count or use arbitrary accumulators to compute means, minimum, maximum, ...
+* Supports multi-threading and restricted environments (no heap allocation, exceptions or RTTI)
+* Has [Python bindings](https://github.com/scikit-hep/boost-histogram)
-The library passed Boost review in September 2018 and was first released with [Boost-1.70](http://www.boost.org) on April 12th, 2019. The library is licensed under the [Boost Software License](http://www.boost.org/LICENSE_1_0.txt).
+Check out the [full documentation](https://www.boost.org/doc/libs/develop/libs/histogram/doc/html/index.html).
-Check out the [full documentation](https://www.boost.org/doc/libs/develop/libs/histogram/doc/html/index.html). [Python bindings](https://github.com/hdembinski/histogram-python) to this library are available elsewhere.
+💡 Boost.Histogram is a mature library, but if you find some issue or find the documentation lacking, tell us about it by [submitting an issue](https://github.com/boostorg/histogram/issues). Chat with us on the [Boost channel on Slack](https://cpplang.slack.com) and [Gitter](https://gitter.im/boostorg/histogram).
-## Code example
+## Code examples
The following stripped-down example was taken from the [Getting started](https://www.boost.org/doc/libs/develop/libs/histogram/doc/html/histogram/getting_started.html) 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](https://wandbox.org/permlink/FfVtlXg6fC5b52rn))
+Example: Make and fill a 1d-histogram ([try it live on Wandbox](https://wandbox.org/permlink/NSM2ZiDyntUi6RDC)). The core of this example [compiles into 53 lines of assembly code](https://godbolt.org/z/632yzE).
```cpp
#include <boost/histogram.hpp>
projects / platform / upstream / boost.git / blobdiff