libs/histogram/doc/html/boost/histogram/axis/transform/pow.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct pow</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.regular_hpp" title="Header &lt;boost/histogram/axis/regular.hpp&gt;">
   9 <link rel="prev" href="log.html" title="Struct log">
  10 <link rel="next" href="sqrt.html" title="Struct sqrt">
  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="log.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../histogram/reference.html#header.boost.histogram.axis.regular_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="sqrt.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.transform.pow"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct pow</span></h2>
  29 <p>boost::histogram::axis::transform::pow &#8212; Pow transform for equidistant bins in pow-space. </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.regular_hpp" title="Header &lt;boost/histogram/axis/regular.hpp&gt;">boost/histogram/axis/regular.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">struct</span> <a class="link" href="pow.html" title="Struct pow">pow</a> <span class="special">{</span>
  36   <span class="comment">// <a class="link" href="pow.html#boost.histogram.axis.transform.powconstruct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="pow.html#idm45414524594672-bb"><span class="identifier">pow</span></a><span class="special">(</span><span class="keyword">double</span><span class="special">)</span><span class="special">;</span>
  38   <a class="link" href="pow.html#idm45414524593120-bb"><span class="identifier">pow</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="pow.html#idm45414524606672-bb">public member functions</a></span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">auto</span> <a class="link" href="pow.html#idm45414524606112-bb"><span class="identifier">forward</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">auto</span> <a class="link" href="pow.html#idm45414524603136-bb"><span class="identifier">inverse</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="keyword">bool</span> <a class="link" href="pow.html#idm45414524600160-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pow.html" title="Struct pow">pow</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  44   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="pow.html#idm45414524597904-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
  45
  46   <span class="comment">// public data members</span>
  47   <span class="keyword">double</span> <span class="identifier">power</span><span class="special">;</span>  <span class="comment">// power index </span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idm45212145949504"></a><h2>Description</h2>
  51 <div class="refsect2">
  52 <a name="idm45212145949088"></a><h3>
  53 <a name="boost.histogram.axis.transform.powconstruct-copy-destruct"></a><code class="computeroutput">pow</code>
  54         public
  55        construct/copy/destruct</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1">
  57 <li class="listitem">
  58 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45414524594672-bb"></a><span class="identifier">pow</span><span class="special">(</span><span class="keyword">double</span> p<span class="special">)</span><span class="special">;</span></pre>Make transform with index p. </li>
  59 <li class="listitem"><pre class="literallayout"><a name="idm45414524593120-bb"></a><span class="identifier">pow</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
  60 </ol></div>
  61 </div>
  62 <div class="refsect2">
  63 <a name="idm45212145936560"></a><h3>
  64 <a name="idm45414524606672-bb"></a><code class="computeroutput">pow</code> public member functions</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1">
  66 <li class="listitem">
  67 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">auto</span> <a name="idm45414524606112-bb"></a><span class="identifier">forward</span><span class="special">(</span><span class="identifier">T</span> x<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns pow(x, power) of external value x. </li>
  68 <li class="listitem">
  69 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">auto</span> <a name="idm45414524603136-bb"></a><span class="identifier">inverse</span><span class="special">(</span><span class="identifier">T</span> x<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns pow(x, 1/power) of external value x. </li>
  70 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45414524600160-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pow.html" title="Struct pow">pow</a> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  71 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45414524597904-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span></pre></li>
  72 </ol></div>
  73 </div>
  74 </div>
  75 </div>
  76 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  77 <td align="left"></td>
  78 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  79       Dembinski<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="log.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../histogram/reference.html#header.boost.histogram.axis.regular_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="sqrt.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>