Imported Upstream version 1.64.0

[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / program_cache.html

diff --git a/libs/compute/doc/html/boost/compute/program_cache.html b/libs/compute/doc/html/boost/compute/program_cache.html
index c01b650..a925f84 100644 (file)
--- a/libs/compute/doc/html/boost/compute/program_cache.html
+++ b/libs/compute/doc/html/boost/compute/program_cache.html
@@ -35,25 +35,25 @@
 <span class="keyword">class</span> <a class="link" href="program_cache.html" title="Class program_cache">program_cache</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">noncopyable</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="program_cache.html#boost.compute.program_cacheconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="program_cache.html#idp33378864-bb"><span class="identifier">program_cache</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="program_cache.html#idp33380752-bb"><span class="special">~</span><span class="identifier">program_cache</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="program_cache.html#idp49957312-bb"><span class="identifier">program_cache</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="program_cache.html#idp49959200-bb"><span class="special">~</span><span class="identifier">program_cache</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="program_cache.html#idp33351664-bb">public member functions</a></span>
-  <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idp33352224-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idp33353680-bb"><span class="identifier">capacity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp33355120-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp33356272-bb"><span class="identifier">get</span></a><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>
-  <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp33359184-bb"><span class="identifier">get</span></a><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="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>
-  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp33363680-bb"><span class="identifier">insert</span></a><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="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp33367088-bb"><span class="identifier">insert</span></a><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="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="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="identifier">program</span> <a class="link" href="program_cache.html#idp33371632-bb"><span class="identifier">get_or_build</span></a><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="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="comment">// <a class="link" href="program_cache.html#idp49930112-bb">public member functions</a></span>
+  <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idp49930672-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idp49932128-bb"><span class="identifier">capacity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp49933568-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp49934720-bb"><span class="identifier">get</span></a><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>
+  <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp49937632-bb"><span class="identifier">get</span></a><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="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>
+  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp49942128-bb"><span class="identifier">insert</span></a><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="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="program_cache.html#idp49945536-bb"><span class="identifier">insert</span></a><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="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="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="identifier">program</span> <a class="link" href="program_cache.html#idp49950080-bb"><span class="identifier">get_or_build</span></a><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="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="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="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="program_cache.html#idp33381344-bb">public static functions</a></span>
-  <span class="keyword">static</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="program_cache.html" title="Class program_cache">program_cache</a> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp33381904-bb"><span class="identifier">get_global_cache</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="program_cache.html#idp49959792-bb">public static functions</a></span>
+  <span class="keyword">static</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="program_cache.html" title="Class program_cache">program_cache</a> <span class="special">&gt;</span> <a class="link" href="program_cache.html#idp49960352-bb"><span class="identifier">get_global_cache</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idp115091440"></a><h2>Description</h2>
+<a name="idp112443984"></a><h2>Description</h2>
 <p>The <a class="link" href="program_cache.html" title="Class program_cache">program_cache</a> class stores program objects in a LRU cache.</p>
 <p>This class can be used to help mitigate the overhead of OpenCL's run-time kernel compilation model. Commonly used programs can be stored persistently in the cache and only compiled once on their first use.</p>
 <p>Program objects are stored and retreived based on a user-defined cache key along with the options used to build the program (if any).</p>
@@ -71,45 +71,45 @@
 <p>
 </p>
 <div class="refsect2">
-<a name="idp115114464"></a><h3>
+<a name="idp112467088"></a><h3>
 <a name="boost.compute.program_cacheconstruct-copy-destruct"></a><code class="computeroutput">program_cache</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idp33378864-bb"></a><span class="identifier">program_cache</span><span class="special">(</span><span class="identifier">size_t</span> capacity<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp49957312-bb"></a><span class="identifier">program_cache</span><span class="special">(</span><span class="identifier">size_t</span> capacity<span class="special">)</span><span class="special">;</span></pre>
 <p>Creates a new program cache with space for <code class="computeroutput">capacity</code> number of program objects. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idp33380752-bb"></a><span class="special">~</span><span class="identifier">program_cache</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the program cache. </li>
+<pre class="literallayout"><a name="idp49959200-bb"></a><span class="special">~</span><span class="identifier">program_cache</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the program cache. </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idp115126384"></a><h3>
-<a name="idp33351664-bb"></a><code class="computeroutput">program_cache</code> public member functions</h3>
+<a name="idp112479040"></a><h3>
+<a name="idp49930112-bb"></a><code class="computeroutput">program_cache</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <a name="idp33352224-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of program objects currently stored in the cache. </li>
+<pre class="literallayout"><span class="identifier">size_t</span> <a name="idp49930672-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of program objects currently stored in the cache. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <a name="idp33353680-bb"></a><span class="identifier">capacity</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the total capacity of the cache. </li>
+<pre class="literallayout"><span class="identifier">size_t</span> <a name="idp49932128-bb"></a><span class="identifier">capacity</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the total capacity of the cache. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp33355120-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Clears the program cache. </li>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp49933568-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Clears the program cache. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a name="idp33356272-bb"></a><span class="identifier">get</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> key<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> <a name="idp49934720-bb"></a><span class="identifier">get</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> key<span class="special">)</span><span class="special">;</span></pre>
 <p>Returns the program object with <code class="computeroutput">key</code>. Returns a null optional if no program with <code class="computeroutput">key</code> exists in the cache. </p>
 </li>
 <li class="listitem">
 <pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">program</span> <span class="special">&gt;</span> 
-<a name="idp33359184-bb"></a><span class="identifier">get</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> key<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> options<span class="special">)</span><span class="special">;</span></pre>
+<a name="idp49937632-bb"></a><span class="identifier">get</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> key<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> options<span class="special">)</span><span class="special">;</span></pre>
 <p>Returns the program object with <code class="computeroutput">key</code> and <code class="computeroutput">options</code>. Returns a null optional if no program with <code class="computeroutput">key</code> and <code class="computeroutput">options</code> exists in the cache. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp33363680-bb"></a><span class="identifier">insert</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> key<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span> program<span class="special">)</span><span class="special">;</span></pre>Inserts <code class="computeroutput">program</code> into the cache with <code class="computeroutput">key</code>. </li>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp49942128-bb"></a><span class="identifier">insert</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> key<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span> program<span class="special">)</span><span class="special">;</span></pre>Inserts <code class="computeroutput">program</code> into the cache with <code class="computeroutput">key</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idp33367088-bb"></a><span class="identifier">insert</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> key<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> options<span class="special">,</span> 
+<pre class="literallayout"><span class="keyword">void</span> <a name="idp49945536-bb"></a><span class="identifier">insert</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> key<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> options<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">program</span> <span class="special">&amp;</span> program<span class="special">)</span><span class="special">;</span></pre>Inserts <code class="computeroutput">program</code> into the cache with <code class="computeroutput">key</code> and <code class="computeroutput">options</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">program</span> <a name="idp33371632-bb"></a><span class="identifier">get_or_build</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> key<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> options<span class="special">,</span> 
+<pre class="literallayout"><span class="identifier">program</span> <a name="idp49950080-bb"></a><span class="identifier">get_or_build</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> key<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> options<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> source<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context<span class="special">)</span><span class="special">;</span></pre>
 <p>Loads the program with <code class="computeroutput">key</code> from the cache if it exists. Otherwise builds a new program with <code class="computeroutput">source</code> and <code class="computeroutput">options</code>, stores it in the cache, and returns it.</p>
 <p>This is a convenience function to simplify the common pattern of attempting to load a program from the cache and, if not present, building the program from source and storing it in the cache.</p>
@@ -127,11 +127,11 @@
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idp115253648"></a><h3>
-<a name="idp33381344-bb"></a><code class="computeroutput">program_cache</code> public static functions</h3>
+<a name="idp112606368"></a><h3>
+<a name="idp49959792-bb"></a><code class="computeroutput">program_cache</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">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <a class="link" href="program_cache.html" title="Class program_cache">program_cache</a> <span class="special">&gt;</span> 
-<a name="idp33381904-bb"></a><span class="identifier">get_global_cache</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context<span class="special">)</span><span class="special">;</span></pre>
+<a name="idp49960352-bb"></a><span class="identifier">get_global_cache</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context<span class="special">)</span><span class="special">;</span></pre>
 <p>Returns the global program cache for <code class="computeroutput">context</code>.</p>
 <p>This global cache is used internally by Boost.Compute to store compiled program objects used by its algorithms. All Boost.Compute programs are stored with a cache key beginning with <code class="computeroutput">"__boost"</code>. User programs should avoid using the same prefix in order to prevent collisions. </p>
 </li></ol></div>