1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function template value_as</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 <boost/histogram/axis/traits.hpp>"> 9<link rel="prev" href="value.html" title="Function template value"> 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="value.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.value_as"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function template value_as</span></h2> 29<p>boost::histogram::axis::traits::value_as — Returns axis value for index if it is convertible to target type or throws. </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.traits_hpp" title="Header <boost/histogram/axis/traits.hpp>">boost/histogram/axis/traits.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Result<span class="special">,</span> <span class="keyword">typename</span> Axis<span class="special">></span> 36 <span class="identifier">Result</span> <span class="identifier">value_as</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Axis</span> <span class="special">&</span> axis<span class="special">,</span> <span class="identifier">real_index_type</span> index<span class="special">)</span><span class="special">;</span></pre></div> 37<div class="refsect1"> 38<a name="idm45113191824416"></a><h2>Description</h2> 39<p>Like boost::histogram::axis::traits::value, but converts the result into the requested return type. If the conversion is not possible, throws std::runtime_error.</p> 40<p> 41 42</p> 43<div class="variablelist"><table border="0" class="variablelist compact"> 44<colgroup> 45<col align="left" valign="top"> 46<col> 47</colgroup> 48<tbody> 49<tr> 50<td><p><span class="term">Parameters:</span></p></td> 51<td><div class="variablelist"><table border="0" class="variablelist compact"> 52<colgroup> 53<col align="left" valign="top"> 54<col> 55</colgroup> 56<tbody> 57<tr> 58<td><p><span class="term"><code class="computeroutput">axis</code></span></p></td> 59<td><p>any axis instance </p></td> 60</tr> 61<tr> 62<td><p><span class="term"><code class="computeroutput">index</code></span></p></td> 63<td><p>floating point axis index </p></td> 64</tr> 65</tbody> 66</table></div></td> 67</tr> 68<tr> 69<td><p><span class="term">Template Parameters:</span></p></td> 70<td><div class="variablelist"><table border="0" class="variablelist compact"> 71<colgroup> 72<col align="left" valign="top"> 73<col> 74</colgroup> 75<tbody> 76<tr> 77<td><p><span class="term"><code class="computeroutput">Axis</code></span></p></td> 78<td><p>axis type </p></td> 79</tr> 80<tr> 81<td><p><span class="term"><code class="computeroutput">Result</code></span></p></td> 82<td><p>requested return type </p></td> 83</tr> 84</tbody> 85</table></div></td> 86</tr> 87</tbody> 88</table></div> 89</div> 90</div> 91<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 92<td align="left"></td> 93<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 94 Dembinski<p> 95 Distributed under the Boost Software License, Version 1.0. (See accompanying 96 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 97 </p> 98</div></td> 99</tr></table> 100<hr> 101<div class="spirit-nav"> 102<a accesskey="p" href="value.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> 103</div> 104</body> 105</html> 106
