• 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 template empty</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.empty_hpp" title="Header &lt;boost/histogram/algorithm/empty.hpp&gt;">
9<link rel="prev" href="../accumulators/weighted_sum.html" title="Class template weighted_sum">
10<link rel="next" href="project_idm45503931171616.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="../accumulators/weighted_sum.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.empty_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_idm45503931171616.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.algorithm.empty"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template empty</span></h2>
29<p>boost::histogram::algorithm::empty — Check to see if all histogram cells are empty. </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.empty_hpp" title="Header &lt;boost/histogram/algorithm/empty.hpp&gt;">boost/histogram/algorithm/empty.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">&gt;</span>
36  <span class="keyword">auto</span> <span class="identifier">empty</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> <span class="identifier">coverage</span> cov<span class="special">)</span><span class="special">;</span></pre></div>
37<div class="refsect1">
38<a name="idm45113195436192"></a><h2>Description</h2>
39<p>Use coverage to include or exclude the underflow/overflow bins.</p>
40<p>This algorithm has O(N) complexity, where N is the number of cells.</p>
41<p>Returns true if all cells are empty, and false otherwise. </p>
42</div>
43</div>
44<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
45<td align="left"></td>
46<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
47      Dembinski<p>
48        Distributed under the Boost Software License, Version 1.0. (See accompanying
49        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
50      </p>
51</div></td>
52</tr></table>
53<hr>
54<div class="spirit-nav">
55<a accesskey="p" href="../accumulators/weighted_sum.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.empty_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_idm45503931171616.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
56</div>
57</body>
58</html>
59