• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function template metadata</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.traits_hpp" title="Header &lt;boost/histogram/axis/traits.hpp&gt;">
9<link rel="prev" href="is_reducible.html" title="Struct template is_reducible">
10<link rel="next" href="options.html" title="Function template options">
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="is_reducible.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="options.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.axis.traits.metadata"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template metadata</span></h2>
29<p>boost::histogram::axis::traits::metadata — Returns reference to metadata of an axis. </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>
35<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Axis<span class="special">&gt;</span> <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <span class="identifier">metadata</span><span class="special">(</span><span class="identifier">Axis</span> <span class="special">&amp;&amp;</span> axis<span class="special">)</span><span class="special">;</span></pre></div>
36<div class="refsect1">
37<a name="idm45113191945920"></a><h2>Description</h2>
38<p>If the expression x.metadata() for an axis instance <code class="computeroutput">x</code> (maybe const) is valid, return the result. Otherwise, return a reference to a static instance of<code class="computeroutput"><a class="link" href="../null_type.html" title="Struct null_type">boost::histogram::axis::null_type</a></code>.</p>
39<p>
40</p>
41<div class="variablelist"><table border="0" class="variablelist compact">
42<colgroup>
43<col align="left" valign="top">
44<col>
45</colgroup>
46<tbody><tr>
47<td><p><span class="term">Parameters:</span></p></td>
48<td><div class="variablelist"><table border="0" class="variablelist compact">
49<colgroup>
50<col align="left" valign="top">
51<col>
52</colgroup>
53<tbody><tr>
54<td><p><span class="term"><code class="computeroutput">axis</code></span></p></td>
55<td><p>any axis instance </p></td>
56</tr></tbody>
57</table></div></td>
58</tr></tbody>
59</table></div>
60</div>
61</div>
62<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
63<td align="left"></td>
64<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
65      Dembinski<p>
66        Distributed under the Boost Software License, Version 1.0. (See accompanying
67        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
68      </p>
69</div></td>
70</tr></table>
71<hr>
72<div class="spirit-nav">
73<a accesskey="p" href="is_reducible.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="options.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
74</div>
75</body>
76</html>
77