libs/histogram/doc/html/boost/histogram/axis/variable.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template variable</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.axis.variable_hpp" title="Header &lt;boost/histogram/axis/variable.hpp&gt;">
   9 <link rel="prev" href="traits/width_as.html" title="Function template width_as">
  10 <link rel="next" href="variant.html" title="Class template variant">
  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="traits/width_as.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.variable_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="variant.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.variable"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template variable</span></h2>
  29 <p>boost::histogram::axis::variable &#8212; Axis for non-equidistant bins on the real line. </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.axis.variable_hpp" title="Header &lt;boost/histogram/axis/variable.hpp&gt;">boost/histogram/axis/variable.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> MetaData<span class="special">,</span> <span class="keyword">typename</span> Options<span class="special">,</span>
  35          <span class="keyword">typename</span> Allocator<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="variable.html" title="Class template variable">variable</a> <span class="special">:</span> <span class="keyword">public</span> boost::histogram::axis::iterator_mixin&lt; variable&lt; Value, MetaData, Options, Allocator &gt; &gt;,
  37                  <span class="keyword">public</span> boost::histogram::axis::metadata_base&lt; MetaData &gt;
  38 <span class="special">{</span>
  39 <span class="keyword">public</span><span class="special">:</span>
  40   <span class="comment">// <a class="link" href="variable.html#boost.histogram.axis.variableconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <a class="link" href="variable.html#idm45414524465216-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  42   <span class="keyword">explicit</span> <a class="link" href="variable.html#idm45414524464656-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="identifier">allocator_type</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span>
  44     <a class="link" href="variable.html#idm45414524463408-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="identifier">It</span><span class="special">,</span> <span class="identifier">It</span><span class="special">,</span> <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span> <span class="identifier">allocator_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  46     <a class="link" href="variable.html#idm45414524456496-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span> <span class="identifier">allocator_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  48     <a class="link" href="variable.html#idm45414524450672-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span>
  49              <span class="identifier">allocator_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="variable.html#idm45414524444560-bb"><span class="identifier">variable</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="variable.html#idm45414524489616-bb">public member functions</a></span>
  53   <span class="identifier">index_type</span> <a class="link" href="variable.html#idm45414524489056-bb"><span class="identifier">index</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  54   <span class="keyword">auto</span> <a class="link" href="variable.html#idm45414524486944-bb"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  55   <span class="identifier">value_type</span> <a class="link" href="variable.html#idm45414524485136-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">real_index_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  56   <span class="keyword">auto</span> <a class="link" href="variable.html#idm45414524483008-bb"><span class="identifier">bin</span></a><span class="special">(</span><span class="identifier">index_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  57   <span class="identifier">index_type</span> <a class="link" href="variable.html#idm45414524480896-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>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  59     <span class="keyword">bool</span> <a class="link" href="variable.html#idm45414524479440-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  60   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
  61     <span class="keyword">bool</span> <a class="link" href="variable.html#idm45414524474656-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <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">auto</span> <a class="link" href="variable.html#idm45414524469872-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>
  63   <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="variable.html#idm45414524468448-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>
  64
  65   <span class="comment">// <a class="link" href="variable.html#idm45414524440720-bb">public static functions</a></span>
  66   <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a class="link" href="variable.html#idm45414524440160-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  67 <span class="special">}</span><span class="special">;</span></pre></div>
  68 <div class="refsect1">
  69 <a name="idm45212144810880"></a><h2>Description</h2>
  70 <p>Binning is a O(log(N)) operation. If speed matters and the problem domain allows it, prefer a regular axis, possibly with a transform.</p>
  71 <p>
  72 </p>
  73 <div class="refsect2">
  74 <a name="idm45212144809808"></a><h3>Template Parameters</h3>
  75 <div class="orderedlist"><ol class="orderedlist" type="1">
  76 <li class="listitem">
  77 <pre class="literallayout"><span class="keyword">typename</span> Value</pre>
  78 <p>input value type, must be floating point. </p>
  79 </li>
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="keyword">typename</span> MetaData</pre>
  82 <p>type to store meta data. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="keyword">typename</span> Options</pre>
  86 <p>see boost::histogram::axis::option (all values allowed). </p>
  87 </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="keyword">typename</span> Allocator</pre>
  90 <p>allocator to use for dynamic memory management. </p>
  91 </li>
  92 </ol></div>
  93 </div>
  94 <div class="refsect2">
  95 <a name="idm45212144800336"></a><h3>
  96 <a name="boost.histogram.axis.variableconstruct-copy-destruct"></a><code class="computeroutput">variable</code>
  97         public
  98        construct/copy/destruct</h3>
  99 <div class="orderedlist"><ol class="orderedlist" type="1">
 100 <li class="listitem"><pre class="literallayout"><a name="idm45414524465216-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
 101 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45414524464656-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="identifier">allocator_type</span> alloc<span class="special">)</span><span class="special">;</span></pre></li>
 102 <li class="listitem">
 103 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span>
 104   <a name="idm45414524463408-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="identifier">It</span> begin<span class="special">,</span> <span class="identifier">It</span> end<span class="special">,</span> <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span>
 105            <span class="identifier">allocator_type</span> alloc <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct from iterator range of bin edges. <p>
 106 </p>
 107 <div class="variablelist"><table border="0" class="variablelist compact">
 108 <colgroup>
 109 <col align="left" valign="top">
 110 <col>
 111 </colgroup>
 112 <tbody><tr>
 113 <td><p><span class="term">Parameters:</span></p></td>
 114 <td><div class="variablelist"><table border="0" class="variablelist compact">
 115 <colgroup>
 116 <col align="left" valign="top">
 117 <col>
 118 </colgroup>
 119 <tbody>
 120 <tr>
 121 <td><p><span class="term"><code class="computeroutput">alloc</code></span></p></td>
 122 <td><p>allocator instance to use. </p></td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term"><code class="computeroutput">begin</code></span></p></td>
 126 <td><p>begin of edge sequence. </p></td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><code class="computeroutput">end</code></span></p></td>
 130 <td><p>end of edge sequence. </p></td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
 134 <td><p>description of the axis. </p></td>
 135 </tr>
 136 </tbody>
 137 </table></div></td>
 138 </tr></tbody>
 139 </table></div>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
 143   <a name="idm45414524456496-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span> iterable<span class="special">,</span> <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span>
 144            <span class="identifier">allocator_type</span> alloc <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct variable axis from iterable range of bin edges. <p>
 145 </p>
 146 <div class="variablelist"><table border="0" class="variablelist compact">
 147 <colgroup>
 148 <col align="left" valign="top">
 149 <col>
 150 </colgroup>
 151 <tbody><tr>
 152 <td><p><span class="term">Parameters:</span></p></td>
 153 <td><div class="variablelist"><table border="0" class="variablelist compact">
 154 <colgroup>
 155 <col align="left" valign="top">
 156 <col>
 157 </colgroup>
 158 <tbody>
 159 <tr>
 160 <td><p><span class="term"><code class="computeroutput">alloc</code></span></p></td>
 161 <td><p>allocator instance to use. </p></td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><code class="computeroutput">iterable</code></span></p></td>
 165 <td><p>iterable range of bin edges. </p></td>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
 169 <td><p>description of the axis. </p></td>
 170 </tr>
 171 </tbody>
 172 </table></div></td>
 173 </tr></tbody>
 174 </table></div>
 175 </li>
 176 <li class="listitem">
 177 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
 178   <a name="idm45414524450672-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span> list<span class="special">,</span> <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">,</span>
 179            <span class="identifier">allocator_type</span> alloc <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct variable axis from initializer list of bin edges. <p>
 180 </p>
 181 <div class="variablelist"><table border="0" class="variablelist compact">
 182 <colgroup>
 183 <col align="left" valign="top">
 184 <col>
 185 </colgroup>
 186 <tbody><tr>
 187 <td><p><span class="term">Parameters:</span></p></td>
 188 <td><div class="variablelist"><table border="0" class="variablelist compact">
 189 <colgroup>
 190 <col align="left" valign="top">
 191 <col>
 192 </colgroup>
 193 <tbody>
 194 <tr>
 195 <td><p><span class="term"><code class="computeroutput">alloc</code></span></p></td>
 196 <td><p>allocator instance to use. </p></td>
 197 </tr>
 198 <tr>
 199 <td><p><span class="term"><code class="computeroutput">list</code></span></p></td>
 200 <td><p><code class="computeroutput">std::initializer_list</code> of bin edges. </p></td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
 204 <td><p>description of the axis. </p></td>
 205 </tr>
 206 </tbody>
 207 </table></div></td>
 208 </tr></tbody>
 209 </table></div>
 210 </li>
 211 <li class="listitem">
 212 <pre class="literallayout"><a name="idm45414524444560-bb"></a><span class="identifier">variable</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a> <span class="special">&amp;</span> src<span class="special">,</span> <span class="identifier">index_type</span> begin<span class="special">,</span> <span class="identifier">index_type</span> end<span class="special">,</span>
 213          <span class="keyword">unsigned</span> merge<span class="special">)</span><span class="special">;</span></pre>Constructor used by algorithm::reduce to shrink and rebin (not for users). </li>
 214 </ol></div>
 215 </div>
 216 <div class="refsect2">
 217 <a name="idm45212144713632"></a><h3>
 218 <a name="idm45414524489616-bb"></a><code class="computeroutput">variable</code> public member functions</h3>
 219 <div class="orderedlist"><ol class="orderedlist" type="1">
 220 <li class="listitem">
 221 <pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45414524489056-bb"></a><span class="identifier">index</span><span class="special">(</span><span class="identifier">value_type</span> x<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return index for value argument. </li>
 222 <li class="listitem"><pre class="literallayout"><span class="keyword">auto</span> <a name="idm45414524486944-bb"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">value_type</span> x<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 223 <li class="listitem">
 224 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524485136-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">real_index_type</span> i<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return value for fractional index argument. </li>
 225 <li class="listitem">
 226 <pre class="literallayout"><span class="keyword">auto</span> <a name="idm45414524483008-bb"></a><span class="identifier">bin</span><span class="special">(</span><span class="identifier">index_type</span> idx<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return bin for index argument. </li>
 227 <li class="listitem">
 228 <pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45414524480896-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>Returns the number of bins, without over- or underflow. </li>
 229 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 230   <span class="keyword">bool</span> <a name="idm45414524479440-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 231 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">,</span> <span class="keyword">typename</span> A<span class="special">&gt;</span>
 232   <span class="keyword">bool</span> <a name="idm45414524474656-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variable.html" title="Class template variable">variable</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span><span class="special">,</span> <span class="identifier">A</span> <span class="special">&gt;</span> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 233 <li class="listitem">
 234 <pre class="literallayout"><span class="keyword">auto</span> <a name="idm45414524469872-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>Return allocator instance. </li>
 235 <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="idm45414524468448-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>
 236 </ol></div>
 237 </div>
 238 <div class="refsect2">
 239 <a name="idm45212144624768"></a><h3>
 240 <a name="idm45414524440720-bb"></a><code class="computeroutput">variable</code> public static functions</h3>
 241 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 242 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a name="idm45414524440160-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns the options. </li></ol></div>
 243 </div>
 244 </div>
 245 </div>
 246 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 247 <td align="left"></td>
 248 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
 249       Dembinski<p>
 250         Distributed under the Boost Software License, Version 1.0. (See accompanying
 251         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 252       </p>
 253 </div></td>
 254 </tr></table>
 255 <hr>
 256 <div class="spirit-nav">
 257 <a accesskey="p" href="traits/width_as.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.variable_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="variant.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 258 </div>
 259 </body>
 260 </html>