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

metadata update in axis concept

Browse Source
This commit is contained in:
Hans Dembinski 2020-05-20 02:46:21 +02:00
parent e8b61bf483
commit 3588f2cbdb
1 changed files with 1 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/concepts/Axis.qbk
View File

@ -84,18 +84,11 @@ An [*Axis] maps input values to indices. It holds state specific to that axis, l
Static constexpr member function which returns true, if the axis has a bin for every possible input value, and false otherwise. Faster code can be generated if all axes types in a histogram are inclusive. An axis with underflow and overflow bins is always inclusive. An axis may be inclusive even if underflow or overflow bins are missing. For example, a category axis is inclusive if either it has an overflow bin or if it is growing.
]
]
[
[`a.metadata()`]
[`const M&`]
[
Const member function which returns a const reference to the metadata associated with the axis (usually a string).
]
]
[
[`a.metadata()`]
[`M&`]
[
Likewise, but non-const member function which returns a reference to the metadata. If this member function exists, also the previous one must exist.
Const and non-const member functions must exist, which both returns a mutable reference to the metadata associated with the axis (usually a string).
]
]
[