• 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 slice_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="slice_an_idm45503931050704.html" title="Function slice_and_rebin">
10<link rel="next" href="sum.html" title="Function template sum">
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_idm45503931050704.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="sum.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.algorithm.slice_an_idm45503931040864"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function slice_and_rebin</span></h2>
29<p>boost::histogram::algorithm::slice_and_rebin — Slice 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">slice_and_rebin</span><span class="special">(</span><span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> begin<span class="special">,</span> <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> end<span class="special">,</span> <span class="keyword">unsigned</span> merge<span class="special">,</span>
37                <span class="identifier">slice_mode</span> mode <span class="special">=</span> <span class="identifier">slice_mode</span><span class="special">::</span><span class="identifier">shrink</span><span class="special">)</span><span class="special">;</span></pre></div>
38<div class="refsect1">
39<a name="idm45113194815392"></a><h2>Description</h2>
40<p>Command is applied to corresponding axis in order of reduce arguments.</p>
41<p>To <code class="computeroutput">slice</code> and<code class="computeroutput">rebin</code> 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>
42<p>
43</p>
44<div class="variablelist"><table border="0" class="variablelist compact">
45<colgroup>
46<col align="left" valign="top">
47<col>
48</colgroup>
49<tbody><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">begin</code></span></p></td>
59<td><p>first index that should be kept. </p></td>
60</tr>
61<tr>
62<td><p><span class="term"><code class="computeroutput">end</code></span></p></td>
63<td><p>one past the last index that should be kept. </p></td>
64</tr>
65<tr>
66<td><p><span class="term"><code class="computeroutput">merge</code></span></p></td>
67<td><p>how many adjacent bins to merge into one. </p></td>
68</tr>
69<tr>
70<td><p><span class="term"><code class="computeroutput">mode</code></span></p></td>
71<td><p>slice mode, see slice_mode. </p></td>
72</tr>
73</tbody>
74</table></div></td>
75</tr></tbody>
76</table></div>
77</div>
78</div>
79<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
80<td align="left"></td>
81<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
82      Dembinski<p>
83        Distributed under the Boost Software License, Version 1.0. (See accompanying
84        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
85      </p>
86</div></td>
87</tr></table>
88<hr>
89<div class="spirit-nav">
90<a accesskey="p" href="slice_an_idm45503931050704.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="sum.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
91</div>
92</body>
93</html>
94