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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template polymorphic_bin</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.polymorphic_bin_hpp" title="Header &lt;boost/histogram/axis/polymorphic_bin.hpp&gt;">
   9 <link rel="prev" href="option/growth.html" title="Global growth">
  10 <link rel="next" href="transform/id.html" title="Struct id">
  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="option/growth.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.polymorphic_bin_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="transform/id.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.polymorphic_bin"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template polymorphic_bin</span></h2>
  29 <p>boost::histogram::axis::polymorphic_bin &#8212; Holds the bin data of an <a class="link" href="variant.html" title="Class template variant">axis::variant</a>. </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.polymorphic_bin_hpp" title="Header &lt;boost/histogram/axis/polymorphic_bin.hpp&gt;">boost/histogram/axis/polymorphic_bin.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="polymorphic_bin.html" title="Class template polymorphic_bin">polymorphic_bin</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="polymorphic_bin.html#boost.histogram.axis.polymorphic_binconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="polymorphic_bin.html#idm45414524706096-bb"><span class="identifier">polymorphic_bin</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="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="polymorphic_bin.html#idm45414524720672-bb">public member functions</a></span>
  41   <a class="link" href="polymorphic_bin.html#idm45414524720112-bb"><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  42   <span class="identifier">value_type</span> <a class="link" href="polymorphic_bin.html#idm45414524718656-bb"><span class="identifier">lower</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  43   <span class="identifier">value_type</span> <a class="link" href="polymorphic_bin.html#idm45414524717232-bb"><span class="identifier">upper</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  44   <span class="identifier">value_type</span> <a class="link" href="polymorphic_bin.html#idm45414524715808-bb"><span class="identifier">center</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  45   <span class="identifier">value_type</span> <a class="link" href="polymorphic_bin.html#idm45414524714400-bb"><span class="identifier">width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="polymorphic_bin.html#idm45414524712992-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="polymorphic_bin.html#idm45414524710336-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  48   <span class="keyword">bool</span> <a class="link" href="polymorphic_bin.html#idm45414524707680-bb"><span class="identifier">is_discrete</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idm45212146261616"></a><h2>Description</h2>
  52 <p>The interface is a superset of the <a class="link" href="interval_view.html" title="Class template interval_view">axis::interval_view</a> class. In addition, the object is implicitly convertible to the value type, returning the equivalent of a call to lower(). For discrete axes, lower() == upper(), and width() returns zero.</p>
  53 <p>This is not a view like <a class="link" href="interval_view.html" title="Class template interval_view">axis::interval_view</a> for two reasons.</p>
  54 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  55 <li class="listitem"><p>Sequential calls to lower() and upper() would have to each loop through the variant types. This is likely to be slower than filling all the data in one loop.</p></li>
  56 <li class="listitem"><p><a class="link" href="polymorphic_bin.html" title="Class template polymorphic_bin">polymorphic_bin</a> may be created from a temporary instance of <a class="link" href="variant.html" title="Class template variant">axis::variant</a>, like in the call histogram::axis(0). Storing a reference to the axis would result in a dangling reference. Rather than specialing the code to handle this, it seems easier to just use a value instead of a view. </p></li>
  57 </ul></div>
  58 <p>
  59 </p>
  60 <div class="refsect2">
  61 <a name="idm45212146255232"></a><h3>
  62 <a name="boost.histogram.axis.polymorphic_binconstruct-copy-destruct"></a><code class="computeroutput">polymorphic_bin</code>
  63         public
  64        construct/copy/destruct</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45414524706096-bb"></a><span class="identifier">polymorphic_bin</span><span class="special">(</span><span class="identifier">value_type</span> lower<span class="special">,</span> <span class="identifier">value_type</span> upper<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  66 </div>
  67 <div class="refsect2">
  68 <a name="idm45212146247232"></a><h3>
  69 <a name="idm45414524720672-bb"></a><code class="computeroutput">polymorphic_bin</code> public member functions</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1">
  71 <li class="listitem">
  72 <pre class="literallayout"><a name="idm45414524720112-bb"></a><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Implicitly convert to bin value (for axis with discrete values). </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524718656-bb"></a><span class="identifier">lower</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return lower edge of bin. </li>
  75 <li class="listitem">
  76 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524717232-bb"></a><span class="identifier">upper</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return upper edge of bin. </li>
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524715808-bb"></a><span class="identifier">center</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return center of bin. </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45414524714400-bb"></a><span class="identifier">width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return width of bin. </li>
  81 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45414524712992-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  82 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45414524710336-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  83 <li class="listitem">
  84 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45414524707680-bb"></a><span class="identifier">is_discrete</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return true if bin is discrete. </li>
  85 </ol></div>
  86 </div>
  87 </div>
  88 </div>
  89 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  90 <td align="left"></td>
  91 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  92       Dembinski<p>
  93         Distributed under the Boost Software License, Version 1.0. (See accompanying
  94         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  95       </p>
  96 </div></td>
  97 </tr></table>
  98 <hr>
  99 <div class="spirit-nav">
 100 <a accesskey="p" href="option/growth.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.polymorphic_bin_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="transform/id.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 101 </div>
 102 </body>
 103 </html>