Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / histogram / doc / html / boost / histogram / accumulators / thread_safe.html
index 4b0c189..27e6f06 100644 (file)
 <span class="keyword">class</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// types</span>
-  <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <a name="boost.histogram.accumulators.thread_safe.super_t"></a><span class="identifier">super_t</span><span class="special">;</span>
+  <span class="keyword">typedef</span> <span class="identifier">T</span>                <a name="boost.histogram.accumulators.thread_safe.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
+  <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">atomic</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <a name="boost.histogram.accumulators.thread_safe.super_t"></a><span class="identifier">super_t</span><span class="special">;</span>   
 
   <span class="comment">// <a class="link" href="thread_safe.html#boost.histogram.accumulators.thread_safeconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="thread_safe.html#idm45525156226192-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="thread_safe.html#idm45525156225632-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="thread_safe.html#idm45525156221664-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45525156223936-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45525156220688-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html#idm45414525111376-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html#idm45414525110816-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html#idm45414525106848-bb"><span class="identifier">thread_safe</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45414525109120-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45414525105872-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="thread_safe.html#idm45525156229296-bb">public member functions</a></span>
-  <span class="keyword">void</span> <a class="link" href="thread_safe.html#idm45525156228736-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="thread_safe.html#idm45525156227200-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="thread_safe.html#idm45414525120400-bb">public member functions</a></span>
+  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45414525119840-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45414525117568-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a class="link" href="thread_safe.html#idm45414525115744-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="thread_safe.html#idm45414525114608-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm45952482534000"></a><h2>Description</h2>
+<a name="idm45212148748288"></a><h2>Description</h2>
 <p>This adaptor uses std::atomic to make concurrent increments and additions safe for the stored value.</p>
 <p>On common computing platforms, the adapted integer has the same size and alignment as underlying type. The atomicity is implemented with a special CPU instruction. On exotic platforms the size of the adapted number may be larger and/or the type may have different alignment, which means it cannot be tightly packed into arrays.</p>
 <p>
 </p>
 <div class="refsect2">
-<a name="idm45952482532368"></a><h3>Template Parameters</h3>
+<a name="idm45212148746656"></a><h3>Template Parameters</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 <pre class="literallayout"><span class="keyword">typename</span> T</pre>
 <p>type to adapt, must be supported by std::atomic. </p>
 </li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45952482529216"></a><h3>
+<a name="idm45212148743504"></a><h3>
 <a name="boost.histogram.accumulators.thread_safeconstruct-copy-destruct"></a><code class="computeroutput">thread_safe</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><a name="idm45525156226192-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm45525156225632-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm45525156221664-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="identifier">T</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45525156223936-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45525156220688-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">T</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm45414525111376-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm45414525110816-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm45414525106848-bb"></a><span class="identifier">thread_safe</span><span class="special">(</span><span class="identifier">value_type</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45414525109120-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45414525105872-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">value_type</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45952482496784"></a><h3>
-<a name="idm45525156229296-bb"></a><code class="computeroutput">thread_safe</code> public member functions</h3>
+<a name="idm45212148710992"></a><h3>
+<a name="idm45414525120400-bb"></a><code class="computeroutput">thread_safe</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45525156228736-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="identifier">T</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45525156227200-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45414525119840-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45414525117568-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="identifier">value_type</span> arg<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="thread_safe.html" title="Class template thread_safe">thread_safe</a> <span class="special">&amp;</span> <a name="idm45414525115744-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45414525114608-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span></pre></li>
 </ol></div>
 </div>
 </div>