libs/histogram/doc/html/boost/histogram/accumulators/thread_safe.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template thread_safe</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Histogram">
   8 <link rel="up" href="../../../histogram/reference.html#header.boost.histogram.accumulators.thread_safe_hpp" title="Header &lt;boost/histogram/accumulators/thread_safe.hpp&gt;">
   9 <link rel="prev" href="../algorithm/sum.html" title="Function template sum">
  10 <link rel="next" href="weighted_mean.html" title="Class template weighted_mean">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../algorithm/sum.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.accumulators.thread_safe_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="weighted_mean.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.accumulators.thread_safe"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template thread_safe</span></h2>
  29 <p>boost::histogram::accumulators::thread_safe &#8212; Thread-safe adaptor for builtin integral and floating point numbers. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../histogram/reference.html#header.boost.histogram.accumulators.thread_safe_hpp" title="Header &lt;boost/histogram/accumulators/thread_safe.hpp&gt;">boost/histogram/accumulators/thread_safe.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  35 <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>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <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>
  39   <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>
  40
  41   <span class="comment">// <a class="link" href="thread_safe.html#boost.histogram.accumulators.thread_safeconstruct-copy-destruct">construct/copy/destruct</a></span>
  42   <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>
  43   <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>
  44   <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>
  45   <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>
  46   <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>
  47
  48   <span class="comment">// <a class="link" href="thread_safe.html#idm45414525120400-bb">public member functions</a></span>
  49   <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>
  50   <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>
  51   <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>
  52   <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>
  53 <span class="special">}</span><span class="special">;</span></pre></div>
  54 <div class="refsect1">
  55 <a name="idm45212148748288"></a><h2>Description</h2>
  56 <p>This adaptor uses std::atomic to make concurrent increments and additions safe for the stored value.</p>
  57 <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>
  58 <p>
  59 </p>
  60 <div class="refsect2">
  61 <a name="idm45212148746656"></a><h3>Template Parameters</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  63 <pre class="literallayout"><span class="keyword">typename</span> T</pre>
  64 <p>type to adapt, must be supported by std::atomic. </p>
  65 </li></ol></div>
  66 </div>
  67 <div class="refsect2">
  68 <a name="idm45212148743504"></a><h3>
  69 <a name="boost.histogram.accumulators.thread_safeconstruct-copy-destruct"></a><code class="computeroutput">thread_safe</code>
  70         public
  71        construct/copy/destruct</h3>
  72 <div class="orderedlist"><ol class="orderedlist" type="1">
  73 <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>
  74 <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>
  75 <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>
  76 <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>
  77 <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>
  78 </ol></div>
  79 </div>
  80 <div class="refsect2">
  81 <a name="idm45212148710992"></a><h3>
  82 <a name="idm45414525120400-bb"></a><code class="computeroutput">thread_safe</code> public member functions</h3>
  83 <div class="orderedlist"><ol class="orderedlist" type="1">
  84 <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>
  85 <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>
  86 <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>
  87 <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>
  88 </ol></div>
  89 </div>
  90 </div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  95       Dembinski<p>
  96         Distributed under the Boost Software License, Version 1.0. (See accompanying
  97         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  98       </p>
  99 </div></td>
 100 </tr></table>
 101 <hr>
 102 <div class="spirit-nav">
 103 <a accesskey="p" href="../algorithm/sum.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.accumulators.thread_safe_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="weighted_mean.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 104 </div>
 105 </body>
 106 </html>