libs/histogram/doc/html/boost/histogram/axis/iterator_mixin.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template iterator_mixin</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.axis.iterator_hpp" title="Header &lt;boost/histogram/axis/iterator.hpp&gt;">
   9 <link rel="prev" href="interval_view.html" title="Class template interval_view">
  10 <link rel="next" href="metadata_base.html" title="Class template metadata_base">
  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="interval_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.iterator_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="metadata_base.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.histogram.axis.iterator_mixin"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template iterator_mixin</span></h2>
  29 <p>boost::histogram::axis::iterator_mixin &#8212; Uses CRTP to inject iterator logic into Derived. </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.iterator_hpp" title="Header &lt;boost/histogram/axis/iterator.hpp&gt;">boost/histogram/axis/iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Derived<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="iterator_mixin.html" title="Class template iterator_mixin">iterator_mixin</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="identifier">iterator</span><span class="special">&lt;</span> <span class="identifier">Derived</span> <span class="special">&gt;</span>                     <a name="boost.histogram.axis.iterator_mixin.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">reverse_iterator</span><span class="special">&lt;</span> <span class="identifier">const_iterator</span> <span class="special">&gt;</span> <a name="boost.histogram.axis.iterator_mixin.const_reverse_iterator"></a><span class="identifier">const_reverse_iterator</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="iterator_mixin.html#idm45414524810832-bb">public member functions</a></span>
  42   <span class="identifier">const_iterator</span> <a class="link" href="iterator_mixin.html#idm45414524810272-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>
  43   <span class="identifier">const_iterator</span> <a class="link" href="iterator_mixin.html#idm45414524808832-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>
  44   <span class="identifier">const_reverse_iterator</span> <a class="link" href="iterator_mixin.html#idm45414524807392-bb"><span class="identifier">rbegin</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="identifier">const_reverse_iterator</span> <a class="link" href="iterator_mixin.html#idm45414524805936-bb"><span class="identifier">rend</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="special">}</span><span class="special">;</span></pre></div>
  47 <div class="refsect1">
  48 <a name="idm45212146785712"></a><h2>Description</h2>
  49 <div class="refsect2">
  50 <a name="idm45212146785296"></a><h3>
  51 <a name="idm45414524810832-bb"></a><code class="computeroutput">iterator_mixin</code> public member functions</h3>
  52 <div class="orderedlist"><ol class="orderedlist" type="1">
  53 <li class="listitem">
  54 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45414524810272-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>Bin iterator to beginning of the axis (read-only). </li>
  55 <li class="listitem">
  56 <pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm45414524808832-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>Bin iterator to the end of the axis (read-only). </li>
  57 <li class="listitem">
  58 <pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm45414524807392-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Reverse bin iterator to the last entry of the axis (read-only). </li>
  59 <li class="listitem">
  60 <pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm45414524805936-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Reverse bin iterator to the end (read-only). </li>
  61 </ol></div>
  62 </div>
  63 </div>
  64 </div>
  65 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  66 <td align="left"></td>
  67 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Hans
  68       Dembinski<p>
  69         Distributed under the Boost Software License, Version 1.0. (See accompanying
  70         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  71       </p>
  72 </div></td>
  73 </tr></table>
  74 <hr>
  75 <div class="spirit-nav">
  76 <a accesskey="p" href="interval_view.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.axis.iterator_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="metadata_base.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  77 </div>
  78 </body>
  79 </html>