ceph/src/boost/libs/gil/doc/html/g_i_l_0368.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: RandomAccess2DLocatorConcept 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_0368.html">RandomAccess2DLocatorConcept</a>
  39   </div>
  40 <div class="contents">
  41 <h1>RandomAccess2DLocatorConcept Struct Template Reference<br>
  42 <small>
  43 [<a class="el" href="g_i_l_0171.html">RandomAccess2DLocatorConcept</a>]</small>
  44 </h1><!-- doxytag: class="boost::gil::RandomAccess2DLocatorConcept" --><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_0367.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  49 <h3>template&lt;typename Loc&gt;<br>
  50  struct boost::gil::RandomAccess2DLocatorConcept&lt; Loc &gt;</h3>
  51
  52 2-dimensional locator over immutable values
  53 <p>
  54 <div class="fragment"><pre class="fragment">concept RandomAccess2DLocatorConcept&lt;RandomAccessNDLocatorConcept Loc&gt; {
  55     where num_dimensions==2;
  56     where Point2DConcept&lt;point_t&gt;;
  57
  58     <span class="keyword">typename</span> x_iterator = axis&lt;0&gt;::iterator;
  59     <span class="keyword">typename</span> y_iterator = axis&lt;1&gt;::iterator;
  60     <span class="keyword">typename</span> x_coord_t  = axis&lt;0&gt;::coord_t;
  61     <span class="keyword">typename</span> y_coord_t  = axis&lt;1&gt;::coord_t;
  62
  63     <span class="comment">// Only available to locators that have dynamic step in Y</span>
  64     <span class="comment">//Loc::Loc(const Loc&amp; loc, y_coord_t);</span>
  65
  66     <span class="comment">// Only available to locators that have dynamic step in X and Y</span>
  67     <span class="comment">//Loc::Loc(const Loc&amp; loc, x_coord_t, y_coord_t, bool transposed=false);</span>
  68
  69     x_iterator&amp;       Loc::x();
  70     x_iterator <span class="keyword">const</span>&amp; Loc::x() <span class="keyword">const</span>;
  71     y_iterator&amp;       Loc::y();
  72     y_iterator <span class="keyword">const</span>&amp; Loc::y() <span class="keyword">const</span>;
  73
  74     x_iterator Loc::x_at(<span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>;
  75     y_iterator Loc::y_at(<span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>;
  76     Loc Loc::xy_at(<span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>;
  77
  78     <span class="comment">// x/y versions of all methods that can take difference type</span>
  79     x_iterator        Loc::x_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;
  80     y_iterator        Loc::y_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;
  81     Loc               Loc::xy_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;
  82     reference         operator()(<span class="keyword">const</span> Loc&amp;, x_coord_t, y_coord_t);
  83     cached_location_t Loc::cache_location(x_coord_t, y_coord_t) <span class="keyword">const</span>;
  84
  85     <span class="keywordtype">bool</span>      Loc::is_1d_traversable(x_coord_t width) <span class="keyword">const</span>;
  86     y_coord_t Loc::y_distance_to(<span class="keyword">const</span> Loc&amp; loc2, x_coord_t x_diff) <span class="keyword">const</span>;
  87 };
  88 </pre></div> <table border="0" cellpadding="0" cellspacing="0">
  89 <tr><td></td></tr>
  90 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  91 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0a0dbf6ca9028bbbb2240cad5882537"></a><!-- doxytag: member="boost::gil::RandomAccess2DLocatorConcept::constraints" ref="b0a0dbf6ca9028bbbb2240cad5882537" args="()" -->
  92 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  93
  94 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  95 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78b239cb3da334ec5ca272453ae698f1"></a><!-- doxytag: member="boost::gil::RandomAccess2DLocatorConcept::loc" ref="78b239cb3da334ec5ca272453ae698f1" args="" -->
  96 Loc&nbsp;</td><td class="memItemRight" valign="bottom"><b>loc</b></td></tr>
  97
  98 </table>
  99 <hr>The documentation for this struct was generated from the following file:<ul>
 100 <li><a class="el" href="g_i_l_0091.html">gil_concept.hpp</a></ul>
 101 </div>
 102 <hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:18 2009 for Generic Image Library by&nbsp;
 103 <a href="http://www.doxygen.org/index.html">
 104 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 105 </body>
 106 </html>