libs/compute/doc/html/boost/compute/program_build_failure.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class program_build_failure</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.exception.program_build_failure_hpp" title="Header &lt;boost/compute/exception/program_build_failure.hpp&gt;">
   9 <link rel="prev" href="opencl_error.html" title="Class opencl_error">
  10 <link rel="next" href="unsuppor_idm46009692979488.html" title="Class unsupported_extension_error">
  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="opencl_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_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="unsuppor_idm46009692979488.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.program_build_failure"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class program_build_failure</span></h2>
  29 <p>boost::compute::program_build_failure &#8212; A failure when building OpenCL program. </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.exception.program_build_failure_hpp" title="Header &lt;boost/compute/exception/program_build_failure.hpp&gt;">boost/compute/exception/program_build_failure.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">opencl_error</span> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="program_build_failure.html#boost.compute.program_build_failureconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">explicit</span> <a class="link" href="program_build_failure.html#idm46009692987248-bb"><span class="identifier">program_build_failure</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="program_build_failure.html#idm46009692983264-bb"><span class="special">~</span><span class="identifier">program_build_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="program_build_failure.html#idm46009692989408-bb">public member functions</a></span>
  42   <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="program_build_failure.html#idm46009692988848-bb"><span class="identifier">build_log</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43 <span class="special">}</span><span class="special">;</span></pre></div>
  44 <div class="refsect1">
  45 <a name="idm46113323331856"></a><h2>Description</h2>
  46 <p>Instances of this class are thrown when OpenCL program build fails. Extends <a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> by saving a program build log so it can be used for testing, debugging, or logging purposes.</p>
  47 <p><span class="bold"><strong>See Also:</strong></span></p>
  48 <p><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> </p>
  49 <p>
  50 </p>
  51 <p>
  52 </p>
  53 <div class="refsect2">
  54 <a name="idm46113323328160"></a><h3>
  55 <a name="boost.compute.program_build_failureconstruct-copy-destruct"></a><code class="computeroutput">program_build_failure</code>
  56         public
  57        construct/copy/destruct</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1">
  59 <li class="listitem">
  60 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692987248-bb"></a><span class="identifier">program_build_failure</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&amp;</span> build_log<span class="special">)</span><span class="special">;</span></pre>
  61 <p>Creates a new <code class="computeroutput"><a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a></code> exception object for <code class="computeroutput">error</code> and <code class="computeroutput">build_log</code>. </p>
  62 </li>
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idm46009692983264-bb"></a><span class="special">~</span><span class="identifier">program_build_failure</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="program_build_failure.html" title="Class program_build_failure">program_build_failure</a></code> object. </li>
  65 </ol></div>
  66 </div>
  67 <div class="refsect2">
  68 <a name="idm46113323308480"></a><h3>
  69 <a name="idm46009692989408-bb"></a><code class="computeroutput">program_build_failure</code> public member functions</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  71 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46009692988848-bb"></a><span class="identifier">build_log</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Retrieve the log of a failed program build. </li></ol></div>
  72 </div>
  73 </div>
  74 </div>
  75 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  76 <td align="left"></td>
  77 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  78         Distributed under the Boost Software License, Version 1.0. (See accompanying
  79         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>)
  80       </p>
  81 </div></td>
  82 </tr></table>
  83 <hr>
  84 <div class="spirit-nav">
  85 <a accesskey="p" href="opencl_error.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.exception.program_build_failure_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="unsuppor_idm46009692979488.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  86 </div>
  87 </body>
  88 </html>