libs/compute/doc/html/boost/compute/type_name.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template type_name</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.type_name_hpp" title="Header &lt;boost/compute/type_traits/type_name.hpp&gt;">
   9 <link rel="prev" href="type_definition.html" title="Function template type_definition">
  10 <link rel="next" href="../../BOOST_COMPUTE_TYPE_NAME.html" title="Macro BOOST_COMPUTE_TYPE_NAME">
  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="type_definition.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.type_traits.type_name_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="../../BOOST_COMPUTE_TYPE_NAME.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.type_name"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template type_name</span></h2>
  29 <p>boost::compute::type_name</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.type_name_hpp" title="Header &lt;boost/compute/type_traits/type_name.hpp&gt;">boost/compute/type_traits/type_name.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="identifier">type_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div>
  36 <div class="refsect1">
  37 <a name="idm46113315694288"></a><h2>Description</h2>
  38 <p>Returns the OpenCL type name for the type <code class="computeroutput">T</code> as a string.</p>
  39 <p>
  40 For example: </p>
  41 <pre class="programlisting"><span class="identifier">type_name</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span><span class="special">(</span><span class="special">)</span> <span class="special">==</span> <span class="string">"float"</span>
  42 <span class="identifier">type_name</span><span class="special">&lt;</span><span class="identifier">float4_</span><span class="special">&gt;</span><span class="special">(</span><span class="special">)</span> <span class="special">==</span> <span class="string">"float4"</span>
  43 </pre>
  44 <p><span class="bold"><strong>See Also:</strong></span></p>
  45 <p>type_definition&lt;T&gt;() </p>
  46 <p>
  47 </p>
  48 <p>
  49 </p>
  50 <div class="variablelist"><table border="0" class="variablelist compact">
  51 <colgroup>
  52 <col align="left" valign="top">
  53 <col>
  54 </colgroup>
  55 <tbody><tr>
  56 <td><p><span class="term">Returns:</span></p></td>
  57 <td><p>a string containing the type name for <code class="computeroutput">T</code> </p></td>
  58 </tr></tbody>
  59 </table></div>
  60 </div>
  61 </div>
  62 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  63 <td align="left"></td>
  64 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  65         Distributed under the Boost Software License, Version 1.0. (See accompanying
  66         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>)
  67       </p>
  68 </div></td>
  69 </tr></table>
  70 <hr>
  71 <div class="spirit-nav">
  72 <a accesskey="p" href="type_definition.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.type_traits.type_name_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="../../BOOST_COMPUTE_TYPE_NAME.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  73 </div>
  74 </body>
  75 </html>