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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template integer</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.integer_hpp" title="Header &lt;boost/histogram/axis/integer.hpp&gt;">
   9 <link rel="prev" href="category.html" title="Class template category">
  10 <link rel="next" href="interval_view.html" title="Class template interval_view">
  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="category.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.integer_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="interval_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.integer"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template integer</span></h2>
  29 <p>boost::histogram::axis::integer &#8212; Axis for an interval of integer values with unit steps. </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.integer_hpp" title="Header &lt;boost/histogram/axis/integer.hpp&gt;">boost/histogram/axis/integer.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">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="integer.html" title="Class template integer">integer</a> <span class="special">:</span> <span class="keyword">public</span> boost::histogram::axis::iterator_mixin&lt; integer&lt; Value, MetaData, Options &gt; &gt;,
  36                 <span class="keyword">public</span> boost::histogram::axis::metadata_base&lt; MetaData &gt;
  37 <span class="special">{</span>
  38 <span class="keyword">public</span><span class="special">:</span>
  39   <span class="comment">// <a class="link" href="integer.html#boost.histogram.axis.integerconstruct-copy-destruct">construct/copy/destruct</a></span>
  40   <a class="link" href="integer.html#idm45414524850736-bb"><span class="identifier">integer</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  41   <a class="link" href="integer.html#idm45414524850176-bb"><span class="identifier">integer</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</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="special">;</span>
  42   <a class="link" href="integer.html#idm45414524845472-bb"><span class="identifier">integer</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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>
  43
  44   <span class="comment">// <a class="link" href="integer.html#idm45414524872912-bb">public member functions</a></span>
  45   <span class="identifier">index_type</span> <a class="link" href="integer.html#idm45414524872352-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>
  46   <span class="keyword">auto</span> <a class="link" href="integer.html#idm45414524870240-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>
  47   <span class="identifier">value_type</span> <a class="link" href="integer.html#idm45414524868096-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">local_index_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  48   <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="integer.html#idm45414524865984-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>
  49   <span class="identifier">index_type</span> <a class="link" href="integer.html#idm45414524863872-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>
  50   <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">&gt;</span>
  51     <span class="keyword">bool</span> <a class="link" href="integer.html#idm45414524862416-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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">&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>
  52   <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">&gt;</span>
  53     <span class="keyword">bool</span> <a class="link" href="integer.html#idm45414524858192-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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">&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>
  54   <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="integer.html#idm45414524853968-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>
  55
  56   <span class="comment">// <a class="link" href="integer.html#idm45414524841648-bb">public static functions</a></span>
  57   <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a class="link" href="integer.html#idm45414524841088-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  58   <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <a class="link" href="integer.html#idm45414524839408-bb"><span class="identifier">inclusive</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idm45212147142336"></a><h2>Description</h2>
  62 <p>Binning is a O(1) operation. This axis bins faster than a regular axis.</p>
  63 <p>
  64 </p>
  65 <div class="refsect2">
  66 <a name="idm45212147141328"></a><h3>Template Parameters</h3>
  67 <div class="orderedlist"><ol class="orderedlist" type="1">
  68 <li class="listitem">
  69 <pre class="literallayout"><span class="keyword">typename</span> Value</pre>
  70 <p>input value type. Must be integer or floating point. </p>
  71 </li>
  72 <li class="listitem">
  73 <pre class="literallayout"><span class="keyword">typename</span> MetaData</pre>
  74 <p>type to store meta data. </p>
  75 </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><span class="keyword">typename</span> Options</pre>
  78 <p>see boost::histogram::axis::option (all values allowed). </p>
  79 </li>
  80 </ol></div>
  81 </div>
  82 <div class="refsect2">
  83 <a name="idm45212147133952"></a><h3>
  84 <a name="boost.histogram.axis.integerconstruct-copy-destruct"></a><code class="computeroutput">integer</code>
  85         public
  86        construct/copy/destruct</h3>
  87 <div class="orderedlist"><ol class="orderedlist" type="1">
  88 <li class="listitem"><pre class="literallayout"><a name="idm45414524850736-bb"></a><span class="identifier">integer</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  89 <li class="listitem">
  90 <pre class="literallayout"><a name="idm45414524850176-bb"></a><span class="identifier">integer</span><span class="special">(</span><span class="identifier">value_type</span> start<span class="special">,</span> <span class="identifier">value_type</span> stop<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><span class="special">;</span></pre>Construct over semi-open integer interval [start, stop). <p>
  91 </p>
  92 <div class="variablelist"><table border="0" class="variablelist compact">
  93 <colgroup>
  94 <col align="left" valign="top">
  95 <col>
  96 </colgroup>
  97 <tbody><tr>
  98 <td><p><span class="term">Parameters:</span></p></td>
  99 <td><div class="variablelist"><table border="0" class="variablelist compact">
 100 <colgroup>
 101 <col align="left" valign="top">
 102 <col>
 103 </colgroup>
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
 107 <td><p>description of the axis. </p></td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term"><code class="computeroutput">start</code></span></p></td>
 111 <td><p>first integer of covered range. </p></td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><code class="computeroutput">stop</code></span></p></td>
 115 <td><p>one past last integer of covered range. </p></td>
 116 </tr>
 117 </tbody>
 118 </table></div></td>
 119 </tr></tbody>
 120 </table></div>
 121 </li>
 122 <li class="listitem">
 123 <pre class="literallayout"><a name="idm45414524845472-bb"></a><span class="identifier">integer</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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> <span class="keyword">unsigned</span> merge<span class="special">)</span><span class="special">;</span></pre>Constructor used by algorithm::reduce to shrink and rebin. </li>
 124 </ol></div>
 125 </div>
 126 <div class="refsect2">
 127 <a name="idm45212147101728"></a><h3>
 128 <a name="idm45414524872912-bb"></a><code class="computeroutput">integer</code> public member functions</h3>
 129 <div class="orderedlist"><ol class="orderedlist" type="1">
 130 <li class="listitem">
 131 <pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45414524872352-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>
 132 <li class="listitem">
 133 <pre class="literallayout"><span class="keyword">auto</span> <a name="idm45414524870240-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>Returns index and shift (if axis has grown) for the passed argument. </li>
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524868096-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">local_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 index argument. </li>
 136 <li class="listitem">
 137 <pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45414524865984-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>
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45414524863872-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>
 140 <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">&gt;</span>
 141   <span class="keyword">bool</span> <a name="idm45414524862416-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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">&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>
 142 <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">&gt;</span>
 143   <span class="keyword">bool</span> <a name="idm45414524858192-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="integer.html" title="Class template integer">integer</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">&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>
 144 <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="idm45414524853968-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>
 145 </ol></div>
 146 </div>
 147 <div class="refsect2">
 148 <a name="idm45212147021232"></a><h3>
 149 <a name="idm45414524841648-bb"></a><code class="computeroutput">integer</code> public static functions</h3>
 150 <div class="orderedlist"><ol class="orderedlist" type="1">
 151 <li class="listitem">
 152 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a name="idm45414524841088-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>
 153 <li class="listitem">
 154 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">bool</span> <a name="idm45414524839408-bb"></a><span class="identifier">inclusive</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Whether the axis is inclusive (see axis::traits::is_inclusive). </li>
 155 </ol></div>
 156 </div>
 157 </div>
 158 </div>
 159 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 160 <td align="left"></td>
 161 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
 162       Dembinski<p>
 163         Distributed under the Boost Software License, Version 1.0. (See accompanying
 164         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 165       </p>
 166 </div></td>
 167 </tr></table>
 168 <hr>
 169 <div class="spirit-nav">
 170 <a accesskey="p" href="category.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.integer_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="interval_view.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 171 </div>
 172 </body>
 173 </html>