libs/histogram/doc/html/boost/histogram/axis/traits/static_options.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template static_options</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.traits_hpp" title="Header &lt;boost/histogram/axis/traits.hpp&gt;">
   9 <link rel="prev" href="static_is_inclusive.html" title="Struct template static_is_inclusive">
  10 <link rel="next" href="value_type.html" title="Struct template value_type">
  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="static_is_inclusive.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../histogram/reference.html#header.boost.histogram.axis.traits_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="value_type.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.traits.static_options"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template static_options</span></h2>
  29 <p>boost::histogram::axis::traits::static_options &#8212; Get static axis options for 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: &lt;<a class="link" href="../../../../histogram/reference.html#header.boost.histogram.axis.traits_hpp" title="Header &lt;boost/histogram/axis/traits.hpp&gt;">boost/histogram/axis/traits.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Axis<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="static_options.html" title="Struct template static_options">static_options</a> <span class="special">{</span>
  36 <span class="special">}</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm45212145234944"></a><h2>Description</h2>
  39 <p>Doxygen does not render this well. This is a meta-function (template alias), it accepts an axis type and returns the <a class="link" href="../option/bitset.html" title="Struct template bitset">boost::histogram::axis::option::bitset</a>.</p>
  40 <p>If Axis::options() is valid and constexpr, <a class="link" href="static_options.html" title="Struct template static_options">static_options</a> is the corresponding option type. Otherwise, it is boost::histogram::axis::option::growth_t, if the axis has a method <code class="computeroutput">update</code>, else boost::histogram::axis::option::none_t.</p>
  41 <p>
  42 </p>
  43 <div class="refsect2">
  44 <a name="idm45212145231040"></a><h3>Template Parameters</h3>
  45 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  46 <pre class="literallayout"><span class="keyword">typename</span> Axis</pre>
  47 <p>axis type </p>
  48 </li></ol></div>
  49 </div>
  50 </div>
  51 </div>
  52 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  53 <td align="left"></td>
  54 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  55       Dembinski<p>
  56         Distributed under the Boost Software License, Version 1.0. (See accompanying
  57         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  58       </p>
  59 </div></td>
  60 </tr></table>
  61 <hr>
  62 <div class="spirit-nav">
  63 <a accesskey="p" href="static_is_inclusive.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../histogram/reference.html#header.boost.histogram.axis.traits_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="value_type.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  64 </div>
  65 </body>
  66 </html>