1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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 1. Boost.Histogram"> 8<link rel="up" href="../../../histogram/reference.html#header.boost.histogram.axis.polymorphic_bin_hpp" title="Header <boost/histogram/axis/polymorphic_bin.hpp>"> 9<link rel="prev" href="option/underflow.html" title="Global underflow"> 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/underflow.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 — 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: <<a class="link" href="../../../histogram/reference.html#header.boost.histogram.axis.polymorphic_bin_hpp" title="Header <boost/histogram/axis/polymorphic_bin.hpp>">boost/histogram/axis/polymorphic_bin.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RealType<span class="special">></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#idm45503930773600-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#idm45503930786416-bb">public member functions</a></span> 41 <a class="link" href="polymorphic_bin.html#idm45503930785856-bb"><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</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#idm45503930784560-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#idm45503930783296-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#idm45503930782032-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#idm45503930780784-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"><</span><span class="keyword">typename</span> BinType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="polymorphic_bin.html#idm45503930779536-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">&</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"><</span><span class="keyword">typename</span> BinType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="polymorphic_bin.html#idm45503930777200-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">&</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#idm45503930774864-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="idm45113193116096"></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<div class="refsect2"> 59<a name="idm45113193110096"></a><h3> 60<a name="boost.histogram.axis.polymorphic_binconstruct-copy-destruct"></a><code class="computeroutput">polymorphic_bin</code> 61 public 62 construct/copy/destruct</h3> 63<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45503930773600-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> 64</div> 65<div class="refsect2"> 66<a name="idm45113193102032"></a><h3> 67<a name="idm45503930786416-bb"></a><code class="computeroutput">polymorphic_bin</code> public member functions</h3> 68<div class="orderedlist"><ol class="orderedlist" type="1"> 69<li class="listitem"> 70<pre class="literallayout"><a name="idm45503930785856-bb"></a><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&</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> 71<li class="listitem"> 72<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45503930784560-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> 73<li class="listitem"> 74<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45503930783296-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> 75<li class="listitem"> 76<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45503930782032-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> 77<li class="listitem"> 78<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45503930780784-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> 79<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BinType<span class="special">></span> <span class="keyword">bool</span> <a name="idm45503930779536-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 80<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BinType<span class="special">></span> <span class="keyword">bool</span> <a name="idm45503930777200-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 81<li class="listitem"> 82<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45503930774864-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> 83</ol></div> 84</div> 85</div> 86</div> 87<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 88<td align="left"></td> 89<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 90 Dembinski<p> 91 Distributed under the Boost Software License, Version 1.0. (See accompanying 92 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 93 </p> 94</div></td> 95</tr></table> 96<hr> 97<div class="spirit-nav"> 98<a accesskey="p" href="option/underflow.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> 99</div> 100</body> 101</html> 102
