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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class index_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&#160;1.&#160;Boost.Histogram">
   8 <link rel="up" href="../accessor.html#idm45212143433696" title="Description">
   9 <link rel="prev" href="../accessor.html" title="Class accessor">
  10 <link rel="next" href="../../coverage.html" title="Type coverage">
  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="../accessor.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accessor.html#idm45212143433696"><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="../../coverage.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.indexed_range.accessor.index_view"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class index_view</span></h2>
  29 <p>boost::histogram::indexed_range::accessor::index_view &#8212; Array-like view into the current 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>
  35
  36 <span class="comment">// Array-like view into the current multi-dimensional index.</span>
  37
  38 <span class="keyword">class</span> <a class="link" href="index_view.html" title="Class index_view">index_view</a> <span class="special">{</span>
  39 <span class="keyword">public</span><span class="special">:</span>
  40   <span class="comment">// types</span>
  41   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>              <a name="boost.histogram.indexed_range.accessor.index_view.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  42   <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 name="boost.histogram.indexed_range.accessor.index_view.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="index_view.html#idm45414524320384-bb">public member functions</a></span>
  45   <a class="link" href="index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a class="link" href="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>
  46   <a class="link" href="index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a class="link" href="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>
  47   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="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>
  48   <span class="identifier">const_reference</span> <a class="link" href="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>
  49   <span class="identifier">const_reference</span> <a class="link" href="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>
  50 <span class="special">}</span><span class="special">;</span></pre></div>
  51 <div class="refsect1">
  52 <a name="idm45212143156208"></a><h2>Description</h2>
  53 <div class="refsect2">
  54 <a name="idm45212143155792"></a><h3>
  55 <a name="idm45414524320384-bb"></a><code class="computeroutput">index_view</code> public member functions</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1">
  57 <li class="listitem"><pre class="literallayout"><a class="link" href="index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a name="idm45414524319824-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  58 <li class="listitem"><pre class="literallayout"><a class="link" href="index_view.html#boost.histogram.indexed_range.accessor.index_view.const_iterator">const_iterator</a> <a name="idm45414524318576-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  59 <li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm45414524317328-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></li>
  60 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm45414524316208-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">unsigned</span> d<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  61 <li class="listitem"><pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm45414524314400-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="keyword">unsigned</span> d<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  62 </ol></div>
  63 </div>
  64 </div>
  65 </div>
  66 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  67 <td align="left"></td>
  68 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  69       Dembinski<p>
  70         Distributed under the Boost Software License, Version 1.0. (See accompanying
  71         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  72       </p>
  73 </div></td>
  74 </tr></table>
  75 <hr>
  76 <div class="spirit-nav">
  77 <a accesskey="p" href="../accessor.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accessor.html#idm45212143433696"><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="../../coverage.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  78 </div>
  79 </body>
  80 </html>