libs/gil/doc/html/reference/structboost_1_1gil_1_1_pixel_iterator_concept.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: PixelIteratorConcept&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_1_pixel_iterator_concept.html">PixelIteratorConcept</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-methods">Public Member Functions</a> &#124;
  48 <a href="#pub-attribs">Public Attributes</a> &#124;
  49 <a href="structboost_1_1gil_1_1_pixel_iterator_concept-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">PixelIteratorConcept&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_concept.html">Concepts</a> &raquo; <a class="el" href="group___pixel_iterator_concept_pixel_iterator.html">PixelIteratorConcept</a></div></div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>An STL random access traversal iterator over a model of <a class="el" href="structboost_1_1gil_1_1_pixel_concept.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</a>.
  56  <a href="structboost_1_1gil_1_1_pixel_iterator_concept.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;<a class="el" href="concepts_2pixel__iterator_8hpp_source.html">pixel_iterator.hpp</a>&gt;</code></p>
  59 <table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  61 Public Member Functions</h2></td></tr>
  62 <tr class="memitem:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memItemLeft" align="right" valign="top"><a id="ab0a0dbf6ca9028bbbb2240cad5882537"></a>
  63 void&#160;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  64 <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:aaac62f84acb6d096e136c7417ac5c592"><td class="memItemLeft" align="right" valign="top"><a id="aaac62f84acb6d096e136c7417ac5c592"></a>
  66 void&#160;</td><td class="memItemRight" valign="bottom"><b>check_base</b> (std::false_type)</td></tr>
  67 <tr class="separator:aaac62f84acb6d096e136c7417ac5c592"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:ac28243d31ddaa8ff1f4dd39bed986b61"><td class="memItemLeft" align="right" valign="top"><a id="ac28243d31ddaa8ff1f4dd39bed986b61"></a>
  69 void&#160;</td><td class="memItemRight" valign="bottom"><b>check_base</b> (std::true_type)</td></tr>
  70 <tr class="separator:ac28243d31ddaa8ff1f4dd39bed986b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table><table class="memberdecls">
  72 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  73 Public Attributes</h2></td></tr>
  74 <tr class="memitem:a8e5a0f604de6507cf17b22c030d0f079"><td class="memItemLeft" align="right" valign="top"><a id="a8e5a0f604de6507cf17b22c030d0f079"></a>
  75 Iterator&#160;</td><td class="memItemRight" valign="bottom"><b>it</b></td></tr>
  76 <tr class="separator:a8e5a0f604de6507cf17b22c030d0f079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table>
  78 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  79 <div class="textblock"><h3>template&lt;typename Iterator&gt;<br />
  80 struct boost::gil::PixelIteratorConcept&lt; Iterator &gt;</h3>
  81
  82 <p>An STL random access traversal iterator over a model of <a class="el" href="structboost_1_1gil_1_1_pixel_concept.html" title="Pixel concept - A color base whose elements are channels.">PixelConcept</a>. </p>
  83 <p>GIL's iterators must also provide the following metafunctions:</p><ul>
  84 <li><code>const_iterator_type&lt;Iterator&gt;</code>: Returns a read-only equivalent of <code>Iterator</code> </li>
  85 <li><code><a class="el" href="structboost_1_1gil_1_1iterator__is__mutable.html">iterator_is_mutable&lt;Iterator&gt;</a></code>: Returns whether the given iterator is read-only or mutable</li>
  86 <li><code>is_iterator_adaptor&lt;Iterator&gt;</code>: Returns whether the given iterator is an adaptor over another iterator. See <a class="el" href="structboost_1_1gil_1_1_iterator_adaptor_concept.html" title="Iterator adaptor is a forward iterator adapting another forward iterator.">IteratorAdaptorConcept</a> for additional requirements of adaptors.</li>
  87 </ul>
  88 <div class="fragment"><div class="line">concept PixelIteratorConcept&lt;typename Iterator&gt;</div><div class="line">    : boost_concepts::RandomAccessTraversalConcept&lt;Iterator&gt;, PixelBasedConcept&lt;Iterator&gt;</div><div class="line">{</div><div class="line">    where PixelValueConcept&lt;value_type&gt;;</div><div class="line">    <span class="keyword">typename</span> const_iterator_type&lt;It&gt;::type;</div><div class="line">        where PixelIteratorConcept&lt;const_iterator_type&lt;It&gt;::type&gt;;</div><div class="line">    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span>  iterator_is_mutable&lt;It&gt;::value;</div><div class="line">    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">bool</span>  is_iterator_adaptor&lt;It&gt;::value;   <span class="comment">// is it an iterator adaptor</span></div><div class="line">};</div></div><!-- fragment --> </div><hr/>The documentation for this struct was generated from the following file:<ul>
  89 <li><a class="el" href="concepts_2pixel__iterator_8hpp_source.html">concepts/pixel_iterator.hpp</a></li>
  90 </ul>
  91 </div><!-- contents -->
  92      <!-- HTML footer for doxygen 1.8.13-->
  93      <!-- start footer part -->
  94      <hr class="footer"/>
  95      <address class="footer">
  96       <small>
  97         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  98       </small>
  99     </address>
 100   </body>
 101 </html>