• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function shrink_and_rebin</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.algorithm.reduce_hpp" title="Header &lt;boost/histogram/algorithm/reduce.hpp&gt;">
9<link rel="prev" href="shrink_idm45503931088784.html" title="Function shrink">
10<link rel="next" href="shrink_a_idm45503931075120.html" title="Function shrink_and_rebin">
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="shrink_idm45503931088784.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="shrink_a_idm45503931075120.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.algorithm.shrink_a_idm45503931082784"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function shrink_and_rebin</span></h2>
29<p>boost::histogram::algorithm::shrink_and_rebin — Shrink and rebin command to be used in <code class="computeroutput">reduce</code>.</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_command</span>
36<span class="identifier">shrink_and_rebin</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="keyword">unsigned</span> merge<span class="special">)</span><span class="special">;</span></pre></div>
37<div class="refsect1">
38<a name="idm45113194945296"></a><h2>Description</h2>
39<p>Command is applied to corresponding axis in order of reduce arguments.</p>
40<p>To shrink(unsigned, double, double) and rebin(unsigned, unsigned) in one command (see the respective commands for more details). Equivalent to passing both commands for the same axis to <code class="computeroutput">reduce</code>.</p>
41<p>
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><tr>
49<td><p><span class="term">Parameters:</span></p></td>
50<td><div class="variablelist"><table border="0" class="variablelist compact">
51<colgroup>
52<col align="left" valign="top">
53<col>
54</colgroup>
55<tbody>
56<tr>
57<td><p><span class="term"><code class="computeroutput">iaxis</code></span></p></td>
58<td><p>which axis to operate on. </p></td>
59</tr>
60<tr>
61<td><p><span class="term"><code class="computeroutput">lower</code></span></p></td>
62<td><p>lowest bound that should be kept. </p></td>
63</tr>
64<tr>
65<td><p><span class="term"><code class="computeroutput">merge</code></span></p></td>
66<td><p>how many adjacent bins to merge into one. </p></td>
67</tr>
68<tr>
69<td><p><span class="term"><code class="computeroutput">upper</code></span></p></td>
70<td><p>highest bound that should be kept. If upper is inside bin interval, the whole interval is removed. </p></td>
71</tr>
72</tbody>
73</table></div></td>
74</tr></tbody>
75</table></div>
76</div>
77</div>
78<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
79<td align="left"></td>
80<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
81      Dembinski<p>
82        Distributed under the Boost Software License, Version 1.0. (See accompanying
83        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
84      </p>
85</div></td>
86</tr></table>
87<hr>
88<div class="spirit-nav">
89<a accesskey="p" href="shrink_idm45503931088784.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="shrink_a_idm45503931075120.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
90</div>
91</body>
92</html>
93