mirror of
https://github.com/boostorg/gil.git
synced 2026-01-24 05:52:13 +00:00
178 lines
22 KiB
HTML
178 lines
22 KiB
HTML
<!-- 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.1"/>
|
|
<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.1 -->
|
|
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a 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 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 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 name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef BOOST_GIL_POSITION_ITERATOR_HPP</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define BOOST_GIL_POSITION_ITERATOR_HPP</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <boost/gil/locator.hpp></span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <boost/iterator/iterator_facade.hpp></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespaceboost.html">boost</a> { <span class="keyword">namespace </span>gil {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a 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" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> : <span class="keyword">public</span> iterator_facade<position_iterator<Deref,Dim>,</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  typename Deref::value_type,</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  std::random_access_iterator_tag,</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  typename Deref::reference,</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  typename Deref::argument_type::template axis<Dim>::coord_t> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">using</span> parent_t = iterator_facade<position_iterator<Deref,Dim>,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">typename</span> Deref::value_type,</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  std::random_access_iterator_tag,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">typename</span> Deref::reference,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">typename</span> Deref::argument_type::template axis<Dim>::coord_t>;</div>
|
|
<div class="line"><a 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 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 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 name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>() {}</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(point_t <span class="keyword">const</span>& p, point_t <span class="keyword">const</span>& step, Deref <span class="keyword">const</span>& d) : _p(p), _step(step), _d(d) {}</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> <span class="keyword">const</span>& p) : _p(p._p), _step(p._step), _d(p._d) {}</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> D></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator<D,Dim></a> <span class="keyword">const</span>& p) : _p(p._p), _step(p._step), _d(p._d) {}</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">auto</span> operator=(<a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a> <span class="keyword">const</span>& p) -> <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>&</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  _p=p._p;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  _d=p._d;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  _step=p._step;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">auto</span> pos() <span class="keyword">const</span> -> point_t <span class="keyword">const</span>& { <span class="keywordflow">return</span> _p; }</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">auto</span> step() <span class="keyword">const</span> -> point_t <span class="keyword">const</span>& { <span class="keywordflow">return</span> _step; }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">auto</span> deref_fn() <span class="keyword">const</span> -> Deref <span class="keyword">const</span>& { <span class="keywordflow">return</span> _d; }</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> set_step(difference_type s) { _step[Dim]=s; }</div>
|
|
<div class="line"><a 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" href="structboost_1_1gil_1_1position__iterator.html#a3832fa78e567d765df5630ec4555a659">operator[]</a>(difference_type d) <span class="keyword">const</span> -> reference</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  point_t p=_p;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  p[Dim]+=d*_step[Dim];</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> _d(p);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classboost_1_1gil_1_1point.html">point_t</a> _p, _step;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  Deref _d;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> DE, <span class="keywordtype">int</span> DI> <span class="keyword">friend</span> <span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>;</div>
|
|
<div class="line"><a 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 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 name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> increment() { _p[Dim]+=_step[Dim]; }</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> decrement() { _p[Dim]-=_step[Dim]; }</div>
|
|
<div class="line"><a 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 name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  difference_type distance_to(<span class="keyword">const</span> position_iterator& it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (it._p[Dim]-_p[Dim])/_step[Dim]; }</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> <a class="code" href="group___s_t_l_optimizations.html#ga2902a23650ef266e80874ce5df076079">equal</a>(<span class="keyword">const</span> position_iterator& it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p==it._p; }</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">struct </span>const_iterator_type<position_iterator<Deref,Dim> > {</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">using</span> type = position_iterator<typename Deref::const_t,Dim>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">struct </span>iterator_is_mutable<position_iterator<Deref, Dim>></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  : std::integral_constant<bool, Deref::is_mutable></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> {</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> };</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// PixelBasedConcept</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">struct </span>color_space_type<position_iterator<Deref,Dim> > : <span class="keyword">public</span> color_space_type<typename Deref::value_type> {};</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">struct </span>channel_mapping_type<position_iterator<Deref,Dim> > : <span class="keyword">public</span> channel_mapping_type<typename Deref::value_type> {};</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">struct </span>is_planar<position_iterator<Deref, Dim>> : std::false_type {};</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">struct </span>channel_type<position_iterator<Deref,Dim> > : <span class="keyword">public</span> channel_type<typename Deref::value_type> {};</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// HasDynamicXStepTypeConcept</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">struct </span>dynamic_x_step_type<position_iterator<Deref,Dim> > {</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">using</span> type = position_iterator<Deref,Dim>;</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> } } <span class="comment">// namespace boost::gil</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  </div>
|
|
<div class="line"><a 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< std::ptrdiff_t ></a></div></div>
|
|
<div class="ttc" id="agroup___s_t_l_optimizations_html_ga2902a23650ef266e80874ce5df076079"><div class="ttname"><a href="group___s_t_l_optimizations.html#ga2902a23650ef266e80874ce5df076079">std::equal</a></div><div class="ttdeci">BOOST_FORCEINLINE bool equal(boost::gil::iterator_from_2d< Loc1 > first, boost::gil::iterator_from_2d< Loc1 > last, boost::gil::iterator_from_2d< Loc2 > first2)</div><div class="ttdoc">std::equal(I1,I1,I2) with I1 and I2 being a iterator_from_2d</div><div class="ttdef"><b>Definition:</b> algorithm.hpp:1087</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 -> 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  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.9.1
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|