• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Struct template value_type</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="value_as.html" title="Function template value_as">
10<link rel="next" href="width.html" title="Function template width">
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="value_as.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="width.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.axis.traits.value_type"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Struct template value_type</span></h2>
29<p>boost::histogram::axis::traits::value_type — Value type 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="value_type.html" title="Struct template value_type">value_type</a> <span class="special">{</span>
36<span class="special">}</span><span class="special">;</span></pre></div>
37<div class="refsect1">
38<a name="idm45113191805456"></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 value type.</p>
40<p>The value type is deduced from the argument of the <code class="computeroutput">Axis::index</code> method. Const references are decayed to the their value types, for example, the type deduced for<code class="computeroutput">Axis::index(const int&amp;)</code> is<code class="computeroutput">int</code>.</p>
41<p>The deduction always succeeds if the axis type models the Axis concept correctly. Errors come from violations of the concept, in particular, an index method that is templated or overloaded is not allowed.</p>
42<p>
43</p>
44<div class="refsect2">
45<a name="idm45113191801408"></a><h3>Template Parameters</h3>
46<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
47<pre class="literallayout"><span class="keyword">typename</span> Axis</pre>
48<p>axis type. </p>
49</li></ol></div>
50</div>
51</div>
52</div>
53<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
54<td align="left"></td>
55<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
56      Dembinski<p>
57        Distributed under the Boost Software License, Version 1.0. (See accompanying
58        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
59      </p>
60</div></td>
61</tr></table>
62<hr>
63<div class="spirit-nav">
64<a accesskey="p" href="value_as.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="width.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
65</div>
66</body>
67</html>
68