libs/compute/doc/html/boost/compute/is_device_iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template is_device_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&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.type_traits.is_device_iterator_hpp" title="Header &lt;boost/compute/type_traits/is_device_iterator.hpp&gt;">
   9 <link rel="prev" href="uniform_real_distribution.html" title="Class template uniform_real_distribution">
  10 <link rel="next" href="is_fundamental.html" title="Struct template is_fundamental">
  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="uniform_real_distribution.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.type_traits.is_device_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="is_fundamental.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.is_device_iterator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template is_device_iterator</span></h2>
  29 <p>boost::compute::is_device_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.type_traits.is_device_iterator_hpp" title="Header &lt;boost/compute/type_traits/is_device_iterator.hpp&gt;">boost/compute/type_traits/is_device_iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="is_device_iterator.html" title="Struct template is_device_iterator">is_device_iterator</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">false_type</span> <span class="special">{</span>
  36 <span class="special">}</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm46113315972576"></a><h2>Description</h2>
  39 <p>Meta-function returning <code class="computeroutput">true</code> if <code class="computeroutput">Iterator</code> is a device-iterator.</p>
  40 <p>By default, this function returns false. Device iterator types (such as <a class="link" href="buffer_iterator.html" title="Class template buffer_iterator">buffer_iterator</a>) should specialize this trait and return <code class="computeroutput">true</code>.</p>
  41 <p>For example: </p>
  42 <pre class="programlisting"><span class="identifier">is_device_iterator</span><span class="special">&lt;</span><span class="identifier">buffer_iterator</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;&gt;</span><span class="special">::</span><span class="identifier">value</span> <span class="special">==</span> <span class="keyword">true</span>
  43 <span class="identifier">is_device_iterator</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span> <span class="special">==</span> <span class="keyword">false</span>
  44 </pre>
  45 <p> </p>
  46 </div>
  47 </div>
  48 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  49 <td align="left"></td>
  50 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  51         Distributed under the Boost Software License, Version 1.0. (See accompanying
  52         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>)
  53       </p>
  54 </div></td>
  55 </tr></table>
  56 <hr>
  57 <div class="spirit-nav">
  58 <a accesskey="p" href="uniform_real_distribution.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.type_traits.is_device_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="is_fundamental.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  59 </div>
  60 </body>
  61 </html>