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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template metadata_base</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.metadata_base_hpp" title="Header &lt;boost/histogram/axis/metadata_base.hpp&gt;">
   9 <link rel="prev" href="iterator_mixin.html" title="Class template iterator_mixin">
  10 <link rel="next" href="option/bit.html" title="Struct template bit">
  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="iterator_mixin.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_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="option/bit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.metadata_base"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template metadata_base</span></h2>
  29 <p>boost::histogram::axis::metadata_base &#8212; Meta data holder with space optimization for empty meta data types. </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.metadata_base_hpp" title="Header &lt;boost/histogram/axis/metadata_base.hpp&gt;">boost/histogram/axis/metadata_base.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Metadata<span class="special">,</span>
  35          <span class="keyword">typename</span> DetailMetadata <span class="special">=</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">replace_default</span><span class="special">&lt;</span><span class="identifier">Metadata</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;</span> <span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">empty_value</span><span class="special">&lt;</span> <span class="identifier">DetailMetadata</span> <span class="special">&gt;</span> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="metadata_base.html#boost.histogram.axis.metadata_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="metadata_base.html#idm45414524797488-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  40   <a class="link" href="metadata_base.html#idm45414524796928-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  41   <a class="link" href="metadata_base.html#idm45414524792960-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  42   <a class="link" href="metadata_base.html#idm45414524791424-bb"><span class="identifier">metadata_base</span></a><span class="special">(</span><span class="identifier">metadata_type</span> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  43   <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm45414524795232-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  44   <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm45414524790176-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="metadata_base.html#idm45414524788064-bb">public member functions</a></span>
  47   <span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm45414524787504-bb"><span class="identifier">metadata</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  48   <span class="keyword">const</span> <span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a class="link" href="metadata_base.html#idm45414524786080-bb"><span class="identifier">metadata</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="keyword">bool</span> <a class="link" href="metadata_base.html#idm45414524784656-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  50   <span class="keyword">bool</span> <a class="link" href="metadata_base.html#idm45414524782400-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  51 <span class="special">}</span><span class="special">;</span></pre></div>
  52 <div class="refsect1">
  53 <a name="idm45212146648208"></a><h2>Description</h2>
  54 <div class="refsect2">
  55 <a name="idm45212146647824"></a><h3>
  56 <a name="boost.histogram.axis.metadata_baseconstruct-copy-destruct"></a><code class="computeroutput">metadata_base</code>
  57         public
  58        construct/copy/destruct</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1">
  60 <li class="listitem"><pre class="literallayout"><a name="idm45414524797488-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  61 <li class="listitem"><pre class="literallayout"><a name="idm45414524796928-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  62 <li class="listitem"><pre class="literallayout"><a name="idm45414524792960-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  63 <li class="listitem"><pre class="literallayout"><a name="idm45414524791424-bb"></a><span class="identifier">metadata_base</span><span class="special">(</span><span class="identifier">metadata_type</span> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  64 <li class="listitem"><pre class="literallayout"><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a name="idm45414524795232-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  65 <li class="listitem"><pre class="literallayout"><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;</span> <a name="idm45414524790176-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <span class="special">&amp;&amp;</span> o<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  66 </ol></div>
  67 </div>
  68 <div class="refsect2">
  69 <a name="idm45212146604976"></a><h3>
  70 <a name="idm45414524788064-bb"></a><code class="computeroutput">metadata_base</code> public member functions</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a name="idm45414524787504-bb"></a><span class="identifier">metadata</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns reference to metadata. </li>
  74 <li class="listitem">
  75 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">metadata_type</span> <span class="special">&amp;</span> <a name="idm45414524786080-bb"></a><span class="identifier">metadata</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 reference to const metadata. </li>
  76 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45414524784656-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <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>
  77 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45414524782400-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="metadata_base.html" title="Class template metadata_base">metadata_base</a> <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>
  78 </ol></div>
  79 </div>
  80 </div>
  81 </div>
  82 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  83 <td align="left"></td>
  84 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  85       Dembinski<p>
  86         Distributed under the Boost Software License, Version 1.0. (See accompanying
  87         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  88       </p>
  89 </div></td>
  90 </tr></table>
  91 <hr>
  92 <div class="spirit-nav">
  93 <a accesskey="p" href="iterator_mixin.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.metadata_base_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="option/bit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  94 </div>
  95 </body>
  96 </html>