ceph/src/boost/libs/gil/doc/html/g_i_l_0401.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: bit_aligned_pixel_iterator 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_0401.html">bit_aligned_pixel_iterator</a>
  39   </div>
  40 <div class="contents">
  41 <h1>bit_aligned_pixel_iterator Struct Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0201.html">bit_aligned_pixel_iterator</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::bit_aligned_pixel_iterator" --><code>#include &lt;<a class="el" href="g_i_l_0010.html">bit_aligned_pixel_iterator.hpp</a>&gt;</code>
  45 <p>
  46
  47 <p>
  48 <a href="g_i_l_0400.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  49 <h3>template&lt;typename NonAlignedPixelReference&gt;<br>
  50  struct boost::gil::bit_aligned_pixel_iterator&lt; NonAlignedPixelReference &gt;</h3>
  51
  52 An iterator over non-byte-aligned pixels. Models <a class="el" href="g_i_l_0352.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="g_i_l_0344.html" title="Concept for all pixel-based GIL constructs, such as pixels, iterators, locators,...">PixelBasedConcept</a>, <a class="el" href="g_i_l_0312.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or...">MemoryBasedIteratorConcept</a>, <a class="el" href="g_i_l_0290.html" title="Concept for iterators, locators and views that can define a type just like the given...">HasDynamicXStepTypeConcept</a>.
  53 <p>
  54 An iterator over pixels that correspond to non-byte-aligned bit ranges. Examples of such pixels are single bit grayscale <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</a>, or a 6-bit RGB 222 <a class="el" href="g_i_l_0599.html" title="Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept...">pixel</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="af1864eda36a1748894be741b3d64bde"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::difference_type" ref="af1864eda36a1748894be741b3d64bde" args="" -->
  58 typedef parent_t::difference_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
  59
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6c80bdd4dcae459dd371e3d941b83468"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::reference" ref="6c80bdd4dcae459dd371e3d941b83468" args="" -->
  61 typedef parent_t::reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
  62
  63 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="97cc267cffad3d7413aa13c11d9172bb"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_aligned_pixel_iterator" ref="97cc267cffad3d7413aa13c11d9172bb" args="(const bit_aligned_pixel_iterator &amp;p)" -->
  65 &nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (const <a class="el" href="g_i_l_0401.html">bit_aligned_pixel_iterator</a> &amp;p)</td></tr>
  66
  67 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31fe24d00d718ba4c265224c2f058eff"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::operator=" ref="31fe24d00d718ba4c265224c2f058eff" args="(const bit_aligned_pixel_iterator &amp;p)" -->
  68 <a class="el" href="g_i_l_0401.html">bit_aligned_pixel_iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="g_i_l_0401.html">bit_aligned_pixel_iterator</a> &amp;p)</td></tr>
  69
  70 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="04c27063da7f37fafae126a4ea274d8a"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_aligned_pixel_iterator" ref="04c27063da7f37fafae126a4ea274d8a" args="(const bit_aligned_pixel_iterator&lt; Ref &gt; &amp;p)" -->
  71 template&lt;typename Ref&gt; </td></tr>
  72 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (const <a class="el" href="g_i_l_0401.html">bit_aligned_pixel_iterator</a>&lt; Ref &gt; &amp;p)</td></tr>
  73
  74 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26e6dc7fc834136b6a8955287f65f685"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_aligned_pixel_iterator" ref="26e6dc7fc834136b6a8955287f65f685" args="(reference *ref)" -->
  75 &nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (reference *ref)</td></tr>
  76
  77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bd45ffa88b7303eec204718824892cee"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_aligned_pixel_iterator" ref="bd45ffa88b7303eec204718824892cee" args="(typename bit_range_t::byte_t *data, int bit_offset=0)" -->
  78 &nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b> (typename bit_range_t::byte_t *data, int bit_offset=0)</td></tr>
  79
  80 <tr><td class="memItemLeft" nowrap align="right" valign="top">reference&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="g_i_l_0401.html#de1279c4ed222b6efb0867c038765ea1">operator[]</a> (difference_type d) const </td></tr>
  81
  82 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab60bdc7f960c3cc5d9529912de62dfd"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::operator-&gt;" ref="ab60bdc7f960c3cc5d9529912de62dfd" args="() const " -->
  83 reference&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator-&gt;</b> () const </td></tr>
  84
  85 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4930ce6d0686634aa4695f47e0e9e64e"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_range" ref="4930ce6d0686634aa4695f47e0e9e64e" args="() const " -->
  86 const bit_range_t &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> () const </td></tr>
  87
  88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9aa87c78490cd8bc74b338c81490730"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_range" ref="b9aa87c78490cd8bc74b338c81490730" args="()" -->
  89 bit_range_t &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_range</b> ()</td></tr>
  90
  91 <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3addb4416a1998f5d3e810b0d753a41"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::bit_aligned_pixel_iterator" ref="c3addb4416a1998f5d3e810b0d753a41" args="" -->
  93 struct&nbsp;</td><td class="memItemRight" valign="bottom"><b>bit_aligned_pixel_iterator</b></td></tr>
  94
  95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c09f73e325921cc50ebcd96bed0f8096"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::boost::iterator_core_access" ref="c09f73e325921cc50ebcd96bed0f8096" args="" -->
  96 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
  97
  98 </table>
  99 <hr><h2>Member Function Documentation</h2>
 100 <a class="anchor" name="de1279c4ed222b6efb0867c038765ea1"></a><!-- doxytag: member="boost::gil::bit_aligned_pixel_iterator::operator[]" ref="de1279c4ed222b6efb0867c038765ea1" args="(difference_type d) const " -->
 101 <div class="memitem">
 102 <div class="memproto">
 103       <table class="memname">
 104         <tr>
 105           <td class="memname">reference operator[]           </td>
 106           <td>(</td>
 107           <td class="paramtype">difference_type&nbsp;</td>
 108           <td class="paramname"> <em>d</em>          </td>
 109           <td>&nbsp;)&nbsp;</td>
 110           <td> const<code> [inline]</code></td>
 111         </tr>
 112       </table>
 113 </div>
 114 <div class="memdoc">
 115
 116 <p>
 117 For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits
 118 </div>
 119 </div><p>
 120 <hr>The documentation for this struct was generated from the following file:<ul>
 121 <li><a class="el" href="g_i_l_0010.html">bit_aligned_pixel_iterator.hpp</a></ul>
 122 </div>
 123 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:17 2009 for Generic Image Library by&nbsp;
 124 <a href="http://www.doxygen.org/index.html">
 125 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 126 </body>
 127 </html>