• 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_transform_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.transform_iterator_hpp" title="Header &lt;boost/compute/iterator/transform_iterator.hpp&gt;">
9<link rel="prev" href="transform_iterator.html" title="Class template transform_iterator">
10<link rel="next" href="zip_iterator.html" title="Class template zip_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="transform_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.transform_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="zip_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.compute.make_transform_iterator"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template make_transform_iterator</span></h2>
29<p>boost::compute::make_transform_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.transform_iterator_hpp" title="Header &lt;boost/compute/iterator/transform_iterator.hpp&gt;">boost/compute/iterator/transform_iterator.hpp</a>&gt;
33
34</span>
35<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> InputIterator<span class="special">,</span> <span class="keyword">typename</span> UnaryFunction<span class="special">&gt;</span>
36  <a class="link" href="transform_iterator.html" title="Class template transform_iterator">transform_iterator</a><span class="special">&lt;</span> <span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">UnaryFunction</span> <span class="special">&gt;</span>
37  <span class="identifier">make_transform_iterator</span><span class="special">(</span><span class="identifier">InputIterator</span> iterator<span class="special">,</span> <span class="identifier">UnaryFunction</span> transform<span class="special">)</span><span class="special">;</span></pre></div>
38<div class="refsect1">
39<a name="idm45849506102416"></a><h2>Description</h2>
40<p>Returns a <code class="computeroutput"><a class="link" href="transform_iterator.html" title="Class template transform_iterator">transform_iterator</a></code> for <code class="computeroutput">iterator</code> with <code class="computeroutput">transform</code>.</p>
41<p>
42
43For example, to create an iterator which returns the square-root of each value in a <code class="computeroutput">vector&lt;int&gt;</code>: </p>
44<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">sqrt_iterator</span> <span class="special">=</span> <span class="identifier">make_transform_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="identifier">sqrt</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
45</pre>
46<p> </p>
47<div class="variablelist"><table border="0" class="variablelist compact">
48<colgroup>
49<col align="left" valign="top">
50<col>
51</colgroup>
52<tbody>
53<tr>
54<td><p><span class="term">Parameters:</span></p></td>
55<td><div class="variablelist"><table border="0" class="variablelist compact">
56<colgroup>
57<col align="left" valign="top">
58<col>
59</colgroup>
60<tbody>
61<tr>
62<td><p><span class="term"><code class="computeroutput">iterator</code></span></p></td>
63<td><p>the underlying iterator </p></td>
64</tr>
65<tr>
66<td><p><span class="term"><code class="computeroutput">transform</code></span></p></td>
67<td><p>the unary transform function</p></td>
68</tr>
69</tbody>
70</table></div></td>
71</tr>
72<tr>
73<td><p><span class="term">Returns:</span></p></td>
74<td><p>a <code class="computeroutput"><a class="link" href="transform_iterator.html" title="Class template transform_iterator">transform_iterator</a></code> for <code class="computeroutput">iterator</code> with <code class="computeroutput">transform</code> </p></td>
75</tr>
76</tbody>
77</table></div>
78</div>
79</div>
80<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
81<td align="left"></td>
82<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p>
83        Distributed under the Boost Software License, Version 1.0. (See accompanying
84        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>)
85      </p>
86</div></td>
87</tr></table>
88<hr>
89<div class="spirit-nav">
90<a accesskey="p" href="transform_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.iterator.transform_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="zip_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
91</div>
92</body>
93</html>
94