LvalueIterator.html 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  14. <!-- Software License, Version 1.0. (See accompanying -->
  15. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  16. <p>The <em>Lvalue Iterator</em> concept adds the requirement that the return
  17. type of <tt class="docutils literal"><span class="pre">operator*</span></tt> type be a reference to the value type of the
  18. iterator.</p>
  19. <table border="1" class="docutils">
  20. <colgroup>
  21. <col width="22%" />
  22. <col width="19%" />
  23. <col width="59%" />
  24. </colgroup>
  25. <thead valign="bottom">
  26. <tr><th class="head" colspan="3">Lvalue Iterator Requirements</th>
  27. </tr>
  28. <tr><th class="head">Expression</th>
  29. <th class="head">Return Type</th>
  30. <th class="head">Note/Assertion</th>
  31. </tr>
  32. </thead>
  33. <tbody valign="top">
  34. <tr><td><tt class="docutils literal"><span class="pre">*a</span></tt></td>
  35. <td><tt class="docutils literal"><span class="pre">T&amp;</span></tt></td>
  36. <td><tt class="docutils literal"><span class="pre">T</span></tt> is <em>cv</em>
  37. <tt class="docutils literal"><span class="pre">iterator_traits&lt;X&gt;::value_type</span></tt>
  38. where <em>cv</em> is an optional
  39. cv-qualification.
  40. pre: <tt class="docutils literal"><span class="pre">a</span></tt> is
  41. dereferenceable. If <tt class="docutils literal"><span class="pre">a</span>
  42. <span class="pre">==</span> <span class="pre">b</span></tt> then <tt class="docutils literal"><span class="pre">*a</span></tt> is
  43. equivalent to <tt class="docutils literal"><span class="pre">*b</span></tt>.</td>
  44. </tr>
  45. </tbody>
  46. </table>
  47. </div>
  48. <div class="footer">
  49. <hr class="footer" />
  50. <a class="reference external" href="LvalueIterator.rst">View document source</a>.
  51. 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.
  52. </div>
  53. </body>
  54. </html>