libs/gil/doc/html/reference/classboost_1_1gil_1_1memory__based__step__iterator.html

   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: memory_based_step_iterator&lt; Iterator &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_1memory__based__step__iterator.html">memory_based_step_iterator</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="classboost_1_1gil_1_1memory__based__step__iterator-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">memory_based_step_iterator&lt; Iterator &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_step_ptr.html">step iterators</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>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>MEMORY-BASED STEP ITERATOR.
  56  <a href="classboost_1_1gil_1_1memory__based__step__iterator.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;<a class="el" href="step__iterator_8hpp_source.html">step_iterator.hpp</a>&gt;</code></p>
  59 <div class="dynheader">
  60 Inheritance diagram for memory_based_step_iterator&lt; Iterator &gt;:</div>
  61 <div class="dyncontent">
  62  <div class="center">
  63   <img src="classboost_1_1gil_1_1memory__based__step__iterator.png" usemap="#memory_5Fbased_5Fstep_5Fiterator_3C_20Iterator_20_3E_map" alt=""/>
  64   <map id="memory_5Fbased_5Fstep_5Fiterator_3C_20Iterator_20_3E_map" name="memory_5Fbased_5Fstep_5Fiterator_3C_20Iterator_20_3E_map">
  65 <area href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html" alt="step_iterator_adaptor&lt; memory_based_step_iterator&lt; Iterator &gt;, Iterator, memunit_step_fn&lt; Iterator &gt; &gt;" shape="rect" coords="0,0,597,24"/>
  66   </map>
  67 </div></div>
  68 <table class="memberdecls">
  69 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  70 Public Types</h2></td></tr>
  71 <tr class="memitem:acb04528fb0a39aa9aaed8ae8cb19ab02"><td class="memItemLeft" align="right" valign="top"><a id="acb04528fb0a39aa9aaed8ae8cb19ab02"></a>
  72 using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = <a class="el" href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html">detail::step_iterator_adaptor</a>&lt; <a class="el" href="classboost_1_1gil_1_1memory__based__step__iterator.html">memory_based_step_iterator</a>&lt; Iterator &gt;, Iterator, <a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt; &gt;</td></tr>
  73 <tr class="separator:acb04528fb0a39aa9aaed8ae8cb19ab02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memItemLeft" align="right" valign="top"><a id="afd3670b743c9f80b9c2f6b3ccb5fe37c"></a>
  75 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename parent_t::reference</td></tr>
  76 <tr class="separator:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memItemLeft" align="right" valign="top"><a id="a2ae9f9bc144b7bd7d8523c345ac34a58"></a>
  78 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename parent_t::difference_type</td></tr>
  79 <tr class="separator:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:abda96f6e8bcbe011f40941740b62c61f"><td class="memItemLeft" align="right" valign="top"><a id="abda96f6e8bcbe011f40941740b62c61f"></a>
  81 using&#160;</td><td class="memItemRight" valign="bottom"><b>x_iterator</b> = Iterator</td></tr>
  82 <tr class="separator:abda96f6e8bcbe011f40941740b62c61f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="inherit_header pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html">step_iterator_adaptor&lt; memory_based_step_iterator&lt; Iterator &gt;, Iterator, memunit_step_fn&lt; Iterator &gt; &gt;</a></td></tr>
  84 <tr class="memitem:aaddc7de362ea82f391ca5035f9d418da inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="aaddc7de362ea82f391ca5035f9d418da"></a>
  85 using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = iterator_adaptor&lt; <a class="el" href="classboost_1_1gil_1_1memory__based__step__iterator.html">memory_based_step_iterator</a>&lt; Iterator &gt;, Iterator, use_default, use_default, use_default, typename <a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt; ::difference_type &gt;</td></tr>
  86 <tr class="separator:aaddc7de362ea82f391ca5035f9d418da inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:ac3ecbee039e86d5e6592e81da05c7e79 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="ac3ecbee039e86d5e6592e81da05c7e79"></a>
  88 using&#160;</td><td class="memItemRight" valign="bottom"><b>base_difference_type</b> = typename std::iterator_traits&lt; Iterator &gt;::difference_type</td></tr>
  89 <tr class="separator:ac3ecbee039e86d5e6592e81da05c7e79 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:a8254ddd51f36f5f0dd01c55b45ee5c89 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="a8254ddd51f36f5f0dd01c55b45ee5c89"></a>
  91 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename <a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt; ::difference_type</td></tr>
  92 <tr class="separator:a8254ddd51f36f5f0dd01c55b45ee5c89 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:a57d818f6bd24dee2a8803cb3be635373 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="a57d818f6bd24dee2a8803cb3be635373"></a>
  94 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename std::iterator_traits&lt; Iterator &gt;::reference</td></tr>
  95 <tr class="separator:a57d818f6bd24dee2a8803cb3be635373 inherit pub_types_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 </table><table class="memberdecls">
  97 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98 Public Member Functions</h2></td></tr>
  99 <tr class="memitem:a1c335f11e1be5ae1444d6556e5c4c59f"><td class="memItemLeft" align="right" valign="top"><a id="a1c335f11e1be5ae1444d6556e5c4c59f"></a>
 100 &#160;</td><td class="memItemRight" valign="bottom"><b>memory_based_step_iterator</b> (Iterator it, std::ptrdiff_t memunit_step)</td></tr>
 101 <tr class="separator:a1c335f11e1be5ae1444d6556e5c4c59f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 <tr class="memitem:a4ef5f75f4ab577d869b8affa7efbe1fd"><td class="memTemplParams" colspan="2"><a id="a4ef5f75f4ab577d869b8affa7efbe1fd"></a>
 103 template&lt;typename I2 &gt; </td></tr>
 104 <tr class="memitem:a4ef5f75f4ab577d869b8affa7efbe1fd"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>memory_based_step_iterator</b> (const <a class="el" href="classboost_1_1gil_1_1memory__based__step__iterator.html">memory_based_step_iterator</a>&lt; I2 &gt; &amp;it)</td></tr>
 105 <tr class="separator:a4ef5f75f4ab577d869b8affa7efbe1fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <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_1memory__based__step__iterator.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
 107 <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a2db2a1eeeaff81d48e6c3ae3fb21cdd9"><td class="memItemLeft" align="right" valign="top"><a id="a2db2a1eeeaff81d48e6c3ae3fb21cdd9"></a>
 109 void&#160;</td><td class="memItemRight" valign="bottom"><b>set_step</b> (std::ptrdiff_t memunit_step)</td></tr>
 110 <tr class="separator:a2db2a1eeeaff81d48e6c3ae3fb21cdd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="memitem:a2d6722b54419923ecb1282a142fcd494"><td class="memItemLeft" align="right" valign="top"><a id="a2d6722b54419923ecb1282a142fcd494"></a>
 112 x_iterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> ()</td></tr>
 113 <tr class="separator:a2d6722b54419923ecb1282a142fcd494"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:afea9dbea334f4bcf01d459a8bc0ac647"><td class="memItemLeft" align="right" valign="top"><a id="afea9dbea334f4bcf01d459a8bc0ac647"></a>
 115 x_iterator const  &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>base</b> () const</td></tr>
 116 <tr class="separator:afea9dbea334f4bcf01d459a8bc0ac647"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="inherit_header pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html">step_iterator_adaptor&lt; memory_based_step_iterator&lt; Iterator &gt;, Iterator, memunit_step_fn&lt; Iterator &gt; &gt;</a></td></tr>
 118 <tr class="memitem:a15fe6eaea1e52b8f3d3e18c8abf8ada9 inherit pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="a15fe6eaea1e52b8f3d3e18c8abf8ada9"></a>
 119 &#160;</td><td class="memItemRight" valign="bottom"><b>step_iterator_adaptor</b> (const Iterator &amp;it, <a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt; step_fn=<a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt;())</td></tr>
 120 <tr class="separator:a15fe6eaea1e52b8f3d3e18c8abf8ada9 inherit pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:abfabe1fd0d40d74b2b2c67599cd2a209 inherit pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="abfabe1fd0d40d74b2b2c67599cd2a209"></a>
 122 difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>step</b> () const</td></tr>
 123 <tr class="separator:abfabe1fd0d40d74b2b2c67599cd2a209 inherit pub_methods_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 </table><table class="memberdecls">
 125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 126 Additional Inherited Members</h2></td></tr>
 127 <tr class="inherit_header pro_attribs_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html">step_iterator_adaptor&lt; memory_based_step_iterator&lt; Iterator &gt;, Iterator, memunit_step_fn&lt; Iterator &gt; &gt;</a></td></tr>
 128 <tr class="memitem:aa6f3d4cf659c02cbee3b014d8d9dc90c inherit pro_attribs_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memItemLeft" align="right" valign="top"><a id="aa6f3d4cf659c02cbee3b014d8d9dc90c"></a>
 129 <a class="el" href="structboost_1_1gil_1_1memunit__step__fn.html">memunit_step_fn</a>&lt; Iterator &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_step_fn</b></td></tr>
 130 <tr class="separator:aa6f3d4cf659c02cbee3b014d8d9dc90c inherit pro_attribs_classboost_1_1gil_1_1detail_1_1step__iterator__adaptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 </table>
 132 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 133 <div class="textblock"><h3>template&lt;typename Iterator&gt;<br />
 134 class boost::gil::memory_based_step_iterator&lt; Iterator &gt;</h3>
 135
 136 <p>MEMORY-BASED STEP ITERATOR. </p>
 137 <p>Iterator with dynamically specified step in memory units (bytes or bits). Models <a class="el" href="structboost_1_1gil_1_1_step_iterator_concept.html" title="Step iterator concept.">StepIteratorConcept</a>, <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_memory_based_iterator_concept.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or bits)">MemoryBasedIteratorConcept</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>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a></p>
 138 <p>A refinement of step_iterator_adaptor that uses a dynamic parameter for the step which is specified in memory units, such as bytes or bits</p>
 139 <p>Pixel step iterators are used to provide iteration over non-adjacent pixels. Common use is a vertical traversal, where the step is the row stride.</p>
 140 <p>Another application is as a sub-channel view. For example, a red intensity image over interleaved RGB data would use a step iterator adaptor with step sizeof(channel_t)*3 In the latter example the step size could be fixed at compile time for efficiency. Compile-time fixed step can be implemented by providing a step function object that takes the step as a template </p>
 141 </div><h2 class="groupheader">Member Function Documentation</h2>
 142 <a id="a16d8e6857dd561244ca73764f2b94801"></a>
 143 <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">&#9670;&nbsp;</a></span>operator[]()</h2>
 144
 145 <div class="memitem">
 146 <div class="memproto">
 147 <table class="mlabels">
 148   <tr>
 149   <td class="mlabels-left">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname">reference operator[] </td>
 153           <td>(</td>
 154           <td class="paramtype">difference_type&#160;</td>
 155           <td class="paramname"><em>d</em></td><td>)</td>
 156           <td> const</td>
 157         </tr>
 158       </table>
 159   </td>
 160   <td class="mlabels-right">
 161 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 162   </tr>
 163 </table>
 164 </div><div class="memdoc">
 165 <p>For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits </p>
 166
 167 </div>
 168 </div>
 169 <hr/>The documentation for this class was generated from the following files:<ul>
 170 <li><a class="el" href="algorithm_8hpp_source.html">algorithm.hpp</a></li>
 171 <li><a class="el" href="step__iterator_8hpp_source.html">step_iterator.hpp</a></li>
 172 </ul>
 173 </div><!-- contents -->
 174      <!-- HTML footer for doxygen 1.8.13-->
 175      <!-- start footer part -->
 176      <hr class="footer"/>
 177      <address class="footer">
 178       <small>
 179         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 180       </small>
 181     </address>
 182   </body>
 183 </html>