libs/histogram/doc/html/boost/histogram/indexed_range.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template indexed_range</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.indexed_hpp" title="Header &lt;boost/histogram/indexed.hpp&gt;">
   9 <link rel="prev" href="axis/null_type.html" title="Struct null_type">
  10 <link rel="next" href="indexed_range/accessor.html" title="Class accessor">
  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="axis/null_type.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.indexed_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="indexed_range/accessor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.indexed_range"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template indexed_range</span></h2>
  29 <p>boost::histogram::indexed_range &#8212; Input iterator range over histogram bins with multi-dimensional index. </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.indexed_hpp" title="Header &lt;boost/histogram/indexed.hpp&gt;">boost/histogram/indexed.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Histogram<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="indexed_range.html" title="Class template indexed_range">indexed_range</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                                                                              <a name="boost.histogram.indexed_range.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">conditional_t</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">is_const</span><span class="special">&lt;</span> <span class="identifier">histogram_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">histogram_type</span><span class="special">::</span><span class="identifier">const_iterator</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">histogram_type</span><span class="special">::</span><span class="identifier">iterator</span> <span class="special">&gt;</span> <a name="boost.histogram.indexed_range.value_iterator"></a><span class="identifier">value_iterator</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special">&lt;</span> <span class="identifier">value_iterator</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">reference</span>                                                                               <a name="boost.histogram.indexed_range.value_reference"></a><span class="identifier">value_reference</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special">&lt;</span> <span class="identifier">value_iterator</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value_type</span>                                                                              <a name="boost.histogram.indexed_range.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  42
  43   <span class="comment">// member classes/structs/unions</span>
  44
  45   <span class="comment">// Lightweight view to access value and index of current cell.</span>
  46
  47   <span class="keyword">class</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">{</span>
  48   <span class="keyword">public</span><span class="special">:</span>
  49     <span class="comment">// member classes/structs/unions</span>
  50
  51     <span class="comment">// Array-like view into the current multi-dimensional index.</span>
  52
  53     <span class="keyword">class</span> <a class="link" href="indexed_range/accessor/index_view.html" title="Class index_view">index_view</a> <span class="special">{</span>
  54     <span class="keyword">public</span><span class="special">:</span>
  55       <span class="comment">// types</span>
  56       <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>              <a class="link" href="indexed_range/accessor/index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator"><span class="identifier">const_iterator</span></a><span class="special">;</span>
  57       <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> <span class="special">&amp;</span> <a class="link" href="indexed_range/accessor/index_view.html#boost.histogram.indexed_range.accessor.index_view.const_reference"><span class="identifier">const_reference</span></a><span class="special">;</span>
  58
  59       <span class="comment">// <a class="link" href="indexed_range/accessor/index_view.html#idm45414524320384-bb">public member functions</a></span>
  60       <a class="link" href="indexed_range/accessor/index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a class="link" href="indexed_range/accessor/index_view.html#idm45414524319824-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  61       <a class="link" href="indexed_range/accessor/index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a class="link" href="indexed_range/accessor/index_view.html#idm45414524318576-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  62       <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="indexed_range/accessor/index_view.html#idm45414524317328-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>
  63       <span class="identifier">const_reference</span> <a class="link" href="indexed_range/accessor/index_view.html#idm45414524316208-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  64       <span class="identifier">const_reference</span> <a class="link" href="indexed_range/accessor/index_view.html#idm45414524314400-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  65     <span class="special">}</span><span class="special">;</span>
  66     <span class="comment">// <a class="link" href="indexed_range/accessor.html#boost.histogram.indexed_range.accessorconstruct-copy-destruct">construct/copy/destruct</a></span>
  67     <a class="link" href="indexed_range/accessor.html#idm45414524257392-bb"><span class="identifier">accessor</span></a><span class="special">(</span><a class="link" href="indexed_range.html#boost.histogram.indexed_range.iterator">iterator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  68     <a class="link" href="indexed_range/accessor.html#idm45414524255856-bb"><span class="identifier">accessor</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
  69     <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span> <a class="link" href="indexed_range/accessor.html#idm45414524261792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  70     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span> <a class="link" href="indexed_range/accessor.html#idm45414524259792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  71
  72     <span class="comment">// <a class="link" href="indexed_range/accessor.html#idm45414524312432-bb">public member functions</a></span>
  73     <span class="identifier">value_reference</span> <a class="link" href="indexed_range/accessor.html#idm45414524311872-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  74     <span class="identifier">value_reference</span> <a class="link" href="indexed_range/accessor.html#idm45414524310448-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  75     <span class="identifier">value_iterator</span> <a class="link" href="indexed_range/accessor.html#idm45414524309024-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  76     <span class="identifier">axis</span><span class="special">::</span><span class="identifier">index_type</span> <a class="link" href="indexed_range/accessor.html#idm45414524307584-bb"><span class="identifier">index</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  77     <a class="link" href="indexed_range/accessor/index_view.html" title="Class index_view">index_view</a> <a class="link" href="indexed_range/accessor.html#idm45414524304368-bb"><span class="identifier">indices</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  78     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">unsigned</span> N <span class="special">=</span> <span class="number">0</span><span class="special">&gt;</span>
  79       <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="indexed_range/accessor.html#idm45414524302816-bb"><span class="identifier">bin</span></a><span class="special">(</span><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="special">{</span><span class="special">}</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  80     <span class="keyword">decltype</span><span class="special">(</span><span class="keyword">auto</span><span class="special">)</span> <a class="link" href="indexed_range/accessor.html#idm45414524298160-bb"><span class="identifier">bin</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  81     <span class="keyword">double</span> <a class="link" href="indexed_range/accessor.html#idm45414524295232-bb"><span class="identifier">density</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  82     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524292544-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  83     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524290288-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  84     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524288032-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  85     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524285776-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  86     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524283520-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  87     <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524281264-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="indexed_range/accessor.html" title="Class accessor">accessor</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  88     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524279008-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  89     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524276352-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  90     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524273696-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  91     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524271040-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  92     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524268384-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  93     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="indexed_range/accessor.html#idm45414524265728-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">U</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  94     <a class="link" href="indexed_range/accessor.html#idm45414524263072-bb"><span class="keyword">operator</span> <span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
  95   <span class="special">}</span><span class="special">;</span>
  96
  97   <span class="comment">// <a class="link" href="indexed_range.html#boost.histogram.indexed_rangeconstruct-copy-destruct">construct/copy/destruct</a></span>
  98   <a class="link" href="indexed_range.html#idm45414524247360-bb"><span class="identifier">indexed_range</span></a><span class="special">(</span><span class="identifier">histogram_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">coverage</span><span class="special">)</span><span class="special">;</span>
  99
 100   <span class="comment">// <a class="link" href="indexed_range.html#idm45414524250576-bb">public member functions</a></span>
 101   <a class="link" href="indexed_range.html#boost.histogram.indexed_range.iterator">iterator</a> <a class="link" href="indexed_range.html#idm45414524250016-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
 102   <a class="link" href="indexed_range.html#boost.histogram.indexed_range.iterator">iterator</a> <a class="link" href="indexed_range.html#idm45414524248768-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
 103 <span class="special">}</span><span class="special">;</span></pre></div>
 104 <div class="refsect1">
 105 <a name="idm45212143698784"></a><h2>Description</h2>
 106 <p>The iterator returned by begin() can only be incremented. begin() may only be called once, calling it a second time returns the end() iterator. If several copies of the input iterators exist, the other copies become invalid if one of them is incremented. </p>
 107 <div class="refsect2">
 108 <a name="idm45212143697840"></a><h3>
 109 <a name="boost.histogram.indexed_rangeconstruct-copy-destruct"></a><code class="computeroutput">indexed_range</code>
 110         public
 111        construct/copy/destruct</h3>
 112 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45414524247360-bb"></a><span class="identifier">indexed_range</span><span class="special">(</span><span class="identifier">histogram_type</span> <span class="special">&amp;</span> hist<span class="special">,</span> <span class="identifier">coverage</span> cov<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 113 </div>
 114 <div class="refsect2">
 115 <a name="idm45212143689120"></a><h3>
 116 <a name="idm45414524250576-bb"></a><code class="computeroutput">indexed_range</code> public member functions</h3>
 117 <div class="orderedlist"><ol class="orderedlist" type="1">
 118 <li class="listitem"><pre class="literallayout"><a class="link" href="indexed_range.html#boost.histogram.indexed_range.iterator">iterator</a> <a name="idm45414524250016-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 119 <li class="listitem"><pre class="literallayout"><a class="link" href="indexed_range.html#boost.histogram.indexed_range.iterator">iterator</a> <a name="idm45414524248768-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
 120 </ol></div>
 121 </div>
 122 </div>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
 127       Dembinski<p>
 128         Distributed under the Boost Software License, Version 1.0. (See accompanying
 129         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 130       </p>
 131 </div></td>
 132 </tr></table>
 133 <hr>
 134 <div class="spirit-nav">
 135 <a accesskey="p" href="axis/null_type.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../histogram/reference.html#header.boost.histogram.indexed_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="indexed_range/accessor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 136 </div>
 137 </body>
 138 </html>