libs/histogram/doc/html/boost/histogram/algorithm/shrink_idm45414524995408.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function shrink</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.algorithm.reduce_hpp" title="Header &lt;boost/histogram/algorithm/reduce.hpp&gt;">
   9 <link rel="prev" href="slice_an_idm45414525001904.html" title="Function slice_and_rebin">
  10 <link rel="next" href="slice_idm45414524989840.html" title="Function slice">
  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="slice_an_idm45414525001904.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_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="slice_idm45414524989840.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.algorithm.shrink_idm45414524995408"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function shrink</span></h2>
  29 <p>boost::histogram::algorithm::shrink &#8212; Shrink option to be used in reduce(). </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.algorithm.reduce_hpp" title="Header &lt;boost/histogram/algorithm/reduce.hpp&gt;">boost/histogram/algorithm/reduce.hpp</a>&gt;
  33
  34 </span>
  35 <span class="identifier">reduce_option</span> <span class="identifier">shrink</span><span class="special">(</span><span class="keyword">unsigned</span> iaxis<span class="special">,</span> <span class="keyword">double</span> lower<span class="special">,</span> <span class="keyword">double</span> upper<span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm45212147839648"></a><h2>Description</h2>
  38 <p>The shrink is inclusive. The bin which contains the first value starts the range of bins to keep. The bin which contains the second value is the last included in that range. When the second value is exactly equal to a lower bin edge, then the previous bin is the last in the range.</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>
  54 <tr>
  55 <td><p><span class="term"><code class="computeroutput">iaxis</code></span></p></td>
  56 <td><p>which axis to operate on. </p></td>
  57 </tr>
  58 <tr>
  59 <td><p><span class="term"><code class="computeroutput">lower</code></span></p></td>
  60 <td><p>bin which contains lower is first to be kept. </p></td>
  61 </tr>
  62 <tr>
  63 <td><p><span class="term"><code class="computeroutput">upper</code></span></p></td>
  64 <td><p>bin which contains upper is last to be kept, except if upper is equal to the lower edge. </p></td>
  65 </tr>
  66 </tbody>
  67 </table></div></td>
  68 </tr></tbody>
  69 </table></div>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  75       Dembinski<p>
  76         Distributed under the Boost Software License, Version 1.0. (See accompanying
  77         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  78       </p>
  79 </div></td>
  80 </tr></table>
  81 <hr>
  82 <div class="spirit-nav">
  83 <a accesskey="p" href="slice_an_idm45414525001904.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_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="slice_idm45414524989840.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  84 </div>
  85 </body>
  86 </html>