ceph/src/boost/libs/gil/doc/html/g_i_l_0310.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: IteratorAdaptorConcept Struct 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_0310.html">IteratorAdaptorConcept</a>
  39   </div>
  40 <div class="contents">
  41 <h1>IteratorAdaptorConcept Struct Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0190.html">IteratorAdaptorConcept</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::IteratorAdaptorConcept" --><code>#include &lt;<a class="el" href="g_i_l_0091.html">gil_concept.hpp</a>&gt;</code>
  45 <p>
  46
  47 <p>
  48 <a href="g_i_l_0309.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  49 <h3>template&lt;typename Iterator&gt;<br>
  50  struct boost::gil::IteratorAdaptorConcept&lt; Iterator &gt;</h3>
  51
  52 Iterator adaptor is a forward iterator adapting another forward iterator.
  53 <p>
  54 In addition to GIL iterator requirements, GIL iterator adaptors must provide the following metafunctions:<ul>
  55 <li><code>is_iterator_adaptor&lt;Iterator&gt;</code>: Returns <code>mpl::true_</code> </li><li><code>iterator_adaptor_get_base&lt;Iterator&gt;</code>: Returns the base iterator type</li><li><code>iterator_adaptor_rebind&lt;Iterator,NewBase&gt;</code>: Replaces the base iterator with the new one</li></ul>
  56 <p>
  57 The adaptee can be obtained from the iterator via the "base()" method.<p>
  58 <div class="fragment"><pre class="fragment">concept IteratorAdaptorConcept&lt;boost_concepts::ForwardTraversalConcept Iterator&gt; {
  59     where SameType&lt;is_iterator_adaptor&lt;Iterator&gt;::type, mpl::true_&gt;;
  60
  61     <span class="keyword">typename</span> iterator_adaptor_get_base&lt;Iterator&gt;;
  62         where Metafunction&lt;iterator_adaptor_get_base&lt;Iterator&gt; &gt;;
  63         where boost_concepts::ForwardTraversalConcept&lt;iterator_adaptor_get_base&lt;Iterator&gt;::type&gt;;
  64
  65     <span class="keyword">typename</span> another_iterator;
  66     <span class="keyword">typename</span> iterator_adaptor_rebind&lt;Iterator,another_iterator&gt;::type;
  67         where boost_concepts::ForwardTraversalConcept&lt;another_iterator&gt;;
  68         where IteratorAdaptorConcept&lt;iterator_adaptor_rebind&lt;Iterator,another_iterator&gt;::type&gt;;
  69
  70     <span class="keyword">const</span> iterator_adaptor_get_base&lt;Iterator&gt;::type&amp; Iterator::base() <span class="keyword">const</span>;
  71 };
  72 </pre></div> <table border="0" cellpadding="0" cellspacing="0">
  73 <tr><td></td></tr>
  74 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  75 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0a0dbf6ca9028bbbb2240cad5882537"></a><!-- doxytag: member="boost::gil::IteratorAdaptorConcept::constraints" ref="b0a0dbf6ca9028bbbb2240cad5882537" args="()" -->
  76 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  77
  78 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  79 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e5a0f604de6507cf17b22c030d0f079"></a><!-- doxytag: member="boost::gil::IteratorAdaptorConcept::it" ref="8e5a0f604de6507cf17b22c030d0f079" args="" -->
  80 Iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>it</b></td></tr>
  81
  82 </table>
  83 <hr>The documentation for this struct was generated from the following file:<ul>
  84 <li><a class="el" href="g_i_l_0091.html">gil_concept.hpp</a></ul>
  85 </div>
  86 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:17 2009 for Generic Image Library by&nbsp;
  87 <a href="http://www.doxygen.org/index.html">
  88 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  89 </body>
  90 </html>