ceph/src/boost/libs/gil/doc/html/g_i_l_0036.html

   1 <!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
   2
   3      Distributed under the Boost Software License, Version 1.0.
   4      (See accompanying file LICENSE_1_0.txt or copy at
   5      http://www.boost.org/LICENSE_1_0.txt)
   6   -->
   7
   8 <!--
   9     Copyright 2005-2007 Adobe Systems Incorporated
  10     Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
  11     or a copy at http://stlab.adobe.com/licenses.html)
  12
  13     Some files are held under additional license.
  14     Please see "http://stlab.adobe.com/licenses.html" for more information.
  15 -->
  16
  17 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  18         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
  20
  21 <head>
  22     <TITLE>Generic Image Library: step_iterator_adaptor Class Template Reference</TITLE>
  23     <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
  24     <LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
  25 </head>
  26 <body>
  27 <table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
  28 <td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
  29 <div class="qindex"><a class="qindex" href="index.html">Modules</a>
  30                   | <a class="qindex" href="classes.html">Alphabetical List</a>
  31                   | <a class="qindex" href="annotated.html">Class List</a>
  32                   | <a class="qindex" href="dirs.html">Directories</a>
  33                   | <a class="qindex" href="files.html">File List</a>
  34                   | <a class="qindex" href="../index.html">GIL Home Page</a>
  35 </div>
  36 <!-- End Header -->
  37 <!-- Generated by Doxygen 1.5.6 -->
  38   <div class="navpath"><a class="el" href="namespaceboost.html">boost</a>::<b>gil</b>::<b>detail</b>::<a class="el" href="g_i_l_0036.html">step_iterator_adaptor</a>
  39   </div>
  40 <div class="contents">
  41 <h1>step_iterator_adaptor Class Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0199.html">step iterators</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::detail::step_iterator_adaptor" --><!-- doxytag: inherits="iterator_adaptor" --><code>#include &lt;<a class="el" href="g_i_l_0259.html">step_iterator.hpp</a>&gt;</code>
  45 <p>
  46 <div class="dynheader">
  47 Inheritance diagram for step_iterator_adaptor:</div>
  48 <div class="dynsection">
  49
  50 <p><center><img src="g_i_l_0005.png" usemap="#step_iterator_adaptor_map" border="0" alt=""></center>
  51 <map name="step_iterator_adaptor_map">
  52 <area href="g_i_l_0046.html" alt="memory_based_step_iterator" shape="rect" coords="0,56,174,80">
  53 </map>
  54 </div>
  55
  56 <p>
  57 <a href="g_i_l_0035.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  58 <h3>template&lt;typename Derived, typename Iterator, typename SFn&gt;<br>
  59  class boost::gil::detail::step_iterator_adaptor&lt; Derived, Iterator, SFn &gt;</h3>
  60
  61 An adaptor over an existing iterator that changes the step unit.
  62 <p>
  63 (i.e. distance(it,it+1)) by a given predicate. Instead of calling base's operators ++, --, +=, -=, etc. the adaptor is using the passed policy object SFn for advancing and for computing the distance between iterators. <table border="0" cellpadding="0" cellspacing="0">
  64 <tr><td></td></tr>
  65 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a1b6e89f2ea9e66e64e9a5da22eff92"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::parent_t" ref="3a1b6e89f2ea9e66e64e9a5da22eff92" args="" -->
  67 typedef iterator_adaptor<br>
  68 &lt; Derived, Iterator, <br>
  69 use_default, use_default, <br>
  70 use_default, typename <br>
  71 SFn::difference_type &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>parent_t</b></td></tr>
  72
  73 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38347e2b83516d4bf62701822467f4f4"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::base_difference_type" ref="38347e2b83516d4bf62701822467f4f4" args="" -->
  74 typedef std::iterator_traits<br>
  75 &lt; Iterator &gt;::difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>base_difference_type</b></td></tr>
  76
  77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8fec1ab787cf74a2f23fc3b701e4e88c"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::difference_type" ref="8fec1ab787cf74a2f23fc3b701e4e88c" args="" -->
  78 typedef SFn::difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
  79
  80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="258697e71d2606a00621f14fd7f2c5d7"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::reference" ref="258697e71d2606a00621f14fd7f2c5d7" args="" -->
  81 typedef std::iterator_traits<br>
  82 &lt; Iterator &gt;::reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
  83
  84 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15fe6eaea1e52b8f3d3e18c8abf8ada9"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::step_iterator_adaptor" ref="15fe6eaea1e52b8f3d3e18c8abf8ada9" args="(const Iterator &amp;it, SFn step_fn=SFn())" -->
  86 &nbsp;</td><td class="memItemRight" valign="bottom"><b>step_iterator_adaptor</b> (const Iterator &amp;it, SFn step_fn=SFn())</td></tr>
  87
  88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d9de021528d2fae8de7b71dbc2e3909"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::step" ref="4d9de021528d2fae8de7b71dbc2e3909" args="() const " -->
  89 difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>step</b> () const </td></tr>
  90
  91 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
  92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6f3d4cf659c02cbee3b014d8d9dc90c"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::_step_fn" ref="a6f3d4cf659c02cbee3b014d8d9dc90c" args="" -->
  93 SFn&nbsp;</td><td class="memItemRight" valign="bottom"><b>_step_fn</b></td></tr>
  94
  95 <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c09f73e325921cc50ebcd96bed0f8096"></a><!-- doxytag: member="boost::gil::detail::step_iterator_adaptor::boost::iterator_core_access" ref="c09f73e325921cc50ebcd96bed0f8096" args="" -->
  97 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
  98
  99 </table>
 100 <hr>The documentation for this class was generated from the following file:<ul>
 101 <li><a class="el" href="g_i_l_0259.html">step_iterator.hpp</a></ul>
 102 </div>
 103 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
 104 <a href="http://www.doxygen.org/index.html">
 105 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 106 </body>
 107 </html>