ceph/src/boost/libs/gil/doc/html/g_i_l_0026.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: dereference_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>::<a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a>
  39   </div>
  40 <div class="contents">
  41 <h1>dereference_iterator_adaptor Class Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0194.html">dereference_iterator_adaptor</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::dereference_iterator_adaptor" --><!-- doxytag: inherits="iterator_adaptor" --><code>#include &lt;<a class="el" href="g_i_l_0244.html">pixel_iterator_adaptor.hpp</a>&gt;</code>
  45 <p>
  46 Inherits iterator_adaptor&lt; boost::gil::dereference_iterator_adaptor&lt; Iterator, DFn &gt;, Iterator, DFn::value_type, use_default, DFn::reference, use_default &gt;.
  47 <p>
  48
  49 <p>
  50 <a href="g_i_l_0025.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  51 <h3>template&lt;typename Iterator, typename DFn&gt;<br>
  52  class boost::gil::dereference_iterator_adaptor&lt; Iterator, DFn &gt;</h3>
  53
  54 An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: <a class="el" href="g_i_l_0310.html" title="Iterator adaptor is a forward iterator adapting another forward iterator.">IteratorAdaptorConcept</a>, <a class="el" href="g_i_l_0352.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>. <table border="0" cellpadding="0" cellspacing="0">
  55 <tr><td></td></tr>
  56 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc63a336589f8e781f0f1e6213340e2f"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::parent_t" ref="fc63a336589f8e781f0f1e6213340e2f" args="" -->
  58 typedef iterator_adaptor<br>
  59 &lt; <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a><br>
  60 &lt; Iterator, DFn &gt;, Iterator, <br>
  61 typename DFn::value_type, <br>
  62 use_default, typename <br>
  63 DFn::reference, use_default &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>parent_t</b></td></tr>
  64
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="925a77333811e037f4a6d8646999518b"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::reference" ref="925a77333811e037f4a6d8646999518b" args="" -->
  66 typedef DFn::result_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
  67
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e6780c1f76e61ef32d8d9682be7cf9f"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::difference_type" ref="2e6780c1f76e61ef32d8d9682be7cf9f" args="" -->
  69 typedef std::iterator_traits<br>
  70 &lt; Iterator &gt;::difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
  71
  72 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c82fa666cbc2cbbc0edea3c495001a39"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::dereference_fn" ref="c82fa666cbc2cbbc0edea3c495001a39" args="" -->
  73 typedef DFn&nbsp;</td><td class="memItemRight" valign="bottom"><b>dereference_fn</b></td></tr>
  74
  75 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  76 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="719878495aa8c962f9018b4a5f884ce6"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::dereference_iterator_adaptor" ref="719878495aa8c962f9018b4a5f884ce6" args="(const dereference_iterator_adaptor&lt; Iterator1, DFn &gt; &amp;dit)" -->
  77 template&lt;typename Iterator1&gt; </td></tr>
  78 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a>&lt; Iterator1, DFn &gt; &amp;dit)</td></tr>
  79
  80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59216761b450991ae857f8ed69ace8ba"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::dereference_iterator_adaptor" ref="59216761b450991ae857f8ed69ace8ba" args="(Iterator it, DFn deref_fn=DFn())" -->
  81 &nbsp;</td><td class="memItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (Iterator it, DFn deref_fn=DFn())</td></tr>
  82
  83 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="bb777a3f4899e0b98ec05a9b3b19a157"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::dereference_iterator_adaptor" ref="bb777a3f4899e0b98ec05a9b3b19a157" args="(const dereference_iterator_adaptor&lt; Iterator1, DFn1 &gt; &amp;it)" -->
  84 template&lt;typename Iterator1, typename DFn1&gt; </td></tr>
  85 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>dereference_iterator_adaptor</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a>&lt; Iterator1, DFn1 &gt; &amp;it)</td></tr>
  86
  87 <tr><td class="memItemLeft" nowrap align="right" valign="top">reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0026.html#de1279c4ed222b6efb0867c038765ea1">operator[]</a> (difference_type d) const </td></tr>
  88
  89 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ee047e7f335eb8afd77ea58e94ad2c5"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator&gt;" ref="0ee047e7f335eb8afd77ea58e94ad2c5" args="(const dereference_iterator_adaptor &amp;p) const " -->
  90 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
  91
  92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c83520fc09f8fb9a789662732a76924f"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator&lt;" ref="c83520fc09f8fb9a789662732a76924f" args="(const dereference_iterator_adaptor &amp;p) const " -->
  93 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
  94
  95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c16d7b7aad842c0544397598e426bfed"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator&gt;=" ref="c16d7b7aad842c0544397598e426bfed" args="(const dereference_iterator_adaptor &amp;p) const " -->
  96 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;=</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
  97
  98 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60155c31954beb550e2f6e79df654445"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator&lt;=" ref="60155c31954beb550e2f6e79df654445" args="(const dereference_iterator_adaptor &amp;p) const " -->
  99 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;=</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
 100
 101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="776301b8564074bfb69b226a1994cf16"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator==" ref="776301b8564074bfb69b226a1994cf16" args="(const dereference_iterator_adaptor &amp;p) const " -->
 102 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
 103
 104 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21ce52ab4ea954ac9d6a81cf7bf6b0f6"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator!=" ref="21ce52ab4ea954ac9d6a81cf7bf6b0f6" args="(const dereference_iterator_adaptor &amp;p) const " -->
 105 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="g_i_l_0026.html">dereference_iterator_adaptor</a> &amp;p) const </td></tr>
 106
 107 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="048bfb0fc9c6a14faae4c65e841ee2d8"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::base" ref="048bfb0fc9c6a14faae4c65e841ee2d8" args="()" -->
 108 Iterator &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>base</b> ()</td></tr>
 109
 110 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46641e88a4cfc59b489f75d868bc2269"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::base" ref="46641e88a4cfc59b489f75d868bc2269" args="() const " -->
 111 const Iterator &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>base</b> () const </td></tr>
 112
 113 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53175a49e7ed40f9aa59e89556149573"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::deref_fn" ref="53175a49e7ed40f9aa59e89556149573" args="() const " -->
 114 const DFn &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>deref_fn</b> () const </td></tr>
 115
 116 <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
 117 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1297b5a5a58dc9f2266f6ce275a2bed6"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::dereference_iterator_adaptor" ref="1297b5a5a58dc9f2266f6ce275a2bed6" args="" -->
 118 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>dereference_iterator_adaptor</b></td></tr>
 119
 120 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c09f73e325921cc50ebcd96bed0f8096"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::boost::iterator_core_access" ref="c09f73e325921cc50ebcd96bed0f8096" args="" -->
 121 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
 122
 123 </table>
 124 <hr><h2>Member Function Documentation</h2>
 125 <a class="anchor" name="de1279c4ed222b6efb0867c038765ea1"></a><!-- doxytag: member="boost::gil::dereference_iterator_adaptor::operator[]" ref="de1279c4ed222b6efb0867c038765ea1" args="(difference_type d) const " -->
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">reference operator[]           </td>
 131           <td>(</td>
 132           <td class="paramtype">difference_type&nbsp;</td>
 133           <td class="paramname"> <em>d</em>          </td>
 134           <td>&nbsp;)&nbsp;</td>
 135           <td> const<code> [inline]</code></td>
 136         </tr>
 137       </table>
 138 </div>
 139 <div class="memdoc">
 140
 141 <p>
 142 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
 143 </div>
 144 </div><p>
 145 <hr>The documentation for this class was generated from the following file:<ul>
 146 <li><a class="el" href="g_i_l_0244.html">pixel_iterator_adaptor.hpp</a></ul>
 147 </div>
 148 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
 149 <a href="http://www.doxygen.org/index.html">
 150 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 151 </body>
 152 </html>