libs/histogram/doc/html/boost/histogram/unlimited_storage.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template unlimited_storage</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.unlimited_storage_hpp" title="Header &lt;boost/histogram/unlimited_storage.hpp&gt;">
   9 <link rel="prev" href="storage_adaptor.html" title="Class template storage_adaptor">
  10 <link rel="next" href="unsafe_access.html" title="Struct unsafe_access">
  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="storage_adaptor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.unlimited_storage_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="unsafe_access.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.unlimited_storage"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template unlimited_storage</span></h2>
  29 <p>boost::histogram::unlimited_storage &#8212; Memory-efficient storage for integral counters which cannot overflow. </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.unlimited_storage_hpp" title="Header &lt;boost/histogram/unlimited_storage.hpp&gt;">boost/histogram/unlimited_storage.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Allocator<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <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="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.histogram.unlimited_storage.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.histogram.unlimited_storage.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">Allocator</span>   <a name="boost.histogram.unlimited_storage.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="keyword">double</span>      <a name="boost.histogram.unlimited_storage.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.histogram.unlimited_storage.large_int"></a><span class="identifier">large_int</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.histogram.unlimited_storage.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.histogram.unlimited_storage.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="unlimited_storage.html#boost.histogram.unlimited_storageconstruct-copy-destruct">construct/copy/destruct</a></span>
  47   <span class="keyword">explicit</span> <a class="link" href="unlimited_storage.html#idm45414524074416-bb"><span class="identifier">unlimited_storage</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="unlimited_storage.html#idm45414524072880-bb"><span class="identifier">unlimited_storage</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  49   <a class="link" href="unlimited_storage.html#idm45414524068912-bb"><span class="identifier">unlimited_storage</span></a><span class="special">(</span><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  50   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="unlimited_storage.html#idm45414524065264-bb"><span class="identifier">unlimited_storage</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a class="link" href="unlimited_storage.html#idm45414524071184-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  52   <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a class="link" href="unlimited_storage.html#idm45414524067376-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  53   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a class="link" href="unlimited_storage.html#idm45414524063168-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="unlimited_storage.html#idm45414524097072-bb">public member functions</a></span>
  56   <span class="identifier">allocator_type</span> <a class="link" href="unlimited_storage.html#idm45414524096512-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="unlimited_storage.html#idm45414524095392-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  58   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unlimited_storage.html#idm45414524093856-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  59   <a class="link" href="unlimited_storage.html#boost.histogram.unlimited_storage.reference">reference</a> <a class="link" href="unlimited_storage.html#idm45414524092736-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  60   <a class="link" href="unlimited_storage.html#boost.histogram.unlimited_storage.const_reference">const_reference</a> <a class="link" href="unlimited_storage.html#idm45414524090800-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  61   <span class="keyword">bool</span> <a class="link" href="unlimited_storage.html#idm45414524088864-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  62   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="unlimited_storage.html#idm45414524086608-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a class="link" href="unlimited_storage.html#idm45414524083952-bb"><span class="keyword">operator</span> <span class="special">*=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">double</span><span class="special">)</span><span class="special">;</span>
  64   <span class="identifier">iterator</span> <a class="link" href="unlimited_storage.html#idm45414524082128-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  65   <span class="identifier">iterator</span> <a class="link" href="unlimited_storage.html#idm45414524081008-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  66   <span class="identifier">const_iterator</span> <a class="link" href="unlimited_storage.html#idm45414524079888-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  67   <span class="identifier">const_iterator</span> <a class="link" href="unlimited_storage.html#idm45414524078768-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  68   <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="unlimited_storage.html#idm45414524077648-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>
  69
  70   <span class="comment">// public data members</span>
  71   <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <span class="identifier">has_threading_support</span><span class="special">;</span>
  72 <span class="special">}</span><span class="special">;</span></pre></div>
  73 <div class="refsect1">
  74 <a name="idm45212142221456"></a><h2>Description</h2>
  75 <p>This storage provides a no-overflow-guarantee if the counters are incremented with integer weights. It maintains a contiguous array of elemental counters, one for each cell. If an operation is requested which would overflow a counter, the array is replaced with another of a wider integral type, then the operation is executed. The storage uses integers of 8, 16, 32, 64 bits, and then switches to a multiprecision integral type, similar to those in <a href="https://www.boost.org/doc/libs/develop/libs/multiprecision/doc/html/index.html" target="_top">Boost.Multiprecision</a>.</p>
  76 <p>A scaling operation or adding a floating point number triggers a conversion of the elemental counters into doubles, which voids the no-overflow-guarantee. </p>
  77 <div class="refsect2">
  78 <a name="idm45212142219136"></a><h3>
  79 <a name="boost.histogram.unlimited_storageconstruct-copy-destruct"></a><code class="computeroutput">unlimited_storage</code>
  80         public
  81        construct/copy/destruct</h3>
  82 <div class="orderedlist"><ol class="orderedlist" type="1">
  83 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45414524074416-bb"></a><span class="identifier">unlimited_storage</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&amp;</span> a <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><a name="idm45414524072880-bb"></a><span class="identifier">unlimited_storage</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  85 <li class="listitem"><pre class="literallayout"><a name="idm45414524068912-bb"></a><span class="identifier">unlimited_storage</span><span class="special">(</span><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  86 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idm45414524065264-bb"></a><span class="identifier">unlimited_storage</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span> s<span class="special">)</span><span class="special">;</span></pre></li>
  87 <li class="listitem"><pre class="literallayout"><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a name="idm45414524071184-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  88 <li class="listitem"><pre class="literallayout"><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a name="idm45414524067376-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  89 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a name="idm45414524063168-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span> s<span class="special">)</span><span class="special">;</span></pre></li>
  90 </ol></div>
  91 </div>
  92 <div class="refsect2">
  93 <a name="idm45212142158448"></a><h3>
  94 <a name="idm45414524097072-bb"></a><code class="computeroutput">unlimited_storage</code> public member functions</h3>
  95 <div class="orderedlist"><ol class="orderedlist" type="1">
  96 <li class="listitem"><pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idm45414524096512-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  97 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45414524095392-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre></li>
  98 <li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45414524093856-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  99 <li class="listitem"><pre class="literallayout"><a class="link" href="unlimited_storage.html#boost.histogram.unlimited_storage.reference">reference</a> <a name="idm45414524092736-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> i<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 100 <li class="listitem"><pre class="literallayout"><a class="link" href="unlimited_storage.html#boost.histogram.unlimited_storage.const_reference">const_reference</a> <a name="idm45414524090800-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> i<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 101 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45414524088864-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> x<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 102 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterable<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45414524086608-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span> iterable<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 103 <li class="listitem"><pre class="literallayout"><a class="link" href="unlimited_storage.html" title="Class template unlimited_storage">unlimited_storage</a> <span class="special">&amp;</span> <a name="idm45414524083952-bb"></a><span class="keyword">operator</span> <span class="special">*=</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">double</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 104 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45414524082128-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 105 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm45414524081008-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 106 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45414524079888-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 107 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45414524078768-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 108 <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="idm45414524077648-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>
 109 </ol></div>
 110 </div>
 111 </div>
 112 </div>
 113 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 114 <td align="left"></td>
 115 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
 116       Dembinski<p>
 117         Distributed under the Boost Software License, Version 1.0. (See accompanying
 118         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 119       </p>
 120 </div></td>
 121 </tr></table>
 122 <hr>
 123 <div class="spirit-nav">
 124 <a accesskey="p" href="storage_adaptor.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.unlimited_storage_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="unsafe_access.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 125 </div>
 126 </body>
 127 </html>