boost_mirror/histogram
1
0
Fork 0
mirror of https://github.com/boostorg/histogram.git synced 2025-05-11 13:14:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved doxygen docs

Browse Source
This commit is contained in:
Hans Dembinski 2021-10-13 10:32:25 +02:00
parent e3668cf7de
commit 1ce098b976
2 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/boost/histogram/axis/option.hpp
View File

@ -57,11 +57,7 @@ constexpr auto operator-(bitset<B1>, bitset<B2>) {
@tparam Pos position of the bit in the set.
*/
template <unsigned Pos>
#ifndef BOOST_HISTOGRAM_DOXYGEN_INVOKED
using bit = bitset<(1 << Pos)>;
#else
struct bit;
#endif
/// All options off.
using none_t = bitset<0>;

10
include/boost/histogram/axis/traits.hpp
View File

@ -208,16 +208,16 @@ struct get_options;
an axis type and represents compile-time boolean which is true or false, depending on
whether the axis is inclusive or not.
An inclusive axis has a bin for every possible input value. In other words, all
possible input values always end up in a valid cell and there is no need to keep track
of input tuples that need to be discarded. A histogram which consists entirely of
inclusive axes can be filled more efficiently, which can be a factor 2 faster.
An axis with underflow and overflow bins is always inclusive, but an axis may be
inclusive under other conditions. The meta-function checks for the method `constexpr
static bool inclusive()`, and uses the result. If this method is not present, it uses
get_options<Axis> and checks whether the underflow and overflow bits are present.
An inclusive axis has a bin for every possible input value. A histogram which consists
only of inclusive axes can be filled more efficiently, since input values always
end up in a valid cell and there is no need to keep track of input tuples that need to
be discarded.
@tparam Axis axis type
*/
template <class Axis>