libs/gil/doc/html/reference/classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.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: step_iterator_adaptor&lt; Derived, Iterator, SFn &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"><b>detail</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html">step_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="#pro-attribs">Protected Attributes</a> &#124;
  50 <a href="#friends">Friends</a> &#124;
  51 <a href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor-members.html">List of all members</a>  </div>
  52   <div class="headertitle">
  53 <div class="title">step_iterator_adaptor&lt; Derived, Iterator, SFn &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></div></div>  </div>
  54 </div><!--header-->
  55 <div class="contents">
  56
  57 <p>An adaptor over an existing iterator that changes the step unit.
  58  <a href="classboost_1_1gil_1_1detail_1_1step__iterator__adaptor.html#details">More...</a></p>
  59
  60 <p><code>#include &lt;<a class="el" href="step__iterator_8hpp_source.html">step_iterator.hpp</a>&gt;</code></p>
  61
  62 <p>Inherits iterator_adaptor&lt; Derived, Iterator, use_default, use_default, use_default, SFn::difference_type &gt;.</p>
  63 <table class="memberdecls">
  64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  65 Public Types</h2></td></tr>
  66 <tr class="memitem:aaddc7de362ea82f391ca5035f9d418da"><td class="memItemLeft" align="right" valign="top"><a id="aaddc7de362ea82f391ca5035f9d418da"></a>
  67 using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = iterator_adaptor&lt; Derived, Iterator, use_default, use_default, use_default, typename SFn::difference_type &gt;</td></tr>
  68 <tr class="separator:aaddc7de362ea82f391ca5035f9d418da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:ac3ecbee039e86d5e6592e81da05c7e79"><td class="memItemLeft" align="right" valign="top"><a id="ac3ecbee039e86d5e6592e81da05c7e79"></a>
  70 using&#160;</td><td class="memItemRight" valign="bottom"><b>base_difference_type</b> = typename std::iterator_traits&lt; Iterator &gt;::difference_type</td></tr>
  71 <tr class="separator:ac3ecbee039e86d5e6592e81da05c7e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:a8254ddd51f36f5f0dd01c55b45ee5c89"><td class="memItemLeft" align="right" valign="top"><a id="a8254ddd51f36f5f0dd01c55b45ee5c89"></a>
  73 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename SFn::difference_type</td></tr>
  74 <tr class="separator:a8254ddd51f36f5f0dd01c55b45ee5c89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:a57d818f6bd24dee2a8803cb3be635373"><td class="memItemLeft" align="right" valign="top"><a id="a57d818f6bd24dee2a8803cb3be635373"></a>
  76 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename std::iterator_traits&lt; Iterator &gt;::reference</td></tr>
  77 <tr class="separator:a57d818f6bd24dee2a8803cb3be635373"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table><table class="memberdecls">
  79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80 Public Member Functions</h2></td></tr>
  81 <tr class="memitem:a15fe6eaea1e52b8f3d3e18c8abf8ada9"><td class="memItemLeft" align="right" valign="top"><a id="a15fe6eaea1e52b8f3d3e18c8abf8ada9"></a>
  82 &#160;</td><td class="memItemRight" valign="bottom"><b>step_iterator_adaptor</b> (const Iterator &amp;it, SFn step_fn=SFn())</td></tr>
  83 <tr class="separator:a15fe6eaea1e52b8f3d3e18c8abf8ada9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 <tr class="memitem:abfabe1fd0d40d74b2b2c67599cd2a209"><td class="memItemLeft" align="right" valign="top"><a id="abfabe1fd0d40d74b2b2c67599cd2a209"></a>
  85 difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>step</b> () const</td></tr>
  86 <tr class="separator:abfabe1fd0d40d74b2b2c67599cd2a209"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 </table><table class="memberdecls">
  88 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  89 Protected Attributes</h2></td></tr>
  90 <tr class="memitem:aa6f3d4cf659c02cbee3b014d8d9dc90c"><td class="memItemLeft" align="right" valign="top"><a id="aa6f3d4cf659c02cbee3b014d8d9dc90c"></a>
  91 SFn&#160;</td><td class="memItemRight" valign="bottom"><b>_step_fn</b></td></tr>
  92 <tr class="separator:aa6f3d4cf659c02cbee3b014d8d9dc90c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 </table><table class="memberdecls">
  94 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  95 Friends</h2></td></tr>
  96 <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
  97 class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
  98 <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 </table>
 100 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 101 <div class="textblock"><h3>template&lt;typename Derived, typename Iterator, typename SFn&gt;<br />
 102 class boost::gil::detail::step_iterator_adaptor&lt; Derived, Iterator, SFn &gt;</h3>
 103
 104 <p>An adaptor over an existing iterator that changes the step unit. </p>
 105 <p>(i.e. distance(it,it+1)) by a given predicate. Instead of calling base's operators ++, &ndash;, +=, -=, etc. the adaptor is using the passed policy object SFn for advancing and for computing the distance between iterators. </p>
 106 </div><hr/>The documentation for this class was generated from the following file:<ul>
 107 <li><a class="el" href="step__iterator_8hpp_source.html">step_iterator.hpp</a></li>
 108 </ul>
 109 </div><!-- contents -->
 110      <!-- HTML footer for doxygen 1.8.13-->
 111      <!-- start footer part -->
 112      <hr class="footer"/>
 113      <address class="footer">
 114       <small>
 115         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 116       </small>
 117     </address>
 118   </body>
 119 </html>