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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template project</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.project_hpp" title="Header &lt;boost/histogram/algorithm/project.hpp&gt;">
   9 <link rel="prev" href="empty.html" title="Function template empty">
  10 <link rel="next" href="project_idm45414525017808.html" title="Function template project">
  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="empty.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.project_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="project_idm45414525017808.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.algorithm.project_idm45414525025232"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template project</span></h2>
  29 <p>boost::histogram::algorithm::project &#8212; Returns a lower-dimensional histogram, summing over removed axes. </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.project_hpp" title="Header &lt;boost/histogram/algorithm/project.hpp&gt;">boost/histogram/algorithm/project.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> A<span class="special">,</span> <span class="keyword">typename</span> S<span class="special">,</span> <span class="keyword">unsigned</span> N<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Ns<span class="special">&gt;</span>
  36   <span class="keyword">auto</span> <span class="identifier">project</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../histogram.html" title="Class template histogram">histogram</a><span class="special">&lt;</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">S</span> <span class="special">&gt;</span> <span class="special">&amp;</span> h<span class="special">,</span>
  37                <span class="identifier">std</span><span class="special">::</span><span class="identifier">integral_constant</span><span class="special">&lt;</span> <span class="keyword">unsigned</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">Ns</span><span class="special">...</span><span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="idm45212148030336"></a><h2>Description</h2>
  40 <p>Arguments are the source histogram and compile-time numbers, the remaining indices of the axes. Returns a new histogram which only contains the subset of axes. The source histogram is summed over the removed axes. </p>
  41 </div>
  42 </div>
  43 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  44 <td align="left"></td>
  45 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  46       Dembinski<p>
  47         Distributed under the Boost Software License, Version 1.0. (See accompanying
  48         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  49       </p>
  50 </div></td>
  51 </tr></table>
  52 <hr>
  53 <div class="spirit-nav">
  54 <a accesskey="p" href="empty.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.project_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="project_idm45414525017808.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  55 </div>
  56 </body>
  57 </html>