iterator_traits.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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.11: http://docutils.sourceforge.net/" />
  7. <title>Iterator Traits</title>
  8. <meta name="author" content="David Abrahams" />
  9. <meta name="organization" content="Boost Consulting" />
  10. <meta name="date" content="$Date$" />
  11. <meta name="copyright" content="Copyright David Abrahams 2004." />
  12. <link rel="stylesheet" href="../../../rst.css" type="text/css" />
  13. </head>
  14. <body>
  15. <div class="document" id="iterator-traits">
  16. <h1 class="title">Iterator Traits</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</td></tr>
  23. <tr><th class="docinfo-name">Contact:</th>
  24. <td><a class="first last reference external" href="mailto:dave&#64;boost-consulting.com">dave&#64;boost-consulting.com</a></td></tr>
  25. <tr><th class="docinfo-name">Organization:</th>
  26. <td><a class="first last reference external" href="http://www.boost-consulting.com">Boost Consulting</a></td></tr>
  27. <tr><th class="docinfo-name">Date:</th>
  28. <td>$Date$</td></tr>
  29. <tr><th class="docinfo-name">Copyright:</th>
  30. <td>Copyright David Abrahams 2004.</td></tr>
  31. </tbody>
  32. </table>
  33. <!-- Distributed under the Boost -->
  34. <!-- Software License, Version 1.0. (See accompanying -->
  35. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  36. <table class="docutils field-list" frame="void" rules="none">
  37. <col class="field-name" />
  38. <col class="field-body" />
  39. <tbody valign="top">
  40. <tr class="field"><th class="field-name">abstract:</th><td class="field-body">Header <tt class="docutils literal">&lt;boost/iterator/iterator_traits.hpp&gt;</tt> provides
  41. the ability to access an iterator's associated types using
  42. MPL-compatible <a class="reference external" href="../../mpl/doc/index.html#metafunctions">metafunctions</a>.</td>
  43. </tr>
  44. </tbody>
  45. </table>
  46. <div class="section" id="overview">
  47. <h1>Overview</h1>
  48. <p><tt class="docutils literal"><span class="pre">std::iterator_traits</span></tt> provides access to five associated types
  49. of any iterator: its <tt class="docutils literal">value_type</tt>, <tt class="docutils literal">reference</tt>, <tt class="docutils literal">pointer</tt>,
  50. <tt class="docutils literal">iterator_category</tt>, and <tt class="docutils literal">difference_type</tt>. Unfortunately,
  51. such a &quot;multi-valued&quot; traits template can be difficult to use in a
  52. metaprogramming context. <tt class="docutils literal">&lt;boost/iterator/iterator_traits.hpp&gt;</tt>
  53. provides access to these types using a standard <a class="reference external" href="../../mpl/doc/index.html#metafunctions">metafunctions</a>.</p>
  54. </div>
  55. <div class="section" id="summary">
  56. <h1>Summary</h1>
  57. <p>Header <tt class="docutils literal">&lt;boost/iterator/iterator_traits.hpp&gt;</tt>:</p>
  58. <pre class="literal-block">
  59. template &lt;class Iterator&gt;
  60. struct iterator_value
  61. {
  62. typedef typename
  63. std::iterator_traits&lt;Iterator&gt;::value_type
  64. type;
  65. };
  66. template &lt;class Iterator&gt;
  67. struct iterator_reference
  68. {
  69. typedef typename
  70. std::iterator_traits&lt;Iterator&gt;::reference
  71. type;
  72. };
  73. template &lt;class Iterator&gt;
  74. struct iterator_pointer
  75. {
  76. typedef typename
  77. std::iterator_traits&lt;Iterator&gt;::pointer
  78. type;
  79. };
  80. template &lt;class Iterator&gt;
  81. struct iterator_difference
  82. {
  83. typedef typename
  84. detail::iterator_traits&lt;Iterator&gt;::difference_type
  85. type;
  86. };
  87. template &lt;class Iterator&gt;
  88. struct iterator_category
  89. {
  90. typedef typename
  91. detail::iterator_traits&lt;Iterator&gt;::iterator_category
  92. type;
  93. };
  94. </pre>
  95. </div>
  96. </div>
  97. <div class="footer">
  98. <hr class="footer" />
  99. <a class="reference external" href="iterator_traits.rst">View document source</a>.
  100. 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.
  101. </div>
  102. </body>
  103. </html>