1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Struct template reverse_iterator</title> 6<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../../stl_interfaces/reference.html#header.boost.stl_interfaces.reverse_iterator_hpp" title="Header <boost/stl_interfaces/reverse_iterator.hpp>"> 10<link rel="prev" href="../../../BOOST_STL__1_3_39_11_2_3_3.html" title="Macro BOOST_STL_INTERFACES_STATIC_ASSERT_ITERATOR_TRAITS"> 11<link rel="next" href="make_reverse_iterator.html" title="Function template make_reverse_iterator"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 16<td align="center"><a href="../../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="../../../BOOST_STL__1_3_39_11_2_3_3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../stl_interfaces/reference.html#header.boost.stl_interfaces.reverse_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="make_reverse_iterator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.stl_interfaces.v1.reverse_iterator"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Struct template reverse_iterator</span></h2> 30<p>boost::stl_interfaces::v1::reverse_iterator</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../stl_interfaces/reference.html#header.boost.stl_interfaces.reverse_iterator_hpp" title="Header <boost/stl_interfaces/reverse_iterator.hpp>">boost/stl_interfaces/reverse_iterator.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiIter<span class="special">></span> 36<span class="keyword">struct</span> <a class="link" href="reverse_iterator.html" title="Struct template reverse_iterator">reverse_iterator</a> <span class="special">:</span> <span class="keyword">public</span> boost::stl_interfaces::v1::iterator_interface< reverse_iterator< BidiIter >, std::iterator_traits< BidiIter >::iterator_category, std::iterator_traits< BidiIter >::value_type, std::iterator_traits< BidiIter >::reference, std::iterator_traits< BidiIter >::pointer, std::iterator_traits< BidiIter >::difference_type > 37<span class="special">{</span> 38 <span class="comment">// <a class="link" href="reverse_iterator.html#boost.stl_interfaces.v1.reverse_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_6-bb"><span class="identifier">reverse_iterator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_7-bb"><span class="identifier">reverse_iterator</span></a><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">(</span><span class="identifier">it</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 41 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiIter2<span class="special">,</span> 42 <span class="keyword">typename</span> E <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if_t</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">is_convertible</span><span class="special"><</span><span class="identifier">BidiIter2</span><span class="special">,</span> <span class="identifier">BidiIter</span><span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">></span> <span class="special">></span> 43 <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_8-bb"><span class="identifier">reverse_iterator</span></a><span class="special">(</span><a class="link" href="reverse_iterator.html" title="Struct template reverse_iterator">reverse_iterator</a><span class="special"><</span> <span class="identifier">BidiIter2</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_4-bb">friend functions</a></span> 46 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiIter2<span class="special">></span> <span class="keyword">friend</span> <span class="keyword">struct</span> <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_4_1-bb"><span class="identifier">reverse_iterator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 47 48 <span class="comment">// <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_5-bb">public member functions</a></span> 49 <span class="keyword">constexpr</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">reference</span> 50 <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_5_1-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><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">prev</span><span class="special">(</span><span class="identifier">v1_dtl</span><span class="special">::</span><span class="identifier">ce_prev</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 51 <span class="keyword">constexpr</span> <a class="link" href="reverse_iterator.html" title="Struct template reverse_iterator">reverse_iterator</a> <span class="special">&</span> 52 <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_5_2-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">v1_dtl</span><span class="special">::</span><span class="identifier">ce_adv</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="special">-</span><span class="identifier">n</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">iterator_category</span><span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 53 <span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_5_3-bb"><span class="identifier">base</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 55 <span class="comment">// <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_9-bb">private member functions</a></span> 56 <span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_9_1-bb"><span class="identifier">base_reference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 57 <span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="reverse_iterator.html#id-1_3_39_11_2_4_1_1_1_1_9_2-bb"><span class="identifier">base_reference</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 58<span class="special">}</span><span class="special">;</span></pre></div> 59<div class="refsect1"> 60<a name="id-1.3.39.11.2.4.3.4"></a><h2>Description</h2> 61<p>This type is very similar to the C++20 version of <code class="computeroutput">std::reverse_iterator</code>; it is <code class="computeroutput">constexpr</code>-, <code class="computeroutput">noexcept</code>-, and proxy-friendly. </p> 62<div class="refsect2"> 63<a name="id-1.3.39.11.2.4.3.4.3"></a><h3> 64<a name="boost.stl_interfaces.v1.reverse_iteratorconstruct-copy-destruct"></a><code class="computeroutput">reverse_iterator</code> 65 public 66 construct/copy/destruct</h3> 67<div class="orderedlist"><ol class="orderedlist" type="1"> 68<li class="listitem"><pre class="literallayout"><a name="id-1_3_39_11_2_4_1_1_1_1_6-bb"></a><span class="identifier">reverse_iterator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> 69<li class="listitem"><pre class="literallayout"><a name="id-1_3_39_11_2_4_1_1_1_1_7-bb"></a><span class="identifier">reverse_iterator</span><span class="special">(</span><span class="identifier">BidiIter</span> it<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">BidiIter</span><span class="special">(</span><span class="identifier">it</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> 70<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiIter2<span class="special">,</span> 71 <span class="keyword">typename</span> E <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if_t</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">is_convertible</span><span class="special"><</span><span class="identifier">BidiIter2</span><span class="special">,</span> <span class="identifier">BidiIter</span><span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">></span> <span class="special">></span> 72 <a name="id-1_3_39_11_2_4_1_1_1_1_8-bb"></a><span class="identifier">reverse_iterator</span><span class="special">(</span><a class="link" href="reverse_iterator.html" title="Struct template reverse_iterator">reverse_iterator</a><span class="special"><</span> <span class="identifier">BidiIter2</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> it<span class="special">)</span><span class="special">;</span></pre></li> 73</ol></div> 74</div> 75<div class="refsect2"> 76<a name="id-1.3.39.11.2.4.3.4.4"></a><h3> 77<a name="id-1_3_39_11_2_4_1_1_1_1_4-bb"></a><code class="computeroutput">reverse_iterator</code> friend functions</h3> 78<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 79<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiIter2<span class="special">></span> <span class="keyword">friend</span> <span class="keyword">struct</span> <a name="id-1_3_39_11_2_4_1_1_1_1_4_1-bb"></a><span class="identifier">reverse_iterator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 80<p>A template alias for <code class="computeroutput">std::reverse_iterator</code>. This only exists to make migration from Boost.STLInterfaces to C++20 easier; switch to the one in <code class="computeroutput">std</code> as soon as you can. </p> 81</li></ol></div> 82</div> 83<div class="refsect2"> 84<a name="id-1.3.39.11.2.4.3.4.5"></a><h3> 85<a name="id-1_3_39_11_2_4_1_1_1_1_5-bb"></a><code class="computeroutput">reverse_iterator</code> public member functions</h3> 86<div class="orderedlist"><ol class="orderedlist" type="1"> 87<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">reference</span> 88<a name="id-1_3_39_11_2_4_1_1_1_1_5_1-bb"></a><span class="keyword">operator</span> <span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">prev</span><span class="special">(</span><span class="identifier">v1_dtl</span><span class="special">::</span><span class="identifier">ce_prev</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> 89<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <a class="link" href="reverse_iterator.html" title="Struct template reverse_iterator">reverse_iterator</a> <span class="special">&</span> 90<a name="id-1_3_39_11_2_4_1_1_1_1_5_2-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">difference_type</span> n<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">(</span><span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">v1_dtl</span><span class="special">::</span><span class="identifier">ce_adv</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <span class="special">></span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="special">-</span><span class="identifier">n</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">iterator_category</span><span class="special">{</span><span class="special">}</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li> 91<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <a name="id-1_3_39_11_2_4_1_1_1_1_5_3-bb"></a><span class="identifier">base</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> 92</ol></div> 93</div> 94<div class="refsect2"> 95<a name="id-1.3.39.11.2.4.3.4.6"></a><h3> 96<a name="id-1_3_39_11_2_4_1_1_1_1_9-bb"></a><code class="computeroutput">reverse_iterator</code> private member functions</h3> 97<div class="orderedlist"><ol class="orderedlist" type="1"> 98<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <span class="special">&</span> <a name="id-1_3_39_11_2_4_1_1_1_1_9_1-bb"></a><span class="identifier">base_reference</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 99<li class="listitem"><pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">BidiIter</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_39_11_2_4_1_1_1_1_9_2-bb"></a><span class="identifier">base_reference</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> 100</ol></div> 101</div> 102</div> 103</div> 104<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 105<td align="left"></td> 106<td align="right"><div class="copyright-footer">Copyright © 2019 T. Zachary Laine<p> 107 Distributed under the Boost Software License, Version 1.0. (See accompanying 108 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 109 </p> 110</div></td> 111</tr></table> 112<hr> 113<div class="spirit-nav"> 114<a accesskey="p" href="../../../BOOST_STL__1_3_39_11_2_3_3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../stl_interfaces/reference.html#header.boost.stl_interfaces.reverse_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="make_reverse_iterator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 115</div> 116</body> 117</html> 118
