Imported Upstream version 1.72.0

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

diff --git a/libs/histogram/doc/concepts/Transform.qbk b/libs/histogram/doc/concepts/Transform.qbk
index d7ace36..741583f 100644 (file)
--- a/libs/histogram/doc/concepts/Transform.qbk
+++ b/libs/histogram/doc/concepts/Transform.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:Transform Transform]
 
 A [*Transform] implements a monotonic mapping between two real-valued domains, external and internal. It is used to extend the [classref boost::histogram::axis::regular regular axis]. The bins in the internal domain are of equal width, while the bins in the external domain are non-equal width. Must be [@https://en.cppreference.com/w/cpp/named_req/DefaultConstructible DefaultConstructible], [@https://en.cppreference.com/w/cpp/named_req/CopyConstructible CopyConstructible], and [@https://en.cppreference.com/w/cpp/named_req/CopyAssignable CopyAssignable].
@@ -45,10 +52,10 @@ A [*Transform] implements a monotonic mapping between two real-valued domains, e
 [table Valid expressions
 [[Expression] [Returns] [Semantics, Pre/Post-conditions]]
 [
-  [`ar & t`]
+  [`t.serialize(ar, n)`]
   []
   [
-    Serializes `a` to the archive or loads serialized state from the archive. Can be omitted if `T` is stateless.
+    `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.
   ]
 ]
 ]