1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template variant</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.variant_hpp" title="Header <boost/histogram/axis/variant.hpp>"> 9<link rel="prev" href="operator_idm45503930474736.html" title="Function template operator=="> 10<link rel="next" href="../../../histogram/rationale.html" title="Rationale"> 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="operator_idm45503930474736.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.variant_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="../../../histogram/rationale.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.histogram.axis.variant"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template variant</span></h2> 29<p>boost::histogram::axis::variant — Polymorphic axis type. </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.variant_hpp" title="Header <boost/histogram/axis/variant.hpp>">boost/histogram/axis/variant.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Ts<span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">:</span> 36 <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">histogram</span><span class="special">::</span><span class="identifier">axis</span><span class="special">::</span><span class="identifier">iterator_mixin</span><span class="special"><</span> <span class="identifier">variant</span><span class="special"><</span> <span class="identifier">Ts</span><span class="special">...</span> <span class="special">></span> <span class="special">></span> 37<span class="special">{</span> 38<span class="keyword">public</span><span class="special">:</span> 39 <span class="comment">// <a class="link" href="variant.html#boost.histogram.axis.variantconstruct-copy-destruct">construct/copy/destruct</a></span> 40 <a class="link" href="variant.html#idm45503930446128-bb"><span class="identifier">variant</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="variant.html#idm45503930445728-bb"><span class="identifier">variant</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> 42 <a class="link" href="variant.html#idm45503930442080-bb"><span class="identifier">variant</span></a><span class="special">(</span><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> 43 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="variant.html#idm45503930438752-bb"><span class="identifier">variant</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Us<span class="special">></span> <a class="link" href="variant.html#idm45503930435168-bb"><span class="identifier">variant</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a><span class="special"><</span> <span class="identifier">Us</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a class="link" href="variant.html#idm45503930444192-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> 46 <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a class="link" href="variant.html#idm45503930440704-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a class="link" href="variant.html#idm45503930437248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Us<span class="special">></span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a class="link" href="variant.html#idm45503930432928-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a><span class="special"><</span> <span class="identifier">Us</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 49 50 <span class="comment">// <a class="link" href="variant.html#idm45503930467744-bb">public member functions</a></span> 51 <span class="identifier">index_type</span> <a class="link" href="variant.html#idm45503930467184-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 52 <span class="keyword">unsigned</span> <a class="link" href="variant.html#idm45503930465936-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 <span class="keyword">bool</span> <a class="link" href="variant.html#idm45503930464640-bb"><span class="identifier">inclusive</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="keyword">bool</span> <a class="link" href="variant.html#idm45503930463360-bb"><span class="identifier">ordered</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 55 <span class="keyword">bool</span> <a class="link" href="variant.html#idm45503930462080-bb"><span class="identifier">continuous</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 56 <span class="identifier">metadata_type</span> <span class="special">&</span> <a class="link" href="variant.html#idm45503930460800-bb"><span class="identifier">metadata</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 57 <span class="identifier">metadata_type</span> <span class="special">&</span> <a class="link" href="variant.html#idm45503930458768-bb"><span class="identifier">metadata</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 58 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <span class="identifier">index_type</span> <a class="link" href="variant.html#idm45503930457008-bb"><span class="identifier">index</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 59 <span class="keyword">double</span> <a class="link" href="variant.html#idm45503930453904-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="special">;</span> 60 <span class="keyword">auto</span> <a class="link" href="variant.html#idm45503930451392-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="special">;</span> 61 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> <span class="keyword">void</span> <a class="link" href="variant.html#idm45503930448880-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span> 62<span class="special">}</span><span class="special">;</span></pre></div> 63<div class="refsect1"> 64<a name="idm45113190950720"></a><h2>Description</h2> 65<div class="refsect2"> 66<a name="idm45113190950304"></a><h3> 67<a name="boost.histogram.axis.variantconstruct-copy-destruct"></a><code class="computeroutput">variant</code> 68 public 69 construct/copy/destruct</h3> 70<div class="orderedlist"><ol class="orderedlist" type="1"> 71<li class="listitem"><pre class="literallayout"><a name="idm45503930446128-bb"></a><span class="identifier">variant</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li> 72<li class="listitem"><pre class="literallayout"><a name="idm45503930445728-bb"></a><span class="identifier">variant</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li> 73<li class="listitem"><pre class="literallayout"><a name="idm45503930442080-bb"></a><span class="identifier">variant</span><span class="special">(</span><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li> 74<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="idm45503930438752-bb"></a><span class="identifier">variant</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 75<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Us<span class="special">></span> <a name="idm45503930435168-bb"></a><span class="identifier">variant</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a><span class="special"><</span> <span class="identifier">Us</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span> u<span class="special">)</span><span class="special">;</span></pre></li> 76<li class="listitem"><pre class="literallayout"><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a name="idm45503930444192-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li> 77<li class="listitem"><pre class="literallayout"><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a name="idm45503930440704-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li> 78<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a name="idm45503930437248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 79<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Us<span class="special">></span> <a class="link" href="variant.html" title="Class template variant">variant</a> <span class="special">&</span> <a name="idm45503930432928-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a><span class="special"><</span> <span class="identifier">Us</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span> u<span class="special">)</span><span class="special">;</span></pre></li> 80</ol></div> 81</div> 82<div class="refsect2"> 83<a name="idm45113190870384"></a><h3> 84<a name="idm45503930467744-bb"></a><code class="computeroutput">variant</code> public member functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"> 87<pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45503930467184-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return size of axis. </li> 88<li class="listitem"> 89<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idm45503930465936-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return options of axis or option::none_t if axis has no options. </li> 90<li class="listitem"> 91<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45503930464640-bb"></a><span class="identifier">inclusive</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if the axis is inclusive or false. </li> 92<li class="listitem"> 93<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45503930463360-bb"></a><span class="identifier">ordered</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if the axis is ordered or false. </li> 94<li class="listitem"> 95<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45503930462080-bb"></a><span class="identifier">continuous</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if the axis is continuous or false. </li> 96<li class="listitem"> 97<pre class="literallayout"><span class="identifier">metadata_type</span> <span class="special">&</span> <a name="idm45503930460800-bb"></a><span class="identifier">metadata</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return reference to const metadata or instance of <code class="computeroutput"><a class="link" href="null_type.html" title="Struct null_type">null_type</a></code> if axis has no metadata.</li> 98<li class="listitem"> 99<pre class="literallayout"><span class="identifier">metadata_type</span> <span class="special">&</span> <a name="idm45503930458768-bb"></a><span class="identifier">metadata</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Return reference to metadata or instance of <code class="computeroutput"><a class="link" href="null_type.html" title="Struct null_type">null_type</a></code> if axis has no metadata.</li> 100<li class="listitem"> 101<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <span class="identifier">index_type</span> <a name="idm45503930457008-bb"></a><span class="identifier">index</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&</span> u<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return index for value argument. <p>Throws std::invalid_argument if axis has incompatible call signature. </p> 102</li> 103<li class="listitem"> 104<pre class="literallayout"><span class="keyword">double</span> <a name="idm45503930453904-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">real_index_type</span> idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return value for index argument. <p>Only works for axes with value method that returns something convertible to double and will throw a runtime_error otherwise, see axis::traits::value(). </p> 105</li> 106<li class="listitem"> 107<pre class="literallayout"><span class="keyword">auto</span> <a name="idm45503930451392-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="special">;</span></pre>Return bin for index argument. <p>Only works for axes with value method that returns something convertible to double and will throw a runtime_error otherwise, see axis::traits::value(). </p> 108</li> 109<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">></span> <span class="keyword">void</span> <a name="idm45503930448880-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span></pre></li> 110</ol></div> 111</div> 112</div> 113</div> 114<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 115<td align="left"></td> 116<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 117 Dembinski<p> 118 Distributed under the Boost Software License, Version 1.0. (See accompanying 119 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 120 </p> 121</div></td> 122</tr></table> 123<hr> 124<div class="spirit-nav"> 125<a accesskey="p" href="operator_idm45503930474736.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.variant_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="../../../histogram/rationale.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 126</div> 127</body> 128</html> 129
