1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function template make_strided_iterator_end</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_iterator_hpp" title="Header <boost/compute/iterator/strided_iterator.hpp>"> 9<link rel="prev" href="make_strided_iterator.html" title="Function template make_strided_iterator"> 10<link rel="next" href="transform_iterator.html" title="Class template transform_iterator"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="make_strided_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_iterator_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transform_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.make_strided_iterator_end"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function template make_strided_iterator_end</span></h2> 29<p>boost::compute::make_strided_iterator_end</p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_iterator_hpp" title="Header <boost/compute/iterator/strided_iterator.hpp>">boost/compute/iterator/strided_iterator.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iterator<span class="special">></span> 36 <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special"><</span> <span class="identifier">Iterator</span> <span class="special">></span> 37 <span class="identifier">make_strided_iterator_end</span><span class="special">(</span><span class="identifier">Iterator</span> first<span class="special">,</span> <span class="identifier">Iterator</span> last<span class="special">,</span> 38 <span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">iterator_traits</span><span class="special"><</span> <span class="identifier">Iterator</span> <span class="special">></span><span class="special">::</span><span class="identifier">difference_type</span> stride<span class="special">)</span><span class="special">;</span></pre></div> 39<div class="refsect1"> 40<a name="idm45849506367104"></a><h2>Description</h2> 41<p>Returns a <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> which refers to element that would follow the last element accessible through <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> for <code class="computeroutput">first</code> iterator with <code class="computeroutput">stride</code>.</p> 42<p>Parameter <code class="computeroutput">stride</code> must be greater than zero.</p> 43<p> 44 45It can be helpful when iterating over <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code>: </p> 46<pre class="programlisting"><span class="comment">// vec.size() may not be divisible by 3</span> 47<span class="keyword">auto</span> <span class="identifier">strided_iterator_begin</span> <span class="special">=</span> <span class="identifier">make_strided_iterator</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="number">3</span><span class="special">)</span><span class="special">;</span> 48<span class="keyword">auto</span> <span class="identifier">strided_iterator_end</span> <span class="special">=</span> <span class="identifier">make_strided_iterator_end</span><span class="special">(</span><span class="identifier">vec</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">vec</span><span class="special">.</span><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="number">3</span><span class="special">)</span><span class="special">;</span> 49 50<span class="comment">// copy every 3rd element to result</span> 51<span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">copy</span><span class="special">(</span> 52 <span class="identifier">strided_iterator_begin</span><span class="special">,</span> 53 <span class="identifier">strided_iterator_end</span><span class="special">,</span> 54 <span class="identifier">result</span><span class="special">.</span><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> 55 <span class="identifier">queue</span> 56<span class="special">)</span><span class="special">;</span> 57</pre> 58<p> </p> 59<div class="variablelist"><table border="0" class="variablelist compact"> 60<colgroup> 61<col align="left" valign="top"> 62<col> 63</colgroup> 64<tbody> 65<tr> 66<td><p><span class="term">Parameters:</span></p></td> 67<td><div class="variablelist"><table border="0" class="variablelist compact"> 68<colgroup> 69<col align="left" valign="top"> 70<col> 71</colgroup> 72<tbody> 73<tr> 74<td><p><span class="term"><code class="computeroutput">first</code></span></p></td> 75<td><p>the iterator referring to the first element accessible through <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> for <code class="computeroutput">first</code> with <code class="computeroutput">stride</code> </p></td> 76</tr> 77<tr> 78<td><p><span class="term"><code class="computeroutput">last</code></span></p></td> 79<td><p>the iterator referring to the last element that may be accessible through <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> for <code class="computeroutput">first</code> with <code class="computeroutput">stride</code> </p></td> 80</tr> 81<tr> 82<td><p><span class="term"><code class="computeroutput">stride</code></span></p></td> 83<td><p>the iteration step</p></td> 84</tr> 85</tbody> 86</table></div></td> 87</tr> 88<tr> 89<td><p><span class="term">Returns:</span></p></td> 90<td><p>a <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> referring to element that would follow the last element accessible through <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a> for <code class="computeroutput">first</code> iterator with <code class="computeroutput">stride</code>.</p></td> 91</tr> 92</tbody> 93</table></div> 94</div> 95</div> 96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 97<td align="left"></td> 98<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 99 Distributed under the Boost Software License, Version 1.0. (See accompanying 100 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 101 </p> 102</div></td> 103</tr></table> 104<hr> 105<div class="spirit-nav"> 106<a accesskey="p" href="make_strided_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_iterator_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="transform_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 107</div> 108</body> 109</html> 110
