Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / opencl_error.html
index b230dca..f95da42 100644 (file)
 <span class="keyword">class</span> <a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">exception</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="opencl_error.html#boost.compute.opencl_errorconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <span class="keyword">explicit</span> <a class="link" href="opencl_error.html#idm46676581041648-bb"><span class="identifier">opencl_error</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="opencl_error.html#idm46676581038928-bb"><span class="special">~</span><span class="identifier">opencl_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="opencl_error.html#idm46009693005584-bb"><span class="identifier">opencl_error</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="opencl_error.html#idm46009693002864-bb"><span class="special">~</span><span class="identifier">opencl_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="opencl_error.html#idm46676581046672-bb">public member functions</a></span>
-  <span class="identifier">cl_int</span> <a class="link" href="opencl_error.html#idm46676581046112-bb"><span class="identifier">error_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="opencl_error.html#idm46676581044688-bb"><span class="identifier">error_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="opencl_error.html#idm46676581043248-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="opencl_error.html#idm46009693010608-bb">public member functions</a></span>
+  <span class="identifier">cl_int</span> <a class="link" href="opencl_error.html#idm46009693010048-bb"><span class="identifier">error_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="opencl_error.html#idm46009693008624-bb"><span class="identifier">error_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="opencl_error.html#idm46009693007184-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="opencl_error.html#idm46676581037616-bb">public static functions</a></span>
-  <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="opencl_error.html#idm46676581037056-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">)</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="opencl_error.html#idm46009693001552-bb">public static functions</a></span>
+  <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="opencl_error.html#idm46009693000992-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="identifier">cl_int</span><span class="special">)</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094042256848"></a><h2>Description</h2>
+<a name="idm46113323434272"></a><h2>Description</h2>
 <p>The <a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a> class represents an error returned from an OpenCL function.</p>
 <p><span class="bold"><strong>See Also:</strong></span></p>
 <p><a class="link" href="context_error.html" title="Class context_error">context_error</a> </p>
 <p>
 </p>
 <div class="refsect2">
-<a name="idm46094042253152"></a><h3>
+<a name="idm46113323430576"></a><h3>
 <a name="boost.compute.opencl_errorconstruct-copy-destruct"></a><code class="computeroutput">opencl_error</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676581041648-bb"></a><span class="identifier">opencl_error</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">)</span><span class="special">;</span></pre>Creates a new <code class="computeroutput"><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a></code> exception object for <code class="computeroutput">error</code>. </li>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009693005584-bb"></a><span class="identifier">opencl_error</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">)</span><span class="special">;</span></pre>Creates a new <code class="computeroutput"><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a></code> exception object for <code class="computeroutput">error</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676581038928-bb"></a><span class="special">~</span><span class="identifier">opencl_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a></code> object. </li>
+<pre class="literallayout"><a name="idm46009693002864-bb"></a><span class="special">~</span><span class="identifier">opencl_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="opencl_error.html" title="Class opencl_error">opencl_error</a></code> object. </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094042238176"></a><h3>
-<a name="idm46676581046672-bb"></a><code class="computeroutput">opencl_error</code> public member functions</h3>
+<a name="idm46113323415536"></a><h3>
+<a name="idm46009693010608-bb"></a><code class="computeroutput">opencl_error</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">cl_int</span> <a name="idm46676581046112-bb"></a><span class="identifier">error_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the numeric error code. </li>
+<pre class="literallayout"><span class="identifier">cl_int</span> <a name="idm46009693010048-bb"></a><span class="identifier">error_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the numeric error code. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46676581044688-bb"></a><span class="identifier">error_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a string description of the error. </li>
+<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46009693008624-bb"></a><span class="identifier">error_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a string description of the error. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idm46676581043248-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a C-string description of the error. </li>
+<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idm46009693007184-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a C-string description of the error. </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094042218080"></a><h3>
-<a name="idm46676581037616-bb"></a><code class="computeroutput">opencl_error</code> public static functions</h3>
+<a name="idm46113323395376"></a><h3>
+<a name="idm46009693001552-bb"></a><code class="computeroutput">opencl_error</code> public static functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46676581037056-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idm46009693000992-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="identifier">cl_int</span> error<span class="special">)</span><span class="special">;</span></pre>
 <p>Static function which converts the numeric OpenCL error code <code class="computeroutput">error</code> to a human-readable string.</p>
 <p>For example: </p>
 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">opencl_error</span><span class="special">::</span><span class="identifier">to_string</span><span class="special">(</span><span class="identifier">CL_INVALID_KERNEL_ARGS</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>