boost_mirror/histogram
1
0
Fork 0
mirror of https://github.com/boostorg/histogram.git synced 2025-05-09 23:04:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

further doc improvements (#383)

Browse Source
This commit is contained in:
Hans Dembinski 2022-12-26 16:21:31 +01:00 committed by GitHub
parent 04946089f4
commit 48ff00b642
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/boost/histogram/axis/integer.hpp
View File

@ -33,7 +33,9 @@ namespace axis {
Binning is a O(1) operation. This axis bins even faster than a regular axis. Binning is a O(1) operation. This axis bins even faster than a regular axis.
The options `growth` and `circular` are mutually exclusive. The options `growth` and `circular` are mutually exclusive. If the axis uses
integers and either `growth` or `circular` are set, the axis cannot have
the options `underflow` or `overflow` set.
@tparam Value input value type. Must be integer or floating point. @tparam Value input value type. Must be integer or floating point.
@tparam MetaData type to store meta data. @tparam MetaData type to store meta data.
@ -161,10 +163,9 @@ public:
static constexpr bool inclusive() noexcept { static constexpr bool inclusive() noexcept {
// If axis has underflow and overflow, it is inclusive. // If axis has underflow and overflow, it is inclusive.
// If axis is growing or circular: // If axis is growing or circular:
// - it is inclusive if value_type is int. // - it is inclusive if value_type is an integer.
// - it is not inclusive if value_type is float, because of nan and inf. // - it is not inclusive if value_type is floating point, because of nan and inf.
constexpr bool full_flow = constexpr bool full_flow = options_type().test(option::underflow | option::overflow);
options() & option::underflow && options() & option::overflow;
return full_flow || (std::is_integral<value_type>::value && return full_flow || (std::is_integral<value_type>::value &&
(options() & (option::growth | option::circular))); (options() & (option::growth | option::circular)));
} }