classboost_1_1gil_1_1dereference__iterator__adaptor.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  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: dereference_iterator_adaptor&lt; Iterator, DFn &gt; Class 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="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-types">Public Types</a> &#124;
  48. <a href="#pub-methods">Public Member Functions</a> &#124;
  49. <a href="#friends">Friends</a> &#124;
  50. <a href="classboost_1_1gil_1_1dereference__iterator__adaptor-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">dereference_iterator_adaptor&lt; Iterator, DFn &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> &raquo; <a class="el" href="group___pixel_iterator_model.html">Models</a> &raquo; <a class="el" href="group___pixel_iterator_model_deref_ptr.html">dereference_iterator_adaptor</a><a class="el" href="group___pixel_based.html">PixelBased</a> &raquo; &#124; <a class="el" href="group___pixel_based_model.html">Models</a></div></div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: <a class="el" href="structboost_1_1gil_1_1_iterator_adaptor_concept.html" title="Iterator adaptor is a forward iterator adapting another forward iterator.">IteratorAdaptorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>.
  56. <a href="classboost_1_1gil_1_1dereference__iterator__adaptor.html#details">More...</a></p>
  57. <p><code>#include &lt;<a class="el" href="pixel__iterator__adaptor_8hpp_source.html">pixel_iterator_adaptor.hpp</a>&gt;</code></p>
  58. <p>Inherits iterator_adaptor&lt; dereference_iterator_adaptor&lt; Iterator, DFn &gt;, Iterator, DFn::value_type, std::iterator_traits&lt; Iterator &gt;::iterator_category, DFn::reference, use_default &gt;.</p>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  61. Public Types</h2></td></tr>
  62. <tr class="memitem:a917b3e18694fd92be89afed1a07f7d5c"><td class="memItemLeft" align="right" valign="top"><a id="a917b3e18694fd92be89afed1a07f7d5c"></a>
  63. using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = iterator_adaptor&lt; <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a>&lt; Iterator, DFn &gt;, Iterator, typename DFn::value_type, typename std::iterator_traits&lt; Iterator &gt;::iterator_category, typename DFn::reference, use_default &gt;</td></tr>
  64. <tr class="separator:a917b3e18694fd92be89afed1a07f7d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a85f484e03440df49a4e4aeca7054ab45"><td class="memItemLeft" align="right" valign="top"><a id="a85f484e03440df49a4e4aeca7054ab45"></a>
  66. using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename DFn::result_type</td></tr>
  67. <tr class="separator:a85f484e03440df49a4e4aeca7054ab45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ad050e8e82b0962bb9ebd0e7c23b436ac"><td class="memItemLeft" align="right" valign="top"><a id="ad050e8e82b0962bb9ebd0e7c23b436ac"></a>
  69. using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename std::iterator_traits&lt; Iterator &gt;::difference_type</td></tr>
  70. <tr class="separator:ad050e8e82b0962bb9ebd0e7c23b436ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a7477c088f1b796b376e4615e1c487ea7"><td class="memItemLeft" align="right" valign="top"><a id="a7477c088f1b796b376e4615e1c487ea7"></a>
  72. using&#160;</td><td class="memItemRight" valign="bottom"><b>dereference_fn</b> = DFn</td></tr>
  73. <tr class="separator:a7477c088f1b796b376e4615e1c487ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table><table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:ae603117ffecbd1fd86134750912c788d"><td class="memTemplParams" colspan="2"><a id="ae603117ffecbd1fd86134750912c788d"></a>
  78. template&lt;typename Iterator1 &gt; </td></tr>
  79. <tr class="memitem:ae603117ffecbd1fd86134750912c788d"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a>&lt; Iterator1, DFn &gt; &amp;dit)</td></tr>
  80. <tr class="separator:ae603117ffecbd1fd86134750912c788d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a59216761b450991ae857f8ed69ace8ba"><td class="memItemLeft" align="right" valign="top"><a id="a59216761b450991ae857f8ed69ace8ba"></a>
  82. &#160;</td><td class="memItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (Iterator it, DFn deref_fn=DFn())</td></tr>
  83. <tr class="separator:a59216761b450991ae857f8ed69ace8ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ad5de7b66dcbc758ec74f0b17e307f175"><td class="memTemplParams" colspan="2"><a id="ad5de7b66dcbc758ec74f0b17e307f175"></a>
  85. template&lt;typename Iterator1 , typename DFn1 &gt; </td></tr>
  86. <tr class="memitem:ad5de7b66dcbc758ec74f0b17e307f175"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a>&lt; Iterator1, DFn1 &gt; &amp;it)</td></tr>
  87. <tr class="separator:ad5de7b66dcbc758ec74f0b17e307f175"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a16d8e6857dd561244ca73764f2b94801"><td class="memItemLeft" align="right" valign="top">reference&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
  89. <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a2b553478bc769f8269fa463c9b4599c2"><td class="memItemLeft" align="right" valign="top"><a id="a2b553478bc769f8269fa463c9b4599c2"></a>
  91. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&gt;</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  92. <tr class="separator:a2b553478bc769f8269fa463c9b4599c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a89fcdbc469529e1176d42f60c12128d9"><td class="memItemLeft" align="right" valign="top"><a id="a89fcdbc469529e1176d42f60c12128d9"></a>
  94. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  95. <tr class="separator:a89fcdbc469529e1176d42f60c12128d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ae4a57a91c54bc188362c621b2126f7f0"><td class="memItemLeft" align="right" valign="top"><a id="ae4a57a91c54bc188362c621b2126f7f0"></a>
  97. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&gt;=</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  98. <tr class="separator:ae4a57a91c54bc188362c621b2126f7f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ad47b88d60a75c14eaf872d3bb09a2082"><td class="memItemLeft" align="right" valign="top"><a id="ad47b88d60a75c14eaf872d3bb09a2082"></a>
  100. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;=</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  101. <tr class="separator:ad47b88d60a75c14eaf872d3bb09a2082"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a7a637492e4069e68546fd9888b76920b"><td class="memItemLeft" align="right" valign="top"><a id="a7a637492e4069e68546fd9888b76920b"></a>
  103. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  104. <tr class="separator:a7a637492e4069e68546fd9888b76920b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:abe3b533a73c44c77c4dd69ea796ea53d"><td class="memItemLeft" align="right" valign="top"><a id="abe3b533a73c44c77c4dd69ea796ea53d"></a>
  106. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classboost_1_1gil_1_1dereference__iterator__adaptor.html">dereference_iterator_adaptor</a> &amp;p) const</td></tr>
  107. <tr class="separator:abe3b533a73c44c77c4dd69ea796ea53d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a048bfb0fc9c6a14faae4c65e841ee2d8"><td class="memItemLeft" align="right" valign="top"><a id="a048bfb0fc9c6a14faae4c65e841ee2d8"></a>
  109. Iterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> ()</td></tr>
  110. <tr class="separator:a048bfb0fc9c6a14faae4c65e841ee2d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a382b3cebd23879e42680ef99473e06df"><td class="memItemLeft" align="right" valign="top"><a id="a382b3cebd23879e42680ef99473e06df"></a>
  112. const Iterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> () const</td></tr>
  113. <tr class="separator:a382b3cebd23879e42680ef99473e06df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a789fe67125f97271cdbbec1f198b8bf3"><td class="memItemLeft" align="right" valign="top"><a id="a789fe67125f97271cdbbec1f198b8bf3"></a>
  115. const DFn &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>deref_fn</b> () const</td></tr>
  116. <tr class="separator:a789fe67125f97271cdbbec1f198b8bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  119. Friends</h2></td></tr>
  120. <tr class="memitem:a9b6eaaf690db4e105597700f278147f8"><td class="memTemplParams" colspan="2"><a id="a9b6eaaf690db4e105597700f278147f8"></a>
  121. template&lt;typename Iterator1 , typename DFn1 &gt; </td></tr>
  122. <tr class="memitem:a9b6eaaf690db4e105597700f278147f8"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>dereference_iterator_adaptor</b></td></tr>
  123. <tr class="separator:a9b6eaaf690db4e105597700f278147f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
  125. class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
  126. <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><h3>template&lt;typename Iterator, typename DFn&gt;<br />
  130. class boost::gil::dereference_iterator_adaptor&lt; Iterator, DFn &gt;</h3>
  131. <p>An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: <a class="el" href="structboost_1_1gil_1_1_iterator_adaptor_concept.html" title="Iterator adaptor is a forward iterator adapting another forward iterator.">IteratorAdaptorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>. </p>
  132. </div><h2 class="groupheader">Member Function Documentation</h2>
  133. <a id="a16d8e6857dd561244ca73764f2b94801"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">&#9670;&nbsp;</a></span>operator[]()</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">reference operator[] </td>
  143. <td>(</td>
  144. <td class="paramtype">difference_type&#160;</td>
  145. <td class="paramname"><em>d</em></td><td>)</td>
  146. <td> const</td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>For some reason operator[] provided by iterator_facade returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits </p>
  156. </div>
  157. </div>
  158. <hr/>The documentation for this class was generated from the following file:<ul>
  159. <li><a class="el" href="pixel__iterator__adaptor_8hpp_source.html">pixel_iterator_adaptor.hpp</a></li>
  160. </ul>
  161. </div><!-- contents -->
  162. <!-- HTML footer for doxygen 1.8.13-->
  163. <!-- start footer part -->
  164. <hr class="footer"/>
  165. <address class="footer">
  166. <small>
  167. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  168. </small>
  169. </address>
  170. </body>
  171. </html>