ceph/src/boost/libs/gil/doc/html/g_i_l_0064.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: virtual_2d_locator 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_0064.html">virtual_2d_locator</a>
  39   </div>
  40 <div class="contents">
  41 <h1>virtual_2d_locator Class Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0205.html">Models</a>,&nbsp;<a class="el" href="g_i_l_0182.html">Models</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::virtual_2d_locator" --><!-- doxytag: inherits="boost::gil::pixel_2d_locator_base" --><code>#include &lt;<a class="el" href="g_i_l_0644.html">virtual_locator.hpp</a>&gt;</code>
  45 <p>
  46 <div class="dynheader">
  47 Inheritance diagram for virtual_2d_locator:</div>
  48 <div class="dynsection">
  49
  50 <p><center><img src="g_i_l_0009.png" usemap="#virtual_2d_locator_map" border="0" alt=""></center>
  51 <map name="virtual_2d_locator_map">
  52 <area href="g_i_l_0058.html" alt="pixel_2d_locator_base" shape="rect" coords="0,0,1062,24">
  53 </map>
  54 </div>
  55
  56 <p>
  57 <a href="g_i_l_0063.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  58 <h3>template&lt;typename Deref, bool IsTransposed&gt;<br>
  59  class boost::gil::virtual_2d_locator&lt; Deref, IsTransposed &gt;</h3>
  60
  61 A 2D locator over a virtual <a class="el" href="g_i_l_0038.html" title="container interface over image view. Models ImageConcept, PixelBasedConcept">image</a>. Upon dereferencing, invokes a given function object passing it its coordinates. Models: <a class="el" href="g_i_l_0354.html" title="GIL&#39;s 2-dimensional locator over immutable GIL pixels.">PixelLocatorConcept</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>, <a class="el" href="g_i_l_0292.html" title="Concept for locators and views that can define a type just like the given locator...">HasDynamicYStepTypeConcept</a>, <a class="el" href="g_i_l_0294.html" title="Concept for locators and views that can define a type just like the given locator...">HasTransposedTypeConcept</a>. <table border="0" cellpadding="0" cellspacing="0">
  62 <tr><td></td></tr>
  63 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  64 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2498b49ed4dc4fb97844eb9abfd162fd"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::parent_t" ref="2498b49ed4dc4fb97844eb9abfd162fd" args="" -->
  65 typedef <a class="el" href="g_i_l_0058.html">pixel_2d_locator_base</a><br>
  66 &lt; <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a>&lt; Deref, <br>
  67 IsTransposed &gt;<br>
  68 , <a class="el" href="g_i_l_0617.html">position_iterator</a>&lt; Deref, <br>
  69 IsTransposed &gt;<br>
  70 , <a class="el" href="g_i_l_0617.html">position_iterator</a>&lt; Deref, <br>
  71 1-IsTransposed &gt; &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="b34785b84bcb5a54734278b03ae8f2e9"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::const_t" ref="b34785b84bcb5a54734278b03ae8f2e9" args="" -->
  74 typedef <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a><br>
  75 &lt; typename Deref::const_t, <br>
  76 IsTransposed &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>const_t</b></td></tr>
  77
  78 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d400aa45d04a873ab5008403f5e98894"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::deref_fn_t" ref="d400aa45d04a873ab5008403f5e98894" args="" -->
  79 typedef Deref&nbsp;</td><td class="memItemRight" valign="bottom"><b>deref_fn_t</b></td></tr>
  80
  81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f779c3c0edb1be80714aa4ad5e5ffde0"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::point_t" ref="f779c3c0edb1be80714aa4ad5e5ffde0" args="" -->
  82 typedef <a class="el" href="g_i_l_0060.html">parent_t::point_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>point_t</b></td></tr>
  83
  84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="047d24411ab40043dbf6847f6338a041"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::coord_t" ref="047d24411ab40043dbf6847f6338a041" args="" -->
  85 typedef parent_t::coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>coord_t</b></td></tr>
  86
  87 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="533eb4300ed17bd6736e87ae328fdff5"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::x_coord_t" ref="533eb4300ed17bd6736e87ae328fdff5" args="" -->
  88 typedef parent_t::x_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b></td></tr>
  89
  90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95060f394e5c23f9f15282c3fd6fe588"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::y_coord_t" ref="95060f394e5c23f9f15282c3fd6fe588" args="" -->
  91 typedef parent_t::y_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b></td></tr>
  92
  93 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="397e495b7f82699fdd7f80b6b52fee34"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::x_iterator" ref="397e495b7f82699fdd7f80b6b52fee34" args="" -->
  94 typedef parent_t::x_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_iterator</b></td></tr>
  95
  96 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df65c5fdc3dc0b541734105fa4b5502a"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::y_iterator" ref="df65c5fdc3dc0b541734105fa4b5502a" args="" -->
  97 typedef parent_t::y_iterator&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_iterator</b></td></tr>
  98
  99 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 100 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fc04e2ed8d75278fc31fc5e4e497346"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="2fc04e2ed8d75278fc31fc5e4e497346" args="(const point_t &amp;p=point_t(0, 0), const point_t &amp;step=point_t(1, 1), const deref_fn_t &amp;d=deref_fn_t())" -->
 101 &nbsp;</td><td class="memItemRight" valign="bottom"><b>virtual_2d_locator</b> (const <a class="el" href="g_i_l_0060.html">point_t</a> &amp;p=<a class="el" href="g_i_l_0060.html">point_t</a>(0, 0), const <a class="el" href="g_i_l_0060.html">point_t</a> &amp;step=<a class="el" href="g_i_l_0060.html">point_t</a>(1, 1), const deref_fn_t &amp;d=deref_fn_t())</td></tr>
 102
 103 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="94f77e33504ae67547d0cdaf59bd9cbf"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="94f77e33504ae67547d0cdaf59bd9cbf" args="(const virtual_2d_locator&lt; D, TR &gt; &amp;loc, coord_t y_step)" -->
 104 template&lt;typename D, bool TR&gt; </td></tr>
 105 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>virtual_2d_locator</b> (const <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a>&lt; D, TR &gt; &amp;loc, coord_t y_step)</td></tr>
 106
 107 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6d02cc040963e5bf8318a3e5dfdaf58a"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="6d02cc040963e5bf8318a3e5dfdaf58a" args="(const virtual_2d_locator&lt; D, TR &gt; &amp;loc, coord_t x_step, coord_t y_step, bool transpose=false)" -->
 108 template&lt;typename D, bool TR&gt; </td></tr>
 109 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>virtual_2d_locator</b> (const <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a>&lt; D, TR &gt; &amp;loc, coord_t x_step, coord_t y_step, bool transpose=false)</td></tr>
 110
 111 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7b4fe54791bc7d5ab5719ef834c95678"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="7b4fe54791bc7d5ab5719ef834c95678" args="(const virtual_2d_locator&lt; D, TR &gt; &amp;pl)" -->
 112 template&lt;typename D, bool TR&gt; </td></tr>
 113 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>virtual_2d_locator</b> (const <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a>&lt; D, TR &gt; &amp;pl)</td></tr>
 114
 115 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4887e3b22290b18d76a425c988c2635f"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="4887e3b22290b18d76a425c988c2635f" args="(const virtual_2d_locator &amp;pl)" -->
 116 &nbsp;</td><td class="memItemRight" valign="bottom"><b>virtual_2d_locator</b> (const <a class="el" href="g_i_l_0064.html">virtual_2d_locator</a> &amp;pl)</td></tr>
 117
 118 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8405fcf56e5ae86b1d96a36d77db6b0"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::operator==" ref="c8405fcf56e5ae86b1d96a36d77db6b0" args="(const this_t &amp;p) const " -->
 119 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="g_i_l_0064.html">this_t</a> &amp;p) const </td></tr>
 120
 121 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="72169bdc650ac7eda288398e4ce1d7f8"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::x" ref="72169bdc650ac7eda288398e4ce1d7f8" args="()" -->
 122 x_iterator &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>x</b> ()</td></tr>
 123
 124 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7ca2bdfc5a0be2b150b22dddfd9b10f"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::y" ref="c7ca2bdfc5a0be2b150b22dddfd9b10f" args="()" -->
 125 y_iterator &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>y</b> ()</td></tr>
 126
 127 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e86d37c383d7cbafbd4969321d07ae7"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::x" ref="1e86d37c383d7cbafbd4969321d07ae7" args="() const " -->
 128 x_iterator const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>x</b> () const </td></tr>
 129
 130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8d8247ad88b73c9bb3b5d7122064ec59"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::y" ref="8d8247ad88b73c9bb3b5d7122064ec59" args="() const " -->
 131 y_iterator const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>y</b> () const </td></tr>
 132
 133 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b544d65a4469f55df14d226da88c44d5"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::y_distance_to" ref="b544d65a4469f55df14d226da88c44d5" args="(const this_t &amp;it2, x_coord_t xDiff) const " -->
 134 y_coord_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_distance_to</b> (const <a class="el" href="g_i_l_0064.html">this_t</a> &amp;it2, x_coord_t xDiff) const </td></tr>
 135
 136 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6160a6a46b4f4cbef39a28a45027060c"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::is_1d_traversable" ref="6160a6a46b4f4cbef39a28a45027060c" args="(x_coord_t) const " -->
 137 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>is_1d_traversable</b> (x_coord_t) const </td></tr>
 138
 139 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa3dcf1288cb11be49a44552d5916f9b"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::pos" ref="aa3dcf1288cb11be49a44552d5916f9b" args="() const " -->
 140 const <a class="el" href="g_i_l_0060.html">point_t</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>pos</b> () const </td></tr>
 141
 142 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe5624cfe9b661059ebf68a2c2659275"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::step" ref="fe5624cfe9b661059ebf68a2c2659275" args="() const " -->
 143 const <a class="el" href="g_i_l_0060.html">point_t</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>step</b> () const </td></tr>
 144
 145 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e75df2849bc94fdefa19b47d25d287d4"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::deref_fn" ref="e75df2849bc94fdefa19b47d25d287d4" args="() const " -->
 146 const deref_fn_t &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>deref_fn</b> () const </td></tr>
 147
 148 <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
 149 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b02ecb4ac0469214a5f91ac3d8510c4a"></a><!-- doxytag: member="boost::gil::virtual_2d_locator::virtual_2d_locator" ref="b02ecb4ac0469214a5f91ac3d8510c4a" args="" -->
 150 class&nbsp;</td><td class="memItemRight" valign="bottom"><b>virtual_2d_locator</b></td></tr>
 151
 152 </table>
 153 <hr>The documentation for this class was generated from the following file:<ul>
 154 <li><a class="el" href="g_i_l_0644.html">virtual_locator.hpp</a></ul>
 155 </div>
 156 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
 157 <a href="http://www.doxygen.org/index.html">
 158 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 159 </body>
 160 </html>