boost/gil
2
0
Fork 0
mirror of https://github.com/boostorg/gil.git synced 2026-01-23 17:42:30 +00:00
Code Issues Projects Releases Wiki Activity
Files
62e86ae3468c548bbafdb04a8d975c38ca3e31d0
gil/develop/doc/html/reference/position__iterator_8hpp_source.html
github-actions[bot] 3b73200ee1 deploy: 49d9276706
2025-04-04 16:28:54 +00:00

186 lines
23 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Generic Image Library: position_iterator.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div class="boost-header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
<tr>
<td valign="top" width="300">
<h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
</td>
<td ><h1 align="center"><a href="../index.html"></a></h1></td>
<td></td>
</tr>
</table>
</div>
<hr/>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">position_iterator.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">//</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">//</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#ifndef BOOST_GIL_POSITION_ITERATOR_HPP</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#define BOOST_GIL_POSITION_ITERATOR_HPP</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;boost/gil/locator.hpp&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;boost/iterator/iterator_facade.hpp&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceboost.html">boost</a> { <span class="keyword">namespace </span>gil {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim&gt;</div>
<div class="foldopen" id="foldopen00031" data-start="{" data-end="};">
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1position__iterator.html"> 31</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> : <span class="keyword">public</span> iterator_facade&lt;position_iterator&lt;Deref,Dim&gt;,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> typename Deref::value_type,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> std::random_access_iterator_tag,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> typename Deref::reference,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> typename Deref::argument_type::template axis&lt;Dim&gt;::coord_t&gt; {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">using </span>parent_t = iterator_facade&lt;position_iterator&lt;Deref,Dim&gt;,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">typename</span> Deref::value_type,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> std::random_access_iterator_tag,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">typename</span> Deref::reference,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">typename</span> Deref::argument_type::template axis&lt;Dim&gt;::coord_t&gt;;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">using </span>difference_type = <span class="keyword">typename</span> parent_t::difference_type;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">using </span>reference = <span class="keyword">typename</span> parent_t::reference;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">using </span>point_t = <span class="keyword">typename</span> Deref::argument_type;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>() {}</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(point_t <span class="keyword">const</span>&amp; p, point_t <span class="keyword">const</span>&amp; step, Deref <span class="keyword">const</span>&amp; d) : _p(p), _step(step), _d(d) {}</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> <span class="keyword">const</span>&amp; p) : _p(p._p), _step(p._step), _d(p._d) {}</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D&gt;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator&lt;D,Dim&gt;</a> <span class="keyword">const</span>&amp; p) : _p(p._p), _step(p._step), _d(p._d) {}</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">auto</span> operator=(<a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> <span class="keyword">const</span>&amp; p) -&gt; <a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>&amp;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> _p=p._p;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> _d=p._d;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> _step=p._step;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> }</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">auto</span> pos() <span class="keyword">const</span> -&gt; point_t <span class="keyword">const</span>&amp; { <span class="keywordflow">return</span> _p; }</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">auto</span> step() <span class="keyword">const</span> -&gt; point_t <span class="keyword">const</span>&amp; { <span class="keywordflow">return</span> _step; }</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">auto</span> deref_fn() <span class="keyword">const</span> -&gt; Deref <span class="keyword">const</span>&amp; { <span class="keywordflow">return</span> _d; }</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> set_step(difference_type s) { _step[Dim]=s; }</div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1position__iterator.html#a3832fa78e567d765df5630ec4555a659"> 68</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="structboost_1_1gil_1_1position__iterator.html#a3832fa78e567d765df5630ec4555a659">operator[]</a>(difference_type d) <span class="keyword">const</span> -&gt; reference</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> {</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> point_t p=_p;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> p[Dim]+=d*_step[Dim];</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">return</span> _d(p);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_class" href="classboost_1_1gil_1_1point.html">point_t</a> _p, _step;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> Deref _d;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> DE, <span class="keywordtype">int</span> DI&gt; <span class="keyword">friend</span> <span class="keyword">struct </span><a class="code hl_struct" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">friend</span> <span class="keyword">class </span>boost::iterator_core_access;</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> reference dereference()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _d(_p); }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> increment() { _p[Dim]+=_step[Dim]; }</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">void</span> decrement() { _p[Dim]-=_step[Dim]; }</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">void</span> advance(difference_type d) { _p[Dim]+=d*_step[Dim]; }</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> difference_type distance_to(<span class="keyword">const</span> position_iterator&amp; it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (it._p[Dim]-_p[Dim])/_step[Dim]; }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">bool</span> equal(<span class="keyword">const</span> position_iterator&amp; it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p==it._p; }</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>};</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keyword">struct </span>const_iterator_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; {</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">using </span>type = position_iterator&lt;typename Deref::const_t,Dim&gt;;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>};</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword">struct </span>iterator_is_mutable&lt;position_iterator&lt;Deref, Dim&gt;&gt;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> : std::integral_constant&lt;bool, Deref::is_mutable&gt;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>{</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>};</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">// PixelBasedConcept</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="keyword">struct </span>color_space_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; : <span class="keyword">public</span> color_space_type&lt;typename Deref::value_type&gt; {};</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="keyword">struct </span>channel_mapping_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; : <span class="keyword">public</span> channel_mapping_type&lt;typename Deref::value_type&gt; {};</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="keyword">struct </span>is_planar&lt;position_iterator&lt;Deref, Dim&gt;&gt; : std::false_type {};</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="keyword">struct </span>channel_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; : <span class="keyword">public</span> channel_type&lt;typename Deref::value_type&gt; {};</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment">// HasDynamicXStepTypeConcept</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="keyword">struct </span>dynamic_x_step_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; {</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">using </span>type = position_iterator&lt;Deref,Dim&gt;;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span>};</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>} } <span class="comment">// namespace boost::gil</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassboost_1_1gil_1_1point_html"><div class="ttname"><a href="classboost_1_1gil_1_1point.html">boost::gil::point&lt; std::ptrdiff_t &gt;</a></div></div>
<div class="ttc" id="anamespaceboost_html"><div class="ttname"><a href="namespaceboost.html">boost</a></div><div class="ttdoc">defined(BOOST_NO_CXX17_HDR_MEMORY_RESOURCE)</div><div class="ttdef"><b>Definition</b> algorithm.hpp:36</div></div>
<div class="ttc" id="astructboost_1_1gil_1_1position__iterator_html"><div class="ttname"><a href="structboost_1_1gil_1_1position__iterator.html">boost::gil::position_iterator</a></div><div class="ttdoc">An iterator that remembers its current X,Y position and invokes a function object with it upon derefe...</div><div class="ttdef"><b>Definition</b> position_iterator.hpp:35</div></div>
<div class="ttc" id="astructboost_1_1gil_1_1position__iterator_html_a3832fa78e567d765df5630ec4555a659"><div class="ttname"><a href="structboost_1_1gil_1_1position__iterator.html#a3832fa78e567d765df5630ec4555a659">boost::gil::position_iterator::operator[]</a></div><div class="ttdeci">auto operator[](difference_type d) const -&gt; reference</div><div class="ttdef"><b>Definition</b> position_iterator.hpp:68</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.9.8
</small>
</address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink