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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template reduce</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="rebin_idm45525156089728.html" title="Function rebin">
  10 <link rel="next" href="reduce_idm45525156080832.html" title="Function template reduce">
  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="rebin_idm45525156089728.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="reduce_idm45525156080832.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.algorithm.reduce_idm45525156086992"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template reduce</span></h2>
  29 <p>boost::histogram::algorithm::reduce &#8212; Shrink, slice, and/or rebin axes of a histogram. </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="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Histogram<span class="special">,</span> <span class="keyword">typename</span> Iterable<span class="special">&gt;</span>
  36   <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <span class="identifier">reduce</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Histogram</span> <span class="special">&amp;</span> hist<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Iterable</span> <span class="special">&amp;</span> options<span class="special">)</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm45952481573088"></a><h2>Description</h2>
  39 <p>Returns the reduced copy of the histogram.</p>
  40 <p>Shrinking only works with axes that accept double values. Some axis types do not support the reduce operation, for example, the builtin category axis, which is not ordered. Custom axis types must implement a special constructor (see concepts) to be reducible.</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">hist</code></span></p></td>
  58 <td><p>original histogram. </p></td>
  59 </tr>
  60 <tr>
  61 <td><p><span class="term"><code class="computeroutput">options</code></span></p></td>
  62 <td><p>iterable sequence of reduce options, generated by shrink_and_rebin(), slice_and_rebin(), shrink(), slice(), and rebin(). </p></td>
  63 </tr>
  64 </tbody>
  65 </table></div></td>
  66 </tr></tbody>
  67 </table></div>
  68 </div>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  73       Dembinski<p>
  74         Distributed under the Boost Software License, Version 1.0. (See accompanying
  75         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  76       </p>
  77 </div></td>
  78 </tr></table>
  79 <hr>
  80 <div class="spirit-nav">
  81 <a accesskey="p" href="rebin_idm45525156089728.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="reduce_idm45525156080832.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  82 </div>
  83 </body>
  84 </html>