1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function slice</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 <boost/histogram/algorithm/reduce.hpp>"> 9<link rel="prev" href="slice_idm45503931067744.html" title="Function slice"> 10<link rel="next" href="slice_an_idm45503931050704.html" title="Function slice_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="slice_idm45503931067744.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_an_idm45503931050704.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.histogram.algorithm.slice_idm45503931058672"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function slice</span></h2> 29<p>boost::histogram::algorithm::slice — Slice 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: <<a class="link" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_hpp" title="Header <boost/histogram/algorithm/reduce.hpp>">boost/histogram/algorithm/reduce.hpp</a>> 33 34</span> 35<span class="identifier">reduce_command</span> 36<span class="identifier">slice</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> 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="idm45113194872192"></a><h2>Description</h2> 40<p>Command is applied to corresponding axis in order of reduce arguments.</p> 41<p>Slicing works like <code class="computeroutput">shrink</code> or<code class="computeroutput">crop</code>, but uses bin indices instead of values.</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">mode</code></span></p></td> 67<td><p>whether to behave like <code class="computeroutput">shrink</code> or<code class="computeroutput">crop</code> regarding removed bins.</p></td> 68</tr> 69</tbody> 70</table></div></td> 71</tr></tbody> 72</table></div> 73</div> 74</div> 75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 76<td align="left"></td> 77<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 78 Dembinski<p> 79 Distributed under the Boost Software License, Version 1.0. (See accompanying 80 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 81 </p> 82</div></td> 83</tr></table> 84<hr> 85<div class="spirit-nav"> 86<a accesskey="p" href="slice_idm45503931067744.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_an_idm45503931050704.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 87</div> 88</body> 89</html> 90
