• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Class template interval_view</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.axis.interval_view_hpp" title="Header &lt;boost/histogram/axis/interval_view.hpp&gt;">
9<link rel="prev" href="integer.html" title="Class template integer">
10<link rel="next" href="iterator_mixin.html" title="Class template iterator_mixin">
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="integer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.interval_view_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="iterator_mixin.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.axis.interval_view"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template interval_view</span></h2>
29<p>boost::histogram::axis::interval_view — Lightweight bin view. </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.axis.interval_view_hpp" title="Header &lt;boost/histogram/axis/interval_view.hpp&gt;">boost/histogram/axis/interval_view.hpp</a>&gt;
33
34</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Axis<span class="special">&gt;</span>
35<span class="keyword">class</span> <a class="link" href="interval_view.html" title="Class template interval_view">interval_view</a> <span class="special">{</span>
36<span class="keyword">public</span><span class="special">:</span>
37  <span class="comment">// <a class="link" href="interval_view.html#boost.histogram.axis.interval_viewconstruct-copy-destruct">construct/copy/destruct</a></span>
38  <a class="link" href="interval_view.html#idm45503930873584-bb"><span class="identifier">interval_view</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Axis</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">)</span><span class="special">;</span>
39  <a class="link" href="interval_view.html#idm45503930872080-bb"><span class="identifier">interval_view</span></a><span class="special">(</span><span class="identifier">Axis</span> <span class="special">&amp;&amp;</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
40
41  <span class="comment">// <a class="link" href="interval_view.html#idm45503930883840-bb">public member functions</a></span>
42  <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="interval_view.html#idm45503930883280-bb"><span class="identifier">lower</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
43  <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="interval_view.html#idm45503930882016-bb"><span class="identifier">upper</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
44  <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="interval_view.html#idm45503930880752-bb"><span class="identifier">center</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
45  <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="interval_view.html#idm45503930879504-bb"><span class="identifier">width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
46  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="interval_view.html#idm45503930878256-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
47  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="interval_view.html#idm45503930875920-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
48<span class="special">}</span><span class="special">;</span></pre></div>
49<div class="refsect1">
50<a name="idm45113193726992"></a><h2>Description</h2>
51<p>Represents the current bin interval. </p>
52<div class="refsect2">
53<a name="idm45113193726272"></a><h3>
54<a name="boost.histogram.axis.interval_viewconstruct-copy-destruct"></a><code class="computeroutput">interval_view</code>
55        public
56       construct/copy/destruct</h3>
57<div class="orderedlist"><ol class="orderedlist" type="1">
58<li class="listitem"><pre class="literallayout"><a name="idm45503930873584-bb"></a><span class="identifier">interval_view</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Axis</span> <span class="special">&amp;</span> axis<span class="special">,</span> <span class="identifier">index_type</span> idx<span class="special">)</span><span class="special">;</span></pre></li>
59<li class="listitem"><pre class="literallayout"><a name="idm45503930872080-bb"></a><span class="identifier">interval_view</span><span class="special">(</span><span class="identifier">Axis</span> <span class="special">&amp;&amp;</span> axis<span class="special">,</span> <span class="identifier">index_type</span> idx<span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
60</ol></div>
61</div>
62<div class="refsect2">
63<a name="idm45113193708992"></a><h3>
64<a name="idm45503930883840-bb"></a><code class="computeroutput">interval_view</code> public member functions</h3>
65<div class="orderedlist"><ol class="orderedlist" type="1">
66<li class="listitem">
67<pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45503930883280-bb"></a><span class="identifier">lower</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return lower edge of bin. </li>
68<li class="listitem">
69<pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45503930882016-bb"></a><span class="identifier">upper</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return upper edge of bin. </li>
70<li class="listitem">
71<pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45503930880752-bb"></a><span class="identifier">center</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return center of bin. </li>
72<li class="listitem">
73<pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45503930879504-bb"></a><span class="identifier">width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return width of bin. </li>
74<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45503930878256-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
75<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BinType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm45503930875920-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">BinType</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
76</ol></div>
77</div>
78</div>
79</div>
80<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
81<td align="left"></td>
82<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
83      Dembinski<p>
84        Distributed under the Boost Software License, Version 1.0. (See accompanying
85        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
86      </p>
87</div></td>
88</tr></table>
89<hr>
90<div class="spirit-nav">
91<a accesskey="p" href="integer.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.interval_view_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="iterator_mixin.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
92</div>
93</body>
94</html>
95