libs/gil/doc/html/reference/position__iterator_8hpp_source.html

   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">
   4   <head>
   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.hpp Source File</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"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  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&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 <div id="nav-path" class="navpath">
  41   <ul>
  42 <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>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="headertitle">
  47 <div class="title">position_iterator.hpp</div>  </div>
  48 </div><!--header-->
  49 <div class="contents">
  50 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef BOOST_GIL_POSITION_ITERATOR_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define BOOST_GIL_POSITION_ITERATOR_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;boost/gil/locator.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;boost/iterator/iterator_facade.hpp&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim&gt;</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>&#160;<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&lt;position_iterator&lt;Deref,Dim&gt;,</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;                                                  typename Deref::value_type,</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;                                                  std::random_access_iterator_tag,</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;                                                  typename Deref::reference,</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;                                                  typename Deref::argument_type::template axis&lt;Dim&gt;::coord_t&gt; {</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keyword">using</span> parent_t = iterator_facade&lt;position_iterator&lt;Deref,Dim&gt;,</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;                            <span class="keyword">typename</span> Deref::value_type,</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;                            std::random_access_iterator_tag,</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;                            <span class="keyword">typename</span> Deref::reference,</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;                            <span class="keyword">typename</span> Deref::argument_type::template axis&lt;Dim&gt;::coord_t&gt;;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <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>&#160;    <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>&#160;    <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>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <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>&#160;    <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<span class="keyword">const</span> point_t&amp; p, <span class="keyword">const</span> point_t&amp; step, <span class="keyword">const</span> Deref&amp; d) : _p(p), _step(step), _d(d) {}</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<span class="keyword">const</span> <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>&amp; p) : _p(p._p), _step(p._step), _d(p._d) {}</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D&gt; <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>(<span class="keyword">const</span> <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator&lt;D,Dim&gt;</a>&amp; p) : _p(p._p), _step(p._step), _d(p._d) {}</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>&amp; p) { _p=p._p; _d=p._d; _step=p._step; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keyword">const</span> point_t&amp;   pos()<span class="keyword">      const </span>{ <span class="keywordflow">return</span> _p; }</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keyword">const</span> point_t&amp;   step()<span class="keyword">     const </span>{ <span class="keywordflow">return</span> _step; }</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keyword">const</span> Deref&amp;     deref_fn()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _d; }</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">void</span> set_step(difference_type s) { _step[Dim]=s; }</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1position__iterator.html#a16d8e6857dd561244ca73764f2b94801">   59</a></span>&#160;    reference <a class="code" href="structboost_1_1gil_1_1position__iterator.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a>(difference_type d)<span class="keyword"> const </span>{ point_t p=_p; p[Dim]+=d*_step[Dim]; <span class="keywordflow">return</span> _d(p); }</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="classboost_1_1gil_1_1point.html">point_t</a> _p, _step;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    Deref   _d;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <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" href="structboost_1_1gil_1_1position__iterator.html">position_iterator</a>;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>boost::iterator_core_access;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    reference dereference()<span class="keyword">     const </span>{ <span class="keywordflow">return</span> _d(_p); }</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keywordtype">void</span> increment()                  { _p[Dim]+=_step[Dim]; }</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordtype">void</span> decrement()                  { _p[Dim]-=_step[Dim]; }</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordtype">void</span> advance(difference_type d)   { _p[Dim]+=d*_step[Dim]; }</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    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 name="l00073"></a><span class="lineno">   73</span>&#160;    <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&amp; it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _p==it._p; }</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="keyword">struct </span>const_iterator_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; {</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keyword">using</span> type = position_iterator&lt;typename Deref::const_t,Dim&gt;;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;};</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref, <span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="keyword">struct </span>iterator_is_mutable&lt;position_iterator&lt;Deref, Dim&gt;&gt;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    : std::integral_constant&lt;bool, Deref::is_mutable&gt;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;{</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;};</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">//  PixelBasedConcept</span></div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<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 name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<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 name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="keyword">struct </span>is_planar&lt;position_iterator&lt;Deref, Dim&gt;&gt; : std::false_type {};</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<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 name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">//  HasDynamicXStepTypeConcept</span></div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Deref,<span class="keywordtype">int</span> Dim&gt;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="keyword">struct </span>dynamic_x_step_type&lt;position_iterator&lt;Deref,Dim&gt; &gt; {</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    <span class="keyword">using</span> type = position_iterator&lt;Deref,Dim&gt;;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;};</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;} }  <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structboost_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:31</div></div>
  51 <div class="ttc" id="structboost_1_1gil_1_1position__iterator_html_a16d8e6857dd561244ca73764f2b94801"><div class="ttname"><a href="structboost_1_1gil_1_1position__iterator.html#a16d8e6857dd561244ca73764f2b94801">boost::gil::position_iterator::operator[]</a></div><div class="ttdeci">reference operator[](difference_type d) const</div><div class="ttdef"><b>Definition:</b> position_iterator.hpp:59</div></div>
  52 <div class="ttc" id="group___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&lt; Loc1 &gt; first, boost::gil::iterator_from_2d&lt; Loc1 &gt; last, boost::gil::iterator_from_2d&lt; Loc2 &gt; 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:1029</div></div>
  53 <div class="ttc" id="classboost_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>
  54 </div><!-- fragment --></div><!-- contents -->
  55      <!-- HTML footer for doxygen 1.8.13-->
  56      <!-- start footer part -->
  57      <hr class="footer"/>
  58      <address class="footer">
  59       <small>
  60         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  61       </small>
  62     </address>
  63   </body>
  64 </html>