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: position_iterator< Deref, Dim > 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_1position__iterator.html">position_iterator</a></li> </ul>
47 <a href="#pub-types">Public Types</a> |
48 <a href="#pub-methods">Public Member Functions</a> |
49 <a href="#friends">Friends</a> |
50 <a href="structboost_1_1gil_1_1position__iterator-members.html">List of all members</a> </div>
51 <div class="headertitle">
52 <div class="title">position_iterator< Deref, Dim > Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> » <a class="el" href="group___pixel_iterator_model.html">Models</a> » <a class="el" href="group___pixel_iterator_model_virtual.html">position_iterator</a><a class="el" href="group___pixel_based.html">PixelBased</a> » | <a class="el" href="group___pixel_based_model.html">Models</a></div></div> </div>
54 <div class="contents">
56 <p>An iterator that remembers its current X,Y position and invokes a function object with it upon dereferencing. Used to create virtual image views. Models: <a class="el" href="structboost_1_1gil_1_1_step_iterator_concept.html" title="Step iterator concept.">StepIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>.
57 <a href="structboost_1_1gil_1_1position__iterator.html#details">More...</a></p>
59 <p><code>#include <<a class="el" href="position__iterator_8hpp_source.html">position_iterator.hpp</a>></code></p>
61 <p>Inherits iterator_facade< position_iterator< Deref, Dim >, Deref::value_type, std::random_access_iterator_tag, Deref::reference, Deref::argument_type::template axis< Dim >::coord_t >.</p>
62 <table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
64 Public Types</h2></td></tr>
65 <tr class="memitem:ad6cdb8c56a1d318e76805577a3905128"><td class="memItemLeft" align="right" valign="top"><a id="ad6cdb8c56a1d318e76805577a3905128"></a>
66 using </td><td class="memItemRight" valign="bottom"><b>parent_t</b> = iterator_facade< <a class="el" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>< Deref, Dim >, typename Deref::value_type, std::random_access_iterator_tag, typename Deref::reference, typename Deref::argument_type::template axis< Dim >::coord_t ></td></tr>
67 <tr class="separator:ad6cdb8c56a1d318e76805577a3905128"><td class="memSeparator" colspan="2"> </td></tr>
68 <tr class="memitem:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memItemLeft" align="right" valign="top"><a id="a2ae9f9bc144b7bd7d8523c345ac34a58"></a>
69 using </td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename parent_t::difference_type</td></tr>
70 <tr class="separator:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memSeparator" colspan="2"> </td></tr>
71 <tr class="memitem:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memItemLeft" align="right" valign="top"><a id="afd3670b743c9f80b9c2f6b3ccb5fe37c"></a>
72 using </td><td class="memItemRight" valign="bottom"><b>reference</b> = typename parent_t::reference</td></tr>
73 <tr class="separator:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memSeparator" colspan="2"> </td></tr>
74 <tr class="memitem:abd8a64054274a18e1eda3fcb3328a8a9"><td class="memItemLeft" align="right" valign="top"><a id="abd8a64054274a18e1eda3fcb3328a8a9"></a>
75 using </td><td class="memItemRight" valign="bottom"><b>point_t</b> = typename Deref::argument_type</td></tr>
76 <tr class="separator:abd8a64054274a18e1eda3fcb3328a8a9"><td class="memSeparator" colspan="2"> </td></tr>
77 </table><table class="memberdecls">
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
79 Public Member Functions</h2></td></tr>
80 <tr class="memitem:ac764aa1824b23c5d449b13402f69e2bc"><td class="memItemLeft" align="right" valign="top"><a id="ac764aa1824b23c5d449b13402f69e2bc"></a>
81  </td><td class="memItemRight" valign="bottom"><b>position_iterator</b> (const point_t &p, const point_t &step, const Deref &d)</td></tr>
82 <tr class="separator:ac764aa1824b23c5d449b13402f69e2bc"><td class="memSeparator" colspan="2"> </td></tr>
83 <tr class="memitem:a095093a553f6880d130811af0d09cd7f"><td class="memItemLeft" align="right" valign="top"><a id="a095093a553f6880d130811af0d09cd7f"></a>
84  </td><td class="memItemRight" valign="bottom"><b>position_iterator</b> (const <a class="el" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> &p)</td></tr>
85 <tr class="separator:a095093a553f6880d130811af0d09cd7f"><td class="memSeparator" colspan="2"> </td></tr>
86 <tr class="memitem:a3663b908e1443a0f2c28e48276b3948f"><td class="memTemplParams" colspan="2"><a id="a3663b908e1443a0f2c28e48276b3948f"></a>
87 template<typename D > </td></tr>
88 <tr class="memitem:a3663b908e1443a0f2c28e48276b3948f"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><b>position_iterator</b> (const <a class="el" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>< D, Dim > &p)</td></tr>
89 <tr class="separator:a3663b908e1443a0f2c28e48276b3948f"><td class="memSeparator" colspan="2"> </td></tr>
90 <tr class="memitem:a03e1a07a1c81d6a2526187a21bfb02d4"><td class="memItemLeft" align="right" valign="top"><a id="a03e1a07a1c81d6a2526187a21bfb02d4"></a>
91 <a class="el" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> &p)</td></tr>
92 <tr class="separator:a03e1a07a1c81d6a2526187a21bfb02d4"><td class="memSeparator" colspan="2"> </td></tr>
93 <tr class="memitem:a4173d29744da6d3fa5b64049d1e8e784"><td class="memItemLeft" align="right" valign="top"><a id="a4173d29744da6d3fa5b64049d1e8e784"></a>
94 const point_t & </td><td class="memItemRight" valign="bottom"><b>pos</b> () const</td></tr>
95 <tr class="separator:a4173d29744da6d3fa5b64049d1e8e784"><td class="memSeparator" colspan="2"> </td></tr>
96 <tr class="memitem:acd37deea33a66d5cebdccb3c0dea5af9"><td class="memItemLeft" align="right" valign="top"><a id="acd37deea33a66d5cebdccb3c0dea5af9"></a>
97 const point_t & </td><td class="memItemRight" valign="bottom"><b>step</b> () const</td></tr>
98 <tr class="separator:acd37deea33a66d5cebdccb3c0dea5af9"><td class="memSeparator" colspan="2"> </td></tr>
99 <tr class="memitem:a759185e02592dd41589a67f99dfc263c"><td class="memItemLeft" align="right" valign="top"><a id="a759185e02592dd41589a67f99dfc263c"></a>
100 const Deref & </td><td class="memItemRight" valign="bottom"><b>deref_fn</b> () const</td></tr>
101 <tr class="separator:a759185e02592dd41589a67f99dfc263c"><td class="memSeparator" colspan="2"> </td></tr>
102 <tr class="memitem:a5114b6c7c715e484fcb9e79b71838215"><td class="memItemLeft" align="right" valign="top"><a id="a5114b6c7c715e484fcb9e79b71838215"></a>
103 void </td><td class="memItemRight" valign="bottom"><b>set_step</b> (difference_type s)</td></tr>
104 <tr class="separator:a5114b6c7c715e484fcb9e79b71838215"><td class="memSeparator" colspan="2"> </td></tr>
105 <tr class="memitem:a16d8e6857dd561244ca73764f2b94801"><td class="memItemLeft" align="right" valign="top">reference </td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1position__iterator.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
106 <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2"> </td></tr>
107 </table><table class="memberdecls">
108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
109 Friends</h2></td></tr>
110 <tr class="memitem:a4c7e6e64e2ac787c24c2bc336b135dce"><td class="memTemplParams" colspan="2"><a id="a4c7e6e64e2ac787c24c2bc336b135dce"></a>
111 template<typename DE , int DI> </td></tr>
112 <tr class="memitem:a4c7e6e64e2ac787c24c2bc336b135dce"><td class="memTemplItemLeft" align="right" valign="top">struct </td><td class="memTemplItemRight" valign="bottom"><b>position_iterator</b></td></tr>
113 <tr class="separator:a4c7e6e64e2ac787c24c2bc336b135dce"><td class="memSeparator" colspan="2"> </td></tr>
114 <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
115 class </td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
116 <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2"> </td></tr>
118 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
119 <div class="textblock"><h3>template<typename Deref, int Dim><br />
120 struct boost::gil::position_iterator< Deref, Dim ></h3>
122 <p>An iterator that remembers its current X,Y position and invokes a function object with it upon dereferencing. Used to create virtual image views. Models: <a class="el" href="structboost_1_1gil_1_1_step_iterator_concept.html" title="Step iterator concept.">StepIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>. </p>
123 <dl class="tparams"><dt>Template Parameters</dt><dd>
124 <table class="tparams">
125 <tr><td class="paramname">Deref</td><td>A function object that given a point returns a pixel reference. Models <a class="el" href="structboost_1_1gil_1_1_pixel_dereference_adaptor_concept.html" title="Represents a unary function object that can be invoked upon dereferencing a pixel iterator.">PixelDereferenceAdaptorConcept</a> </td></tr>
126 <tr><td class="paramname">Dim</td><td>Dimension to advance along </td></tr>
130 </div><h2 class="groupheader">Member Function Documentation</h2>
131 <a id="a16d8e6857dd561244ca73764f2b94801"></a>
132 <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">◆ </a></span>operator[]()</h2>
134 <div class="memitem">
135 <div class="memproto">
136 <table class="mlabels">
138 <td class="mlabels-left">
139 <table class="memname">
141 <td class="memname">reference operator[] </td>
143 <td class="paramtype">difference_type </td>
144 <td class="paramname"><em>d</em></td><td>)</td>
149 <td class="mlabels-right">
150 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
153 </div><div class="memdoc">
154 <p>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 </p>
158 <hr/>The documentation for this struct was generated from the following file:<ul>
159 <li><a class="el" href="position__iterator_8hpp_source.html">position_iterator.hpp</a></li>
161 </div><!-- contents -->
162 <!-- HTML footer for doxygen 1.8.13-->
163 <!-- start footer part -->
165 <address class="footer">
167 Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15