iterator_concepts.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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>Iterator Concepts</title>
  8. <meta name="author" content="David Abrahams, Jeremy Siek, Thomas Witt" />
  9. <meta name="organization" content="Boost Consulting, Indiana University Open Systems Lab, Zephyr Associates, Inc." />
  10. <meta name="date" content="2006-09-11" />
  11. <meta name="copyright" content="Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2004." />
  12. <link rel="stylesheet" href="../../../rst.css" type="text/css" />
  13. </head>
  14. <body>
  15. <div class="document" id="iterator-concepts">
  16. <h1 class="title">Iterator Concepts</h1>
  17. <table class="docinfo" frame="void" rules="none">
  18. <col class="docinfo-name" />
  19. <col class="docinfo-content" />
  20. <tbody valign="top">
  21. <tr><th class="docinfo-name">Author:</th>
  22. <td>David Abrahams, Jeremy Siek, Thomas Witt</td></tr>
  23. <tr><th class="docinfo-name">Contact:</th>
  24. <td><a class="first reference external" href="mailto:dave&#64;boost-consulting.com">dave&#64;boost-consulting.com</a>, <a class="reference external" href="mailto:jsiek&#64;osl.iu.edu">jsiek&#64;osl.iu.edu</a>, <a class="last reference external" href="mailto:witt&#64;styleadvisor.com">witt&#64;styleadvisor.com</a></td></tr>
  25. <tr><th class="docinfo-name">Organization:</th>
  26. <td><a class="first reference external" href="http://www.boost-consulting.com">Boost Consulting</a>, Indiana University <a class="reference external" href="http://www.osl.iu.edu">Open Systems
  27. Lab</a>, <a class="last reference external" href="http://www.styleadvisor.com">Zephyr Associates, Inc.</a></td></tr>
  28. <tr><th class="docinfo-name">Date:</th>
  29. <td>2006-09-11</td></tr>
  30. <tr><th class="docinfo-name">Copyright:</th>
  31. <td>Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2004.</td></tr>
  32. </tbody>
  33. </table>
  34. <!-- Distributed under the Boost -->
  35. <!-- Software License, Version 1.0. (See accompanying -->
  36. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  37. <table class="docutils field-list" frame="void" rules="none">
  38. <col class="field-name" />
  39. <col class="field-body" />
  40. <tbody valign="top">
  41. <tr class="field"><th class="field-name">abstract:</th><td class="field-body">The iterator concept checking classes provide a mechanism for
  42. a template to report better error messages when a user instantiates
  43. the template with a type that does not meet the requirements of
  44. the template.</td>
  45. </tr>
  46. </tbody>
  47. </table>
  48. <p>For an introduction to using concept checking classes, see
  49. the documentation for the <a class="reference external" href="../../concept_check/index.html"><tt class="docutils literal"><span class="pre">boost::concept_check</span></tt></a> library.</p>
  50. <div class="section" id="reference">
  51. <h1>Reference</h1>
  52. <div class="section" id="iterator-access-concepts">
  53. <h2>Iterator Access Concepts</h2>
  54. <ul class="simple">
  55. <li><a class="reference external" href="ReadableIterator.html"><em>Readable Iterator</em></a></li>
  56. <li><a class="reference external" href="WritableIterator.html"><em>Writable Iterator</em></a></li>
  57. <li><a class="reference external" href="SwappableIterator.html"><em>Swappable Iterator</em></a></li>
  58. <li><a class="reference external" href="LvalueIterator.html"><em>Lvalue Iterator</em></a></li>
  59. </ul>
  60. </div>
  61. <div class="section" id="iterator-traversal-concepts">
  62. <h2>Iterator Traversal Concepts</h2>
  63. <ul class="simple">
  64. <li><a class="reference external" href="IncrementableIterator.html"><em>Incrementable Iterator</em></a></li>
  65. <li><a class="reference external" href="SinglePassIterator.html"><em>Single Pass Iterator</em></a></li>
  66. <li><a class="reference external" href="ForwardTraversal.html"><em>Forward Traversal</em></a></li>
  67. <li><a class="reference external" href="BidirectionalTraversal.html"><em>Bidirectional Traversal</em></a></li>
  68. <li><a class="reference external" href="RandomAccessTraversal.html"><em>Random Access Traversal</em></a></li>
  69. </ul>
  70. </div>
  71. <div class="section" id="iterator-concepts-hpp-synopsis">
  72. <h2><tt class="docutils literal"><span class="pre">iterator_concepts.hpp</span></tt> Synopsis</h2>
  73. <pre class="literal-block">
  74. namespace boost_concepts {
  75. // Iterator Access Concepts
  76. template &lt;typename Iterator&gt;
  77. class ReadableIteratorConcept;
  78. template &lt;
  79. typename Iterator
  80. , typename ValueType = std::iterator_traits&lt;Iterator&gt;::value_type
  81. &gt;
  82. class WritableIteratorConcept;
  83. template &lt;typename Iterator&gt;
  84. class SwappableIteratorConcept;
  85. template &lt;typename Iterator&gt;
  86. class LvalueIteratorConcept;
  87. // Iterator Traversal Concepts
  88. template &lt;typename Iterator&gt;
  89. class IncrementableIteratorConcept;
  90. template &lt;typename Iterator&gt;
  91. class SinglePassIteratorConcept;
  92. template &lt;typename Iterator&gt;
  93. class ForwardTraversalConcept;
  94. template &lt;typename Iterator&gt;
  95. class BidirectionalTraversalConcept;
  96. template &lt;typename Iterator&gt;
  97. class RandomAccessTraversalConcept;
  98. // Interoperability
  99. template &lt;typename Iterator, typename ConstIterator&gt;
  100. class InteroperableIteratorConcept;
  101. }
  102. </pre>
  103. </div>
  104. </div>
  105. </div>
  106. <div class="footer">
  107. <hr class="footer" />
  108. <a class="reference external" href="iterator_concepts.rst">View document source</a>.
  109. 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.
  110. </div>
  111. </body>
  112. </html>