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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template value</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="metadata.html" title="Function template metadata">
  10 <link rel="next" href="value_as.html" title="Function template value_as">
  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="metadata.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_as.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"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template value</span></h2>
  29 <p>boost::histogram::axis::traits::value &#8212; Returns axis value for index. </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>
  36   <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <span class="identifier">value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Axis</span> <span class="special">&amp;</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="idm45212145134272"></a><h2>Description</h2>
  39 <p>If the axis has no <code class="computeroutput">value</code> method, throw std::runtime_error. If the method exists and accepts a floating point index, pass the index and return the result. If the method exists but accepts only integer indices, cast the floating point index to int, pass this index and return the result.</p>
  40 <p>
  41 </p>
  42 <div class="variablelist"><table border="0" class="variablelist compact">
  43 <colgroup>
  44 <col align="left" valign="top">
  45 <col>
  46 </colgroup>
  47 <tbody><tr>
  48 <td><p><span class="term">Parameters:</span></p></td>
  49 <td><div class="variablelist"><table border="0" class="variablelist compact">
  50 <colgroup>
  51 <col align="left" valign="top">
  52 <col>
  53 </colgroup>
  54 <tbody>
  55 <tr>
  56 <td><p><span class="term"><code class="computeroutput">axis</code></span></p></td>
  57 <td><p>any axis instance </p></td>
  58 </tr>
  59 <tr>
  60 <td><p><span class="term"><code class="computeroutput">index</code></span></p></td>
  61 <td><p>floating point axis index </p></td>
  62 </tr>
  63 </tbody>
  64 </table></div></td>
  65 </tr></tbody>
  66 </table></div>
  67 </div>
  68 </div>
  69 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  70 <td align="left"></td>
  71 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  72       Dembinski<p>
  73         Distributed under the Boost Software License, Version 1.0. (See accompanying
  74         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  75       </p>
  76 </div></td>
  77 </tr></table>
  78 <hr>
  79 <div class="spirit-nav">
  80 <a accesskey="p" href="metadata.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_as.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  81 </div>
  82 </body>
  83 </html>