• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function template make_strided_iterator</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 &lt;boost/compute/iterator/strided_iterator.hpp&gt;">
9<link rel="prev" href="strided_iterator.html" title="Class template strided_iterator">
10<link rel="next" href="make_strided_iterator_end.html" title="Function template make_strided_iterator_end">
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="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="make_strided_iterator_end.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"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template make_strided_iterator</span></h2>
29<p>boost::compute::make_strided_iterator</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: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.iterator.strided_iterator_hpp" title="Header &lt;boost/compute/iterator/strided_iterator.hpp&gt;">boost/compute/iterator/strided_iterator.hpp</a>&gt;
33
34</span>
35<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">&gt;</span>
36  <a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span>
37  <span class="identifier">make_strided_iterator</span><span class="special">(</span><span class="identifier">Iterator</span> iterator<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">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;</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="idm45849506408736"></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> for <code class="computeroutput">iterator</code> with <code class="computeroutput">stride</code>.</p>
42<p>
43
44For example, to create an iterator which iterates over every other element in a <code class="computeroutput">vector&lt;int&gt;</code>: </p>
45<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">strided_iterator</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">2</span><span class="special">)</span><span class="special">;</span>
46</pre>
47<p> </p>
48<div class="variablelist"><table border="0" class="variablelist compact">
49<colgroup>
50<col align="left" valign="top">
51<col>
52</colgroup>
53<tbody>
54<tr>
55<td><p><span class="term">Parameters:</span></p></td>
56<td><div class="variablelist"><table border="0" class="variablelist compact">
57<colgroup>
58<col align="left" valign="top">
59<col>
60</colgroup>
61<tbody>
62<tr>
63<td><p><span class="term"><code class="computeroutput">iterator</code></span></p></td>
64<td><p>the underlying iterator </p></td>
65</tr>
66<tr>
67<td><p><span class="term"><code class="computeroutput">stride</code></span></p></td>
68<td><p>the iteration step for <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code></p></td>
69</tr>
70</tbody>
71</table></div></td>
72</tr>
73<tr>
74<td><p><span class="term">Returns:</span></p></td>
75<td><p>a <code class="computeroutput"><a class="link" href="strided_iterator.html" title="Class template strided_iterator">strided_iterator</a></code> for <code class="computeroutput">iterator</code> with <code class="computeroutput">stride</code>.</p></td>
76</tr>
77</tbody>
78</table></div>
79</div>
80</div>
81<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
82<td align="left"></td>
83<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p>
84        Distributed under the Boost Software License, Version 1.0. (See accompanying
85        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>)
86      </p>
87</div></td>
88</tr></table>
89<hr>
90<div class="spirit-nav">
91<a accesskey="p" href="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="make_strided_iterator_end.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
92</div>
93</body>
94</html>
95