Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / histogram / doc / concepts / Axis.qbk

diff --git a/libs/histogram/doc/concepts/Axis.qbk b/libs/histogram/doc/concepts/Axis.qbk
index c3819d4..cf0784a 100644 (file)
--- a/libs/histogram/doc/concepts/Axis.qbk
+++ b/libs/histogram/doc/concepts/Axis.qbk
@@ -1,3 +1,10 @@
+[/
+            Copyright Hans Dembinski 2018 - 2019.
+   Distributed under the Boost Software License, Version 1.0.
+      (See accompanying file LICENSE_1_0.txt or copy at
+            https://www.boost.org/LICENSE_1_0.txt)
+]
+
 [section:Axis Axis]
 
 An [*Axis] maps input values to indices. It holds state specific to that axis, like the number of bins and any metadata. Must be [@https://en.cppreference.com/w/cpp/named_req/CopyConstructible CopyConstructible], [@https://en.cppreference.com/w/cpp/named_req/CopyAssignable CopyAssignable], and *nothrow* [@https://en.cppreference.com/w/cpp/named_req/MoveAssignable MoveAssignable].
@@ -69,6 +76,13 @@ An [*Axis] maps input values to indices. It holds state specific to that axis, l
   ]
 ]
 [
+  [`a.inclusive()`]
+  [`bool`]
+  [
+    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 it has an overflow bin or if it is growing.
+  ]
+]
+[
   [`a.metadata()`]
   [`const M&`]
   [
@@ -104,10 +118,10 @@ An [*Axis] maps input values to indices. It holds state specific to that axis, l
   ]
 ]
 [
-  [`ar & a`]
+  [`a.serialize(ar, n)`]
   []
   [
-    `ar` is a value of an archive with Boost.Serialization semantics. Serializes `a` to the archive or loads serialized state from the archive.
+    `ar` is a value of an archive with Boost.Serialization semantics and `n` is an unsigned integral value. Saves to the archive or loads serialized state from the archive. The version number `n` is the stored version when the object is loaded or the current version when the object is saved.
   ]
 ]
 ]