• 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 regular</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.regular_hpp" title="Header &lt;boost/histogram/axis/regular.hpp&gt;">
9<link rel="prev" href="circular.html" title="Class template circular">
10<link rel="next" href="traits/continuous.html" title="Function template continuous">
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="circular.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.regular_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="traits/continuous.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.histogram.axis.regular"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template regular</span></h2>
29<p>boost::histogram::axis::regular — Axis for equidistant intervals on the real line. </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.regular_hpp" title="Header &lt;boost/histogram/axis/regular.hpp&gt;">boost/histogram/axis/regular.hpp</a>&gt;
33
34</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Value<span class="special">,</span> <span class="keyword">typename</span> Transform<span class="special">,</span> <span class="keyword">typename</span> MetaData<span class="special">,</span>
35         <span class="keyword">typename</span> Options<span class="special">&gt;</span>
36<span class="keyword">class</span> <a class="link" href="regular.html" title="Class template regular">regular</a> <span class="special">:</span> <span class="keyword">public</span> boost::histogram::axis::iterator_mixin&lt; regular&lt; Value, Transform, MetaData, Options &gt; &gt;,
37                <span class="keyword">public</span> metadata_base_t&lt; MetaData &gt;
38<span class="special">{</span>
39<span class="keyword">public</span><span class="special">:</span>
40  <span class="comment">// <a class="link" href="regular.html#boost.histogram.axis.regularconstruct-copy-destruct">construct/copy/destruct</a></span>
41  <a class="link" href="regular.html#idm45503930738672-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
42  <a class="link" href="regular.html#idm45503930738272-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="identifier">transform_type</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span>
43          <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
44  <a class="link" href="regular.html#idm45503930731552-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
45  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
46    <a class="link" href="regular.html#idm45503930725968-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="identifier">transform_type</span><span class="special">,</span> <span class="identifier">step_type</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span>
47            <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
48  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
49    <a class="link" href="regular.html#idm45503930718368-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="identifier">step_type</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">metadata_type</span> <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span>
50  <a class="link" href="regular.html#idm45503930711904-bb"><span class="identifier">regular</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
51
52  <span class="comment">// <a class="link" href="regular.html#idm45503930760384-bb">public member functions</a></span>
53  <span class="keyword">const</span> <span class="identifier">transform_type</span> <span class="special">&amp;</span> <a class="link" href="regular.html#idm45503930759824-bb"><span class="identifier">transform</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
54  <span class="identifier">index_type</span> <a class="link" href="regular.html#idm45503930758560-bb"><span class="identifier">index</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
55  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">index_type</span> <span class="special">&gt;</span> <a class="link" href="regular.html#idm45503930756608-bb"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
56  <span class="identifier">value_type</span> <a class="link" href="regular.html#idm45503930754608-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">real_index_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
57  <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="regular.html#idm45503930752640-bb"><span class="identifier">bin</span></a><span class="special">(</span><span class="identifier">index_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
58  <span class="identifier">index_type</span> <a class="link" href="regular.html#idm45503930750688-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
59  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">&gt;</span>
60    <span class="keyword">bool</span> <a class="link" href="regular.html#idm45503930749392-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
61  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">&gt;</span>
62    <span class="keyword">bool</span> <a class="link" href="regular.html#idm45503930745408-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
63  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="regular.html#idm45503930741424-bb"><span class="identifier">serialize</span></a><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span>
64
65  <span class="comment">// <a class="link" href="regular.html#idm45503930708224-bb">public static functions</a></span>
66  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a class="link" href="regular.html#idm45503930707664-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
67<span class="special">}</span><span class="special">;</span></pre></div>
68<div class="refsect1">
69<a name="idm45113192499360"></a><h2>Description</h2>
70<p>The most common binning strategy. Very fast. Binning is a O(1) operation.</p>
71<p>
72</p>
73<div class="refsect2">
74<a name="idm45113192498336"></a><h3>Template Parameters</h3>
75<div class="orderedlist"><ol class="orderedlist" type="1">
76<li class="listitem">
77<pre class="literallayout"><span class="keyword">typename</span> Value</pre>
78<p>input value type, must be floating point. </p>
79</li>
80<li class="listitem">
81<pre class="literallayout"><span class="keyword">typename</span> Transform</pre>
82<p>builtin or user-defined transform type. </p>
83</li>
84<li class="listitem">
85<pre class="literallayout"><span class="keyword">typename</span> MetaData</pre>
86<p>type to store meta data. </p>
87</li>
88<li class="listitem">
89<pre class="literallayout"><span class="keyword">typename</span> Options</pre>
90<p>see boost::histogram::axis::option (all values allowed). </p>
91</li>
92</ol></div>
93</div>
94<div class="refsect2">
95<a name="idm45113192488864"></a><h3>
96<a name="boost.histogram.axis.regularconstruct-copy-destruct"></a><code class="computeroutput">regular</code>
97        public
98       construct/copy/destruct</h3>
99<div class="orderedlist"><ol class="orderedlist" type="1">
100<li class="listitem"><pre class="literallayout"><a name="idm45503930738672-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre></li>
101<li class="listitem">
102<pre class="literallayout"><a name="idm45503930738272-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="identifier">transform_type</span> trans<span class="special">,</span> <span class="keyword">unsigned</span> n<span class="special">,</span> <span class="identifier">value_type</span> start<span class="special">,</span> <span class="identifier">value_type</span> stop<span class="special">,</span>
103        <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct n bins over real transformed range [start, stop). <p>
104</p>
105<div class="variablelist"><table border="0" class="variablelist compact">
106<colgroup>
107<col align="left" valign="top">
108<col>
109</colgroup>
110<tbody><tr>
111<td><p><span class="term">Parameters:</span></p></td>
112<td><div class="variablelist"><table border="0" class="variablelist compact">
113<colgroup>
114<col align="left" valign="top">
115<col>
116</colgroup>
117<tbody>
118<tr>
119<td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
120<td><p>description of the axis (optional). </p></td>
121</tr>
122<tr>
123<td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
124<td><p>number of bins. </p></td>
125</tr>
126<tr>
127<td><p><span class="term"><code class="computeroutput">start</code></span></p></td>
128<td><p>low edge of first bin. </p></td>
129</tr>
130<tr>
131<td><p><span class="term"><code class="computeroutput">stop</code></span></p></td>
132<td><p>high edge of last bin. </p></td>
133</tr>
134<tr>
135<td><p><span class="term"><code class="computeroutput">trans</code></span></p></td>
136<td><p>transform instance to use. </p></td>
137</tr>
138</tbody>
139</table></div></td>
140</tr></tbody>
141</table></div>
142</li>
143<li class="listitem">
144<pre class="literallayout"><a name="idm45503930731552-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="keyword">unsigned</span> n<span class="special">,</span> <span class="identifier">value_type</span> start<span class="special">,</span> <span class="identifier">value_type</span> stop<span class="special">,</span>
145        <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct n bins over real range [start, stop). <p>
146</p>
147<div class="variablelist"><table border="0" class="variablelist compact">
148<colgroup>
149<col align="left" valign="top">
150<col>
151</colgroup>
152<tbody><tr>
153<td><p><span class="term">Parameters:</span></p></td>
154<td><div class="variablelist"><table border="0" class="variablelist compact">
155<colgroup>
156<col align="left" valign="top">
157<col>
158</colgroup>
159<tbody>
160<tr>
161<td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
162<td><p>description of the axis (optional). </p></td>
163</tr>
164<tr>
165<td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
166<td><p>number of bins. </p></td>
167</tr>
168<tr>
169<td><p><span class="term"><code class="computeroutput">start</code></span></p></td>
170<td><p>low edge of first bin. </p></td>
171</tr>
172<tr>
173<td><p><span class="term"><code class="computeroutput">stop</code></span></p></td>
174<td><p>high edge of last bin. </p></td>
175</tr>
176</tbody>
177</table></div></td>
178</tr></tbody>
179</table></div>
180</li>
181<li class="listitem">
182<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
183  <a name="idm45503930725968-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="identifier">transform_type</span> trans<span class="special">,</span> <span class="identifier">step_type</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> step<span class="special">,</span> <span class="identifier">value_type</span> start<span class="special">,</span>
184          <span class="identifier">value_type</span> stop<span class="special">,</span> <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct bins with the given step size over real transformed range [start, stop). <p>
185The axis computes the number of bins as n = abs(stop - start) / step, rounded down. This means that stop is an upper limit to the actual value (start + n * step). </p>
186<div class="variablelist"><table border="0" class="variablelist compact">
187<colgroup>
188<col align="left" valign="top">
189<col>
190</colgroup>
191<tbody><tr>
192<td><p><span class="term">Parameters:</span></p></td>
193<td><div class="variablelist"><table border="0" class="variablelist compact">
194<colgroup>
195<col align="left" valign="top">
196<col>
197</colgroup>
198<tbody>
199<tr>
200<td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
201<td><p>description of the axis (optional).</p></td>
202</tr>
203<tr>
204<td><p><span class="term"><code class="computeroutput">start</code></span></p></td>
205<td><p>low edge of first bin. </p></td>
206</tr>
207<tr>
208<td><p><span class="term"><code class="computeroutput">step</code></span></p></td>
209<td><p>width of a single bin. </p></td>
210</tr>
211<tr>
212<td><p><span class="term"><code class="computeroutput">stop</code></span></p></td>
213<td><p>upper limit of high edge of last bin (see below). </p></td>
214</tr>
215<tr>
216<td><p><span class="term"><code class="computeroutput">trans</code></span></p></td>
217<td><p>transform instance to use. </p></td>
218</tr>
219</tbody>
220</table></div></td>
221</tr></tbody>
222</table></div>
223</li>
224<li class="listitem">
225<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
226  <a name="idm45503930718368-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="identifier">step_type</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> step<span class="special">,</span> <span class="identifier">value_type</span> start<span class="special">,</span> <span class="identifier">value_type</span> stop<span class="special">,</span>
227          <span class="identifier">metadata_type</span> meta <span class="special">=</span> <span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">;</span></pre>Construct bins with the given step size over real range [start, stop). <p>
228The axis computes the number of bins as n = abs(stop - start) / step, rounded down. This means that stop is an upper limit to the actual value (start + n * step). </p>
229<div class="variablelist"><table border="0" class="variablelist compact">
230<colgroup>
231<col align="left" valign="top">
232<col>
233</colgroup>
234<tbody><tr>
235<td><p><span class="term">Parameters:</span></p></td>
236<td><div class="variablelist"><table border="0" class="variablelist compact">
237<colgroup>
238<col align="left" valign="top">
239<col>
240</colgroup>
241<tbody>
242<tr>
243<td><p><span class="term"><code class="computeroutput">meta</code></span></p></td>
244<td><p>description of the axis (optional).</p></td>
245</tr>
246<tr>
247<td><p><span class="term"><code class="computeroutput">start</code></span></p></td>
248<td><p>low edge of first bin. </p></td>
249</tr>
250<tr>
251<td><p><span class="term"><code class="computeroutput">step</code></span></p></td>
252<td><p>width of a single bin. </p></td>
253</tr>
254<tr>
255<td><p><span class="term"><code class="computeroutput">stop</code></span></p></td>
256<td><p>upper limit of high edge of last bin (see below). </p></td>
257</tr>
258</tbody>
259</table></div></td>
260</tr></tbody>
261</table></div>
262</li>
263<li class="listitem">
264<pre class="literallayout"><a name="idm45503930711904-bb"></a><span class="identifier">regular</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a> <span class="special">&amp;</span> src<span class="special">,</span> <span class="identifier">index_type</span> begin<span class="special">,</span> <span class="identifier">index_type</span> end<span class="special">,</span> <span class="keyword">unsigned</span> merge<span class="special">)</span><span class="special">;</span></pre>Constructor used by algorithm::reduce to shrink and rebin (not for users). </li>
265</ol></div>
266</div>
267<div class="refsect2">
268<a name="idm45113192387792"></a><h3>
269<a name="idm45503930760384-bb"></a><code class="computeroutput">regular</code> public member functions</h3>
270<div class="orderedlist"><ol class="orderedlist" type="1">
271<li class="listitem">
272<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">transform_type</span> <span class="special">&amp;</span> <a name="idm45503930759824-bb"></a><span class="identifier">transform</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 instance of the transform type. </li>
273<li class="listitem">
274<pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45503930758560-bb"></a><span class="identifier">index</span><span class="special">(</span><span class="identifier">value_type</span> x<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return index for value argument. </li>
275<li class="listitem">
276<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">index_type</span><span class="special">,</span> <span class="identifier">index_type</span> <span class="special">&gt;</span> <a name="idm45503930756608-bb"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">value_type</span> x<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns index and shift (if axis has grown) for the passed argument. </li>
277<li class="listitem">
278<pre class="literallayout"><span class="identifier">value_type</span> <a name="idm45503930754608-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">real_index_type</span> i<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return value for fractional index argument. </li>
279<li class="listitem">
280<pre class="literallayout"><span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a name="idm45503930752640-bb"></a><span class="identifier">bin</span><span class="special">(</span><span class="identifier">index_type</span> idx<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Return bin for index argument. </li>
281<li class="listitem">
282<pre class="literallayout"><span class="identifier">index_type</span> <a name="idm45503930750688-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns the number of bins, without over- or underflow. </li>
283<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">&gt;</span>
284  <span class="keyword">bool</span> <a name="idm45503930749392-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span> <span class="special">&gt;</span> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
285<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> V<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> M<span class="special">,</span> <span class="keyword">typename</span> O<span class="special">&gt;</span>
286  <span class="keyword">bool</span> <a name="idm45503930745408-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="regular.html" title="Class template regular">regular</a><span class="special">&lt;</span> <span class="identifier">V</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">M</span><span class="special">,</span> <span class="identifier">O</span> <span class="special">&gt;</span> <span class="special">&amp;</span> o<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
287<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Archive<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45503930741424-bb"></a><span class="identifier">serialize</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</span> ar<span class="special">,</span> <span class="keyword">unsigned</span><span class="special">)</span><span class="special">;</span></pre></li>
288</ol></div>
289</div>
290<div class="refsect2">
291<a name="idm45113192290912"></a><h3>
292<a name="idm45503930708224-bb"></a><code class="computeroutput">regular</code> public static functions</h3>
293<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
294<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">unsigned</span> <a name="idm45503930707664-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Returns the options. </li></ol></div>
295</div>
296</div>
297</div>
298<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
299<td align="left"></td>
300<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans
301      Dembinski<p>
302        Distributed under the Boost Software License, Version 1.0. (See accompanying
303        file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
304      </p>
305</div></td>
306</tr></table>
307<hr>
308<div class="spirit-nav">
309<a accesskey="p" href="circular.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.regular_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="traits/continuous.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
310</div>
311</body>
312</html>
313