libs/gil/doc/html/reference/structboost_1_1gil_1_1memunit__step__fn.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: memunit_step_fn&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_1memunit__step__fn.html">memunit_step_fn</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="structboost_1_1gil_1_1memunit__step__fn-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">memunit_step_fn&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_model.html">Models</a> &raquo; <a class="el" href="group___pixel_iterator_model_step_ptr.html">step iterators</a></div></div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>function object that returns the memory unit distance between two iterators and advances a given iterator a given number of mem units (bytes or bits)
  56  <a href="structboost_1_1gil_1_1memunit__step__fn.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 <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:ace405568d0b2f3fad4990044252c7732"><td class="memItemLeft" align="right" valign="top"><a id="ace405568d0b2f3fad4990044252c7732"></a>
  63 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = std::ptrdiff_t</td></tr>
  64 <tr class="separator:ace405568d0b2f3fad4990044252c7732"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table><table class="memberdecls">
  66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  67 Public Member Functions</h2></td></tr>
  68 <tr class="memitem:ab69ffd25b45549018ce5393830b9e544"><td class="memItemLeft" align="right" valign="top"><a id="ab69ffd25b45549018ce5393830b9e544"></a>
  69 &#160;</td><td class="memItemRight" valign="bottom"><b>memunit_step_fn</b> (difference_type step=memunit_step(Iterator()))</td></tr>
  70 <tr class="separator:ab69ffd25b45549018ce5393830b9e544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a0bfc41405485bbf5e063a057dd07ee9b"><td class="memItemLeft" align="right" valign="top"><a id="a0bfc41405485bbf5e063a057dd07ee9b"></a>
  72 difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>difference</b> (const Iterator &amp;it1, const Iterator &amp;it2) const</td></tr>
  73 <tr class="separator:a0bfc41405485bbf5e063a057dd07ee9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:aea9c188f4cc3fa802a2986c5724b7b5a"><td class="memItemLeft" align="right" valign="top"><a id="aea9c188f4cc3fa802a2986c5724b7b5a"></a>
  75 void&#160;</td><td class="memItemRight" valign="bottom"><b>advance</b> (Iterator &amp;it, difference_type d) const</td></tr>
  76 <tr class="separator:aea9c188f4cc3fa802a2986c5724b7b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:abfabe1fd0d40d74b2b2c67599cd2a209"><td class="memItemLeft" align="right" valign="top"><a id="abfabe1fd0d40d74b2b2c67599cd2a209"></a>
  78 difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>step</b> () const</td></tr>
  79 <tr class="separator:abfabe1fd0d40d74b2b2c67599cd2a209"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <tr class="memitem:a8d4d1aaafc1b8756f2823bc097416151"><td class="memItemLeft" align="right" valign="top"><a id="a8d4d1aaafc1b8756f2823bc097416151"></a>
  81 void&#160;</td><td class="memItemRight" valign="bottom"><b>set_step</b> (std::ptrdiff_t step)</td></tr>
  82 <tr class="separator:a8d4d1aaafc1b8756f2823bc097416151"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 </table>
  84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85 <div class="textblock"><h3>template&lt;typename Iterator&gt;<br />
  86 struct boost::gil::memunit_step_fn&lt; Iterator &gt;</h3>
  87
  88 <p>function object that returns the memory unit distance between two iterators and advances a given iterator a given number of mem units (bytes or bits) </p>
  89 </div><hr/>The documentation for this struct was generated from the following file:<ul>
  90 <li><a class="el" href="step__iterator_8hpp_source.html">step_iterator.hpp</a></li>
  91 </ul>
  92 </div><!-- contents -->
  93      <!-- HTML footer for doxygen 1.8.13-->
  94      <!-- start footer part -->
  95      <hr class="footer"/>
  96      <address class="footer">
  97       <small>
  98         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  99       </small>
 100     </address>
 101   </body>
 102 </html>