structboost_1_1gil_1_1_iterator_adaptor_concept.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <!-- HTML header for doxygen 1.8.13-->
  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">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.15"/>
  8. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  9. <title>Generic Image Library: IteratorAdaptorConcept&lt; Iterator &gt; Struct Template Reference</title>
  10. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="dynsections.js"></script>
  13. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14. <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15. </head>
  16. <body>
  17. <div class="boost-header">
  18. <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19. <tr>
  20. <td valign="top" width="300">
  21. <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22. </td>
  23. <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24. <td></td>
  25. </tr>
  26. </table>
  27. </div>
  28. <hr/>
  29. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30. <!-- Generated by Doxygen 1.8.15 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */</script>
  39. <div id="main-nav"></div>
  40. <div id="nav-path" class="navpath">
  41. <ul>
  42. <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1_iterator_adaptor_concept.html">IteratorAdaptorConcept</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-methods">Public Member Functions</a> &#124;
  48. <a href="#pub-attribs">Public Attributes</a> &#124;
  49. <a href="structboost_1_1gil_1_1_iterator_adaptor_concept-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">IteratorAdaptorConcept&lt; Iterator &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> &raquo; <a class="el" href="group___pixel_iterator_concept.html">Concepts</a> &raquo; <a class="el" href="group___pixel_iterator_concept_iterator_adaptor.html">IteratorAdaptorConcept</a></div></div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Iterator adaptor is a forward iterator adapting another forward iterator.
  55. <a href="structboost_1_1gil_1_1_iterator_adaptor_concept.html#details">More...</a></p>
  56. <p><code>#include &lt;<a class="el" href="concepts_2pixel__iterator_8hpp_source.html">pixel_iterator.hpp</a>&gt;</code></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memItemLeft" align="right" valign="top"><a id="ab0a0dbf6ca9028bbbb2240cad5882537"></a>
  61. void&#160;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  62. <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. </table><table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  65. Public Attributes</h2></td></tr>
  66. <tr class="memitem:a8e5a0f604de6507cf17b22c030d0f079"><td class="memItemLeft" align="right" valign="top"><a id="a8e5a0f604de6507cf17b22c030d0f079"></a>
  67. Iterator&#160;</td><td class="memItemRight" valign="bottom"><b>it</b></td></tr>
  68. <tr class="separator:a8e5a0f604de6507cf17b22c030d0f079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. </table>
  70. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  71. <div class="textblock"><h3>template&lt;typename Iterator&gt;<br />
  72. struct boost::gil::IteratorAdaptorConcept&lt; Iterator &gt;</h3>
  73. <p>Iterator adaptor is a forward iterator adapting another forward iterator. </p>
  74. <p>In addition to GIL iterator requirements, GIL iterator adaptors must provide the following metafunctions:</p><ul>
  75. <li><code>is_iterator_adaptor&lt;Iterator&gt;</code>: Returns <code>std::true_type</code> </li>
  76. <li><code>iterator_adaptor_get_base&lt;Iterator&gt;</code>: Returns the base iterator type</li>
  77. <li><code>iterator_adaptor_rebind&lt;Iterator,NewBase&gt;</code>: Replaces the base iterator with the new one</li>
  78. </ul>
  79. <p>The adaptee can be obtained from the iterator via the "base()" method.</p>
  80. <div class="fragment"><div class="line">concept IteratorAdaptorConcept&lt;boost_concepts::ForwardTraversalConcept Iterator&gt;</div><div class="line">{</div><div class="line"> where SameType&lt;is_iterator_adaptor&lt;Iterator&gt;::type, std::true_type&gt;;</div><div class="line"></div><div class="line"> <span class="keyword">typename</span> iterator_adaptor_get_base&lt;Iterator&gt;;</div><div class="line"> where Metafunction&lt;iterator_adaptor_get_base&lt;Iterator&gt; &gt;;</div><div class="line"> where boost_concepts::ForwardTraversalConcept&lt;iterator_adaptor_get_base&lt;Iterator&gt;::type&gt;;</div><div class="line"></div><div class="line"> <span class="keyword">typename</span> another_iterator;</div><div class="line"> <span class="keyword">typename</span> iterator_adaptor_rebind&lt;Iterator,another_iterator&gt;::type;</div><div class="line"> where boost_concepts::ForwardTraversalConcept&lt;another_iterator&gt;;</div><div class="line"> where IteratorAdaptorConcept&lt;iterator_adaptor_rebind&lt;Iterator,another_iterator&gt;::type&gt;;</div><div class="line"></div><div class="line"> <span class="keyword">const</span> iterator_adaptor_get_base&lt;Iterator&gt;::type&amp; Iterator::base() <span class="keyword">const</span>;</div><div class="line">};</div></div><!-- fragment --> </div><hr/>The documentation for this struct was generated from the following file:<ul>
  81. <li><a class="el" href="concepts_2pixel__iterator_8hpp_source.html">concepts/pixel_iterator.hpp</a></li>
  82. </ul>
  83. </div><!-- contents -->
  84. <!-- HTML footer for doxygen 1.8.13-->
  85. <!-- start footer part -->
  86. <hr class="footer"/>
  87. <address class="footer">
  88. <small>
  89. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  90. </small>
  91. </address>
  92. </body>
  93. </html>