blob: 82258c7f1b36c5b9c732bfb6fb509b76d1938b23 [file] [log] [blame]
<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
-->
<!--
Copyright 2005-2007 Adobe Systems Incorporated
Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
or a copy at http://stlab.adobe.com/licenses.html)
Some files are held under additional license.
Please see "http://stlab.adobe.com/licenses.html" for more information.
-->
<!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" lang="en" xml:lang="en">
<head>
<TITLE>Generic Image Library: step_iterator.hpp Source File</TITLE>
<META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
<LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
<td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
<div class="qindex"><a class="qindex" href="index.html">Modules</a>
| <a class="qindex" href="classes.html">Alphabetical List</a>
| <a class="qindex" href="annotated.html">Class List</a>
| <a class="qindex" href="dirs.html">Directories</a>
| <a class="qindex" href="files.html">File List</a>
| <a class="qindex" href="../index.html">GIL Home Page</a>
</div>
<!-- End Header -->
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="g_i_l_0076.html">boost</a>&nbsp;&raquo&nbsp;<a class="el" href="g_i_l_0079.html">gil</a>
</div>
<div class="contents">
<h1>step_iterator.hpp</h1><a href="g_i_l_0260.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright 2005-2007 Adobe Systems Incorporated</span>
<a name="l00003"></a>00003 <span class="comment"> </span>
<a name="l00004"></a>00004 <span class="comment"> Use, modification and distribution are subject to the Boost Software License,</span>
<a name="l00005"></a>00005 <span class="comment"> Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00006"></a>00006 <span class="comment"> http://www.boost.org/LICENSE_1_0.txt).</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> See http://opensource.adobe.com/gil for most recent version including documentation.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*************************************************************************************************/</span>
<a name="l00012"></a>00012
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef GIL_STEP_ITERATOR_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define GIL_STEP_ITERATOR_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;cstddef&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;iterator&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;boost/iterator/iterator_facade.hpp&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="g_i_l_0094.html" title="GIL configuration file.">gil_config.hpp</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="utilities_8hpp.html" title="Various utilities not specific to the image library. Some are non-standard STL extensions...">utilities.hpp</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="g_i_l_0243.html" title="pixel iterator support">pixel_iterator.hpp</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="g_i_l_0245.html" title="pixel step iterator, pixel image iterator and pixel dereference iterator">pixel_iterator_adaptor.hpp</a>"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {
<a name="l00034"></a>00034
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">namespace </span>detail {
<a name="l00041"></a>00041
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Derived, <span class="comment">// type of the derived class</span>
<a name="l00050"></a>00050 <span class="keyword">typename</span> Iterator, <span class="comment">// Models Iterator</span>
<a name="l00051"></a>00051 <span class="keyword">typename</span> SFn&gt; <span class="comment">// A policy object that can compute the distance between two iterators of type Iterator</span>
<a name="l00052"></a>00052 <span class="comment">// and can advance an iterator of type Iterator a given number of Iterator's units </span>
<a name="l00053"></a><a class="code" href="g_i_l_0036.html">00053</a> <span class="keyword">class </span><a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor</a> : <span class="keyword">public</span> iterator_adaptor&lt;Derived, Iterator, use_default, use_default, use_default, typename SFn::difference_type&gt; {
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a>00055 <span class="keyword">typedef</span> iterator_adaptor&lt;Derived, Iterator, use_default, use_default, use_default, typename SFn::difference_type&gt; parent_t;
<a name="l00056"></a>00056 <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits&lt;Iterator&gt;::difference_type base_difference_type;
<a name="l00057"></a>00057 <span class="keyword">typedef</span> <span class="keyword">typename</span> SFn::difference_type difference_type;
<a name="l00058"></a>00058 <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits&lt;Iterator&gt;::reference reference;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor</a>() {}
<a name="l00061"></a>00061 <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor</a>(<span class="keyword">const</span> Iterator&amp; it, SFn step_fn=SFn()) : parent_t(it), _step_fn(step_fn) {}
<a name="l00062"></a>00062
<a name="l00063"></a>00063 difference_type step()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _step_fn.step(); }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">protected</span>:
<a name="l00066"></a>00066 SFn _step_fn;
<a name="l00067"></a>00067 <span class="keyword">private</span>:
<a name="l00068"></a>00068 <span class="keyword">friend</span> <span class="keyword">class </span>boost::iterator_core_access;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> increment() { _step_fn.advance(this-&gt;base_reference(),1); }
<a name="l00071"></a>00071 <span class="keywordtype">void</span> decrement() { _step_fn.advance(this-&gt;base_reference(),-1); }
<a name="l00072"></a>00072 <span class="keywordtype">void</span> advance(base_difference_type d) { _step_fn.advance(this-&gt;base_reference(),d); }
<a name="l00073"></a>00073 difference_type distance_to(<span class="keyword">const</span> <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor</a>&amp; it)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _step_fn.difference(this-&gt;base_reference(),it.base_reference()); }
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// although iterator_adaptor defines these, the default implementation computes distance and compares for zero.</span>
<a name="l00077"></a>00077 <span class="comment">// it is often faster to just apply the relation operator to the base</span>
<a name="l00078"></a>00078 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> operator&gt;(<span class="keyword">const</span> <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor&lt;D,Iterator,SFn&gt;</a>&amp; p1, <span class="keyword">const</span> <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">step_iterator_adaptor&lt;D,Iterator,SFn&gt;</a>&amp; p2) {
<a name="l00080"></a>00080 <span class="keywordflow">return</span> p1.<a class="code" href="g_i_l_0036.html#4d9de021528d2fae8de7b71dbc2e3909">step</a>()&gt;0 ? p1.base()&gt; p2.base() : p1.base()&lt; p2.base();
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> operator&lt;(const step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p1, <span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p2) {
<a name="l00085"></a>00085 <span class="keywordflow">return</span> p1.<a class="code" href="g_i_l_0036.html#4d9de021528d2fae8de7b71dbc2e3909">step</a>()&gt;0 ? p1.base()&lt; p2.base() : p1.base()&gt; p2.base();
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00089"></a>00089 <span class="keywordtype">bool</span> operator&gt;=(<span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p1, <span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p2) {
<a name="l00090"></a>00090 <span class="keywordflow">return</span> p1.step()&gt;0 ? p1.base()&gt;=p2.base() : p1.base()&lt;=p2.base();
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> operator&lt;=(const step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p1, <span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p2) {
<a name="l00095"></a>00095 <span class="keywordflow">return</span> p1.step()&gt;0 ? p1.base()&lt;=p2.base() : p1.base()&gt;=p2.base();
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p1, <span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p2) {
<a name="l00100"></a>00100 <span class="keywordflow">return</span> p1.base()==p2.base();
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> D,<span class="keyword">typename</span> Iterator,<span class="keyword">typename</span> SFn&gt; <span class="keyword">inline</span>
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p1, <span class="keyword">const</span> step_iterator_adaptor&lt;D,Iterator,SFn&gt;&amp; p2) {
<a name="l00105"></a>00105 <span class="keywordflow">return</span> p1.base()!=p2.base();
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107
<a name="l00108"></a>00108 } <span class="comment">// namespace detail</span>
<a name="l00109"></a>00109
<a name="l00113"></a>00113
<a name="l00129"></a>00129
<a name="l00132"></a>00132 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00133"></a><a class="code" href="g_i_l_0576.html">00133</a> <span class="keyword">struct </span><a class="code" href="g_i_l_0576.html" title="function object that returns the memory unit distance between two iterators and advances...">memunit_step_fn</a> {
<a name="l00134"></a>00134 <span class="keyword">typedef</span> std::ptrdiff_t difference_type;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <a class="code" href="g_i_l_0576.html" title="function object that returns the memory unit distance between two iterators and advances...">memunit_step_fn</a>(difference_type step=memunit_step(Iterator())) : _step(step) {}
<a name="l00137"></a>00137
<a name="l00138"></a>00138 difference_type difference(<span class="keyword">const</span> Iterator&amp; it1, <span class="keyword">const</span> Iterator&amp; it2)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> memunit_distance(it1,it2)/_step; }
<a name="l00139"></a>00139 <span class="keywordtype">void</span> advance(Iterator&amp; it, difference_type d)<span class="keyword"> const </span>{ memunit_advance(it,d*_step); }
<a name="l00140"></a>00140 difference_type step()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _step; }
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keywordtype">void</span> set_step(std::ptrdiff_t step) { _step=step; }
<a name="l00143"></a>00143 <span class="keyword">private</span>:
<a name="l00144"></a>00144 GIL_CLASS_REQUIRE(Iterator, boost::gil, <a class="code" href="g_i_l_0312.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or...">MemoryBasedIteratorConcept</a>)
<a name="l00145"></a>00145 difference_type _step;
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00149"></a><a class="code" href="g_i_l_0046.html">00149</a> <span class="keyword">class </span><a class="code" href="g_i_l_0046.html" title="Iterator with dynamically specified step in memory units (bytes or bits). Models...">memory_based_step_iterator</a> : <span class="keyword">public</span> detail::step_iterator_adaptor&lt;memory_based_step_iterator&lt;Iterator&gt;,
<a name="l00150"></a>00150 Iterator,
<a name="l00151"></a>00151 memunit_step_fn&lt;Iterator&gt; &gt; {
<a name="l00152"></a>00152 GIL_CLASS_REQUIRE(Iterator, boost::gil, <a class="code" href="g_i_l_0312.html" title="Concept of a random-access iterator that can be advanced in memory units (bytes or...">MemoryBasedIteratorConcept</a>)
<a name="l00153"></a>00153 <span class="keyword">public</span>:
<a name="l00154"></a>00154 <span class="keyword">typedef</span> <a class="code" href="g_i_l_0036.html" title="An adaptor over an existing iterator that changes the step unit.">detail::step_iterator_adaptor&lt;memory_based_step_iterator&lt;Iterator&gt;</a>,
<a name="l00155"></a>00155 Iterator,
<a name="l00156"></a>00156 <a class="code" href="g_i_l_0576.html" title="function object that returns the memory unit distance between two iterators and advances...">memunit_step_fn&lt;Iterator&gt;</a> &gt; parent_t;
<a name="l00157"></a>00157 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::reference reference;
<a name="l00158"></a>00158 <span class="keyword">typedef</span> <span class="keyword">typename</span> parent_t::difference_type difference_type;
<a name="l00159"></a>00159 <span class="keyword">typedef</span> Iterator x_iterator;
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <a class="code" href="g_i_l_0046.html" title="Iterator with dynamically specified step in memory units (bytes or bits). Models...">memory_based_step_iterator</a>() : parent_t(Iterator()) {}
<a name="l00162"></a>00162 <a class="code" href="g_i_l_0046.html" title="Iterator with dynamically specified step in memory units (bytes or bits). Models...">memory_based_step_iterator</a>(Iterator it, std::ptrdiff_t memunit_step) : parent_t(it, <a class="code" href="g_i_l_0576.html" title="function object that returns the memory unit distance between two iterators and advances...">memunit_step_fn&lt;Iterator&gt;</a>(memunit_step)) {}
<a name="l00163"></a>00163 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I2&gt;
<a name="l00164"></a>00164 <a class="code" href="g_i_l_0046.html" title="Iterator with dynamically specified step in memory units (bytes or bits). Models...">memory_based_step_iterator</a>(<span class="keyword">const</span> <a class="code" href="g_i_l_0046.html" title="Iterator with dynamically specified step in memory units (bytes or bits). Models...">memory_based_step_iterator&lt;I2&gt;</a>&amp; it)
<a name="l00165"></a>00165 : parent_t(it.<a class="code" href="g_i_l_0046.html#2d6722b54419923ecb1282a142fcd494">base</a>(), <a class="code" href="g_i_l_0576.html" title="function object that returns the memory unit distance between two iterators and advances...">memunit_step_fn&lt;Iterator&gt;</a>(it.<a class="code" href="g_i_l_0036.html#4d9de021528d2fae8de7b71dbc2e3909">step</a>())) {}
<a name="l00166"></a>00166
<a name="l00169"></a><a class="code" href="g_i_l_0046.html#de1279c4ed222b6efb0867c038765ea1">00169</a> reference <a class="code" href="g_i_l_0046.html#de1279c4ed222b6efb0867c038765ea1">operator[]</a>(difference_type d)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *(*<span class="keyword">this</span>+d); }
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keywordtype">void</span> set_step(std::ptrdiff_t memunit_step) { this-&gt;_step_fn.set_step(memunit_step); }
<a name="l00172"></a>00172
<a name="l00173"></a>00173 x_iterator&amp; base() { <span class="keywordflow">return</span> parent_t::base_reference(); }
<a name="l00174"></a>00174 x_iterator <span class="keyword">const</span>&amp; base()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> parent_t::base_reference(); }
<a name="l00175"></a>00175 };
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00178"></a>00178 <span class="keyword">struct </span>const_iterator_type&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; {
<a name="l00179"></a>00179 <span class="keyword">typedef</span> memory_based_step_iterator&lt;typename const_iterator_type&lt;Iterator&gt;::type&gt; type;
<a name="l00180"></a>00180 };
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00183"></a>00183 <span class="keyword">struct </span>iterator_is_mutable&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> iterator_is_mutable&lt;Iterator&gt; {};
<a name="l00184"></a>00184
<a name="l00185"></a>00185
<a name="l00187"></a>00187 <span class="comment">// IteratorAdaptorConcept</span>
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00191"></a>00191 <span class="keyword">struct </span>is_iterator_adaptor&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> mpl::true_{};
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00194"></a>00194 <span class="keyword">struct </span>iterator_adaptor_get_base&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; {
<a name="l00195"></a>00195 <span class="keyword">typedef</span> Iterator type;
<a name="l00196"></a>00196 };
<a name="l00197"></a>00197
<a name="l00198"></a>00198 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator, <span class="keyword">typename</span> NewBaseIterator&gt;
<a name="l00199"></a>00199 <span class="keyword">struct </span>iterator_adaptor_rebind&lt;memory_based_step_iterator&lt;Iterator&gt;,NewBaseIterator&gt; {
<a name="l00200"></a>00200 <span class="keyword">typedef</span> memory_based_step_iterator&lt;NewBaseIterator&gt; type;
<a name="l00201"></a>00201 };
<a name="l00202"></a>00202
<a name="l00204"></a>00204 <span class="comment">// PixelBasedConcept</span>
<a name="l00206"></a>00206 <span class="comment"></span>
<a name="l00207"></a>00207 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00208"></a>00208 <span class="keyword">struct </span>color_space_type&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> color_space_type&lt;Iterator&gt; {};
<a name="l00209"></a>00209
<a name="l00210"></a>00210 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00211"></a>00211 <span class="keyword">struct </span>channel_mapping_type&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> channel_mapping_type&lt;Iterator&gt; {};
<a name="l00212"></a>00212
<a name="l00213"></a>00213 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00214"></a>00214 <span class="keyword">struct </span>is_planar&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> is_planar&lt;Iterator&gt; {};
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00217"></a>00217 <span class="keyword">struct </span>channel_type&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> channel_type&lt;Iterator&gt; {};
<a name="l00218"></a>00218
<a name="l00220"></a>00220 <span class="comment">// MemoryBasedIteratorConcept</span>
<a name="l00222"></a>00222 <span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00223"></a>00223 <span class="keyword">struct </span>byte_to_memunit&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; : <span class="keyword">public</span> byte_to_memunit&lt;Iterator&gt; {};
<a name="l00224"></a>00224
<a name="l00225"></a>00225 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00226"></a>00226 <span class="keyword">inline</span> std::ptrdiff_t memunit_step(<span class="keyword">const</span> memory_based_step_iterator&lt;Iterator&gt;&amp; p) { <span class="keywordflow">return</span> p.step(); }
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00229"></a>00229 <span class="keyword">inline</span> std::ptrdiff_t memunit_distance(<span class="keyword">const</span> memory_based_step_iterator&lt;Iterator&gt;&amp; p1,
<a name="l00230"></a>00230 <span class="keyword">const</span> memory_based_step_iterator&lt;Iterator&gt;&amp; p2) {
<a name="l00231"></a>00231 <span class="keywordflow">return</span> memunit_distance(p1.base(),p2.base());
<a name="l00232"></a>00232 }
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00235"></a>00235 <span class="keyword">inline</span> <span class="keywordtype">void</span> memunit_advance(memory_based_step_iterator&lt;Iterator&gt;&amp; p,
<a name="l00236"></a>00236 std::ptrdiff_t diff) {
<a name="l00237"></a>00237 memunit_advance(p.base(), diff);
<a name="l00238"></a>00238 }
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00241"></a>00241 <span class="keyword">inline</span> memory_based_step_iterator&lt;Iterator&gt;
<a name="l00242"></a>00242 memunit_advanced(<span class="keyword">const</span> memory_based_step_iterator&lt;Iterator&gt;&amp; p,
<a name="l00243"></a>00243 std::ptrdiff_t diff) {
<a name="l00244"></a>00244 <span class="keywordflow">return</span> memory_based_step_iterator&lt;Iterator&gt;(memunit_advanced(p.base(), diff),p.step());
<a name="l00245"></a>00245 }
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00248"></a>00248 <span class="keyword">inline</span> <span class="keyword">typename</span> std::iterator_traits&lt;Iterator&gt;::reference
<a name="l00249"></a>00249 memunit_advanced_ref(<span class="keyword">const</span> memory_based_step_iterator&lt;Iterator&gt;&amp; p,
<a name="l00250"></a>00250 std::ptrdiff_t diff) {
<a name="l00251"></a>00251 <span class="keywordflow">return</span> memunit_advanced_ref(p.base(), diff);
<a name="l00252"></a>00252 }
<a name="l00253"></a>00253
<a name="l00255"></a>00255 <span class="comment">// HasDynamicXStepTypeConcept</span>
<a name="l00257"></a>00257 <span class="comment"></span>
<a name="l00258"></a>00258 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator&gt;
<a name="l00259"></a>00259 <span class="keyword">struct </span>dynamic_x_step_type&lt;memory_based_step_iterator&lt;Iterator&gt; &gt; {
<a name="l00260"></a>00260 <span class="keyword">typedef</span> memory_based_step_iterator&lt;Iterator&gt; type;
<a name="l00261"></a>00261 };
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="comment">// For step iterators, pass the function object to the base</span>
<a name="l00264"></a>00264 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Iterator, <span class="keyword">typename</span> Deref&gt;
<a name="l00265"></a>00265 <span class="keyword">struct </span>iterator_add_deref&lt;memory_based_step_iterator&lt;Iterator&gt;,Deref&gt; {
<a name="l00266"></a>00266 GIL_CLASS_REQUIRE(Deref, boost::gil, PixelDereferenceAdaptorConcept)
<a name="l00267"></a>00267
<a name="l00268"></a>00268 typedef memory_based_step_iterator&lt;typename iterator_add_deref&lt;Iterator, Deref&gt;::type&gt; type;
<a name="l00269"></a>00269
<a name="l00270"></a>00270 static type make(const memory_based_step_iterator&lt;Iterator&gt;&amp; it, const Deref&amp; d) { <span class="keywordflow">return</span> type(iterator_add_deref&lt;Iterator, Deref&gt;::make(it.base(),d),it.step()); }
<a name="l00271"></a>00271 };
<a name="l00272"></a>00272
<a name="l00276"></a>00276
<a name="l00277"></a>00277 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I&gt; <span class="keyword">typename</span> dynamic_x_step_type&lt;I&gt;::type make_step_iterator(<span class="keyword">const</span> I&amp; it, std::ptrdiff_t step);
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="keyword">namespace </span>detail {
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="comment">// if the iterator is a plain base iterator (non-adaptor), wraps it in memory_based_step_iterator</span>
<a name="l00282"></a>00282 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I&gt;
<a name="l00283"></a>00283 <span class="keyword">typename</span> dynamic_x_step_type&lt;I&gt;::type make_step_iterator_impl(<span class="keyword">const</span> I&amp; it, std::ptrdiff_t step, mpl::false_) {
<a name="l00284"></a>00284 <span class="keywordflow">return</span> memory_based_step_iterator&lt;I&gt;(it, step);
<a name="l00285"></a>00285 }
<a name="l00286"></a>00286
<a name="l00287"></a>00287 <span class="comment">// If the iterator is compound, put the step in its base</span>
<a name="l00288"></a>00288 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I&gt;
<a name="l00289"></a>00289 <span class="keyword">typename</span> dynamic_x_step_type&lt;I&gt;::type make_step_iterator_impl(<span class="keyword">const</span> I&amp; it, std::ptrdiff_t step, mpl::true_) {
<a name="l00290"></a>00290 <span class="keywordflow">return</span> make_step_iterator(it.base(), step);
<a name="l00291"></a>00291 }
<a name="l00292"></a>00292
<a name="l00293"></a>00293 <span class="comment">// If the iterator is memory_based_step_iterator, change the step</span>
<a name="l00294"></a>00294 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> BaseIt&gt;
<a name="l00295"></a>00295 memory_based_step_iterator&lt;BaseIt&gt; make_step_iterator_impl(<span class="keyword">const</span> memory_based_step_iterator&lt;BaseIt&gt;&amp; it, std::ptrdiff_t step, mpl::true_) {
<a name="l00296"></a>00296 <span class="keywordflow">return</span> memory_based_step_iterator&lt;BaseIt&gt;(it.base(), step);
<a name="l00297"></a>00297 }
<a name="l00298"></a>00298 }
<a name="l00299"></a>00299
<a name="l00313"></a>00313 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I&gt; <span class="comment">// Models MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept</span>
<a name="l00314"></a>00314 <span class="keyword">typename</span> dynamic_x_step_type&lt;I&gt;::type make_step_iterator(<span class="keyword">const</span> I&amp; it, std::ptrdiff_t step) {
<a name="l00315"></a>00315 <span class="keywordflow">return</span> detail::make_step_iterator_impl(it, step, <span class="keyword">typename</span> is_iterator_adaptor&lt;I&gt;::type());
<a name="l00316"></a>00316 }
<a name="l00317"></a>00317
<a name="l00318"></a>00318 } } <span class="comment">// namespace boost::gil</span>
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 13:50:15 2009 for Generic Image Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>