Skip to content

Commit f7793a2

Browse files
committed
update docs
1 parent d2a9578 commit f7793a2

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/guide.qbk

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ The term /histogram/ is usually strictly used for something with bins over discr
1818

1919
[section Static or dynamic histogram]
2020

21-
The histogram class comes in two variants with a common interface, see the [link histogram.rationale.histogram_types rationale] for more information. Using a [classref boost::histogram::static_histogram static histogram] is recommended. You need a [classref boost::histogram::dynamic_histogram dynamic histogram] instead, if:
21+
The histogram host class can store axis objects in a static or dynamic container, see the [link histogram.rationale.histogram_host rationale] for details. Use the factory functions [funcref boost::histogram::make_static_histogram make_static_histogram] and [funcref boost::histogram::make_dynamic_histogram make_dynamic_histogram] to make the corresponding histograms. Using static histograms is recommended, because they are faster and usage errors are caught at compile-time. Use dynamic histogram, if:
2222

23-
* you only know the histogram configurations at runtime, not at compile-time
23+
* You only know the axis configurations at runtime, not at compile-time.
2424

25-
* you want to write C++ code that interoperates with the Python module included in the library
25+
* You want to write C++ code that interoperates with the Python module included in the library.
2626

27-
Use the factory function [funcref boost::histogram::make_static_histogram make_static_histogram] (or [funcref boost::histogram::make_dynamic_histogram make_dynamic_histogram], respectively) to make histograms with the default storage policy. The default storage policy makes sure that counting is safe, fast, and memory efficient. If you are curious about trying another storage policy or using your own, have a look at the section [link histogram.guide.expert Advanced Usage].
27+
These factory functions create histograms with the default storage type [classref boost::histogram::adaptive_storage], which provides safe counting, is fast and memory efficient. If you think you need another storage type or if you want to create your own, have a look at the section [link histogram.guide.expert Advanced Usage].
2828

2929
Here is an example on how to use [funcref boost::histogram::make_static_histogram make_static_histogram]. You pass one or several axis instances, which define the layout of the histogram.
3030

doc/rationale.qbk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The library consists of three orthogonal components:
2828

2929
[endsect]
3030

31-
[section:histogram_types Histogram host class]
31+
[section:histogram_host Histogram host class]
3232

3333
Histograms store axis objects and a storage object. A one-dimensional histogram has one axis, a multi-dimensional histogram has several. Each axis maps a value from an input tuple onto an index. The histogram host class combines these indices into a global index that is used to address bin counter in the storage object.
3434

0 commit comments

Comments
 (0)