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">
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: RandomAccess2DLocatorConcept< Loc > 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"/>
17 <div class="boost-header">
18 <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
20 <td valign="top" width="300">
21 <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
23 <td ><h1 align="center"><a href="../index.html"></a></h1></td>
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&dn=gpl-2.0.txt GPL-v2 */
36 initMenu('',false,false,'search.php','Search');
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
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_random_access2_d_locator_concept.html">RandomAccess2DLocatorConcept</a></li> </ul>
47 <a href="#pub-methods">Public Member Functions</a> |
48 <a href="#pub-attribs">Public Attributes</a> |
49 <a href="structboost_1_1gil_1_1_random_access2_d_locator_concept-members.html">List of all members</a> </div>
50 <div class="headertitle">
51 <div class="title">RandomAccess2DLocatorConcept< Loc > Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_locator.html">Pixel Locator</a> » <a class="el" href="group___pixel_locator_concept.html">Concepts</a> » <a class="el" href="group___locator2_d_concept.html">RandomAccess2DLocatorConcept</a></div></div> </div>
53 <div class="contents">
55 <p>2-dimensional locator over immutable values
56 <a href="structboost_1_1gil_1_1_random_access2_d_locator_concept.html#details">More...</a></p>
58 <p><code>#include <<a class="el" href="pixel__locator_8hpp_source.html">pixel_locator.hpp</a>></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 </td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
64 <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2"> </td></tr>
65 </table><table class="memberdecls">
66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
67 Public Attributes</h2></td></tr>
68 <tr class="memitem:a78b239cb3da334ec5ca272453ae698f1"><td class="memItemLeft" align="right" valign="top"><a id="a78b239cb3da334ec5ca272453ae698f1"></a>
69 Loc </td><td class="memItemRight" valign="bottom"><b>loc</b></td></tr>
70 <tr class="separator:a78b239cb3da334ec5ca272453ae698f1"><td class="memSeparator" colspan="2"> </td></tr>
72 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
73 <div class="textblock"><h3>template<typename Loc><br />
74 struct boost::gil::RandomAccess2DLocatorConcept< Loc ></h3>
76 <p>2-dimensional locator over immutable values </p>
77 <div class="fragment"><div class="line">concept RandomAccess2DLocatorConcept<RandomAccessNDLocatorConcept Loc></div><div class="line">{</div><div class="line"> where num_dimensions==2;</div><div class="line"> where Point2DConcept<point_t>;</div><div class="line"></div><div class="line"> <span class="keyword">typename</span> x_iterator = axis<0>::iterator;</div><div class="line"> <span class="keyword">typename</span> y_iterator = axis<1>::iterator;</div><div class="line"> <span class="keyword">typename</span> x_coord_t = axis<0>::coord_t;</div><div class="line"> <span class="keyword">typename</span> y_coord_t = axis<1>::coord_t;</div><div class="line"></div><div class="line"> <span class="comment">// Only available to locators that have dynamic step in Y</span></div><div class="line"> <span class="comment">//Loc::Loc(const Loc& loc, y_coord_t);</span></div><div class="line"></div><div class="line"> <span class="comment">// Only available to locators that have dynamic step in X and Y</span></div><div class="line"> <span class="comment">//Loc::Loc(const Loc& loc, x_coord_t, y_coord_t, bool transposed=false);</span></div><div class="line"></div><div class="line"> x_iterator& Loc::x();</div><div class="line"> x_iterator <span class="keyword">const</span>& Loc::x() <span class="keyword">const</span>;</div><div class="line"> y_iterator& Loc::y();</div><div class="line"> y_iterator <span class="keyword">const</span>& Loc::y() <span class="keyword">const</span>;</div><div class="line"></div><div class="line"> x_iterator Loc::x_at(<span class="keyword">const</span> difference_type&) <span class="keyword">const</span>;</div><div class="line"> y_iterator Loc::y_at(<span class="keyword">const</span> difference_type&) <span class="keyword">const</span>;</div><div class="line"> Loc Loc::xy_at(<span class="keyword">const</span> difference_type&) <span class="keyword">const</span>;</div><div class="line"></div><div class="line"> <span class="comment">// x/y versions of all methods that can take difference type</span></div><div class="line"> x_iterator Loc::x_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;</div><div class="line"> y_iterator Loc::y_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;</div><div class="line"> Loc Loc::xy_at(x_coord_t, y_coord_t) <span class="keyword">const</span>;</div><div class="line"> reference operator()(<span class="keyword">const</span> Loc&, x_coord_t, y_coord_t);</div><div class="line"> cached_location_t Loc::cache_location(x_coord_t, y_coord_t) <span class="keyword">const</span>;</div><div class="line"></div><div class="line"> <span class="keywordtype">bool</span> Loc::is_1d_traversable(x_coord_t width) <span class="keyword">const</span>;</div><div class="line"> y_coord_t Loc::y_distance_to(<span class="keyword">const</span> Loc& loc2, x_coord_t x_diff) <span class="keyword">const</span>;</div><div class="line">};</div></div><!-- fragment --> </div><hr/>The documentation for this struct was generated from the following file:<ul>
78 <li><a class="el" href="pixel__locator_8hpp_source.html">pixel_locator.hpp</a></li>
80 </div><!-- contents -->
81 <!-- HTML footer for doxygen 1.8.13-->
82 <!-- start footer part -->
84 <address class="footer">
86 Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15