You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
Python bindings for [Boost::Histogram][] ([source][Boost::Histogram source]), a C++14 library. This should become one of the [fastest libraries][] for histogramming, while still providing the power of a full histogram object.
10
10
11
-
> ## 0.5.1: Public beta
11
+
> ## Version 0.5.2: Public beta
12
12
>
13
13
> Please feel free to try out boost-histogram and give feedback.
14
14
> Join the [discussion on gitter][gitter-link] or [open an issue](https://github.com/scikit-hep/boost-histogram/issues)!
@@ -72,12 +72,12 @@ counts = hist.view()
72
72
*`bh.storage.double`: Doubles for weighted values (default)
73
73
*`bh.storage.int`: 64 bit unsigned integers
74
74
*`bh.storage.unlimited`: Starts small, but can go up to unlimited precision ints or doubles.
75
-
*`bh.storage.atomic_int`: Threadsafe filling, experimental. Does not support growing axis in threads.
75
+
*`bh.storage.atomic_int`: Threadsafe filling, experimental. Does not support growing axis in threads. (`.view` not yet supported`)
76
76
*`bh.storage.weight`: Stores a weight and sum of weights squared. (`.view` not yet supported)
77
77
*`bh.storage.mean`: Accepts a sample and computes the mean of the samples (profile). (`.view` not yet supported)
78
78
*`bh.storage.weighted_mean`: Accepts a sample and a weight. It computes the weighted mean of the samples. (`.view` not yet supported)
79
79
* Accumulators
80
-
*`bh.accumulator.sum`: High accuracy sum (Neumaier)
80
+
*`bh.accumulator.sum`: High accuracy sum (Neumaier) - used by the sum method when summing a numerical histogram
81
81
*`bh.accumulator.weighted_sum`: Tracks a weighted sum and variance
82
82
*`bh.accumulator.weighted_mean`: Tracks a weighted sum, mean, and variance (West's incremental algorithm)
83
83
*`bh.accumulator.mean`: Running count, mean, and variance (Welfords's incremental algorithm)
@@ -98,7 +98,7 @@ counts = hist.view()
98
98
*`.sum(flow=False)`: The total count of all bins
99
99
*`.project(ax1, ax2, ...)`: Project down to listed axis (numbers)
100
100
*`.reduce(ax, reduce_option, ...)`: shrink, rebin, or slice, or any combination
101
-
* Indexing - Supports the Unified Histogram Indexing (UHI) proposal
101
+
* Indexing - Supports the [Unified Histogram Indexing (UHI)](https://boost-histogram.readthedocs.io/en/latest/usage/indexing.html) proposal
102
102
* Details
103
103
* Use `bh.histogram(..., storage=...)` to make a histogram (there are several different types)
0 commit comments