ceph/src/boost/libs/iterator/doc/LvalueIterator.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
   7 <title>Lvalue Iterator Concept</title>
   8 <link rel="stylesheet" href="../../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="lvalue-iterator-concept">
  12 <h1 class="title">Lvalue Iterator Concept</h1>
  13
  14 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  15 <!-- Software License, Version 1.0. (See accompanying -->
  16 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  17 <p>The <em>Lvalue Iterator</em> concept adds the requirement that the return
  18 type of <tt class="docutils literal"><span class="pre">operator*</span></tt> type be a reference to the value type of the
  19 iterator.</p>
  20 <table border="1" class="docutils">
  21 <colgroup>
  22 <col width="22%" />
  23 <col width="19%" />
  24 <col width="59%" />
  25 </colgroup>
  26 <thead valign="bottom">
  27 <tr><th class="head" colspan="3">Lvalue Iterator Requirements</th>
  28 </tr>
  29 <tr><th class="head">Expression</th>
  30 <th class="head">Return Type</th>
  31 <th class="head">Note/Assertion</th>
  32 </tr>
  33 </thead>
  34 <tbody valign="top">
  35 <tr><td><tt class="docutils literal"><span class="pre">*a</span></tt></td>
  36 <td><tt class="docutils literal"><span class="pre">T&amp;</span></tt></td>
  37 <td><tt class="docutils literal"><span class="pre">T</span></tt> is <em>cv</em>
  38 <tt class="docutils literal"><span class="pre">iterator_traits&lt;X&gt;::value_type</span></tt>
  39 where <em>cv</em> is an optional
  40 cv-qualification.
  41 pre: <tt class="docutils literal"><span class="pre">a</span></tt> is
  42 dereferenceable. If <tt class="docutils literal"><span class="pre">a</span>
  43 <span class="pre">==</span> <span class="pre">b</span></tt> then <tt class="docutils literal"><span class="pre">*a</span></tt> is
  44 equivalent to <tt class="docutils literal"><span class="pre">*b</span></tt>.</td>
  45 </tr>
  46 </tbody>
  47 </table>
  48 </div>
  49 <div class="footer">
  50 <hr class="footer" />
  51 <a class="reference external" href="LvalueIterator.rst">View document source</a>.
  52 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
  53
  54 </div>
  55 </body>
  56 </html>