libs/compute/doc/html/boost/compute/program_cache.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class program_cache</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.utility.program_cache_hpp" title="Header &lt;boost/compute/utility/program_cache.hpp&gt;">
   9 <link rel="prev" href="../../BOOST_CO_idm46009691554864.html" title="Macro BOOST_COMPUTE_DETAIL_DEFINE_INVOKE">
  10 <link rel="next" href="../../BOOST_CO_idm46009691508864.html" title="Macro BOOST_COMPUTE_STRINGIZE_SOURCE">
  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="../../BOOST_CO_idm46009691554864.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.program_cache_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_CO_idm46009691508864.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.program_cache"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class program_cache</span></h2>
  29 <p>boost::compute::program_cache</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.utility.program_cache_hpp" title="Header &lt;boost/compute/utility/program_cache.hpp&gt;">boost/compute/utility/program_cache.hpp</a>&gt;
  33
  34 </span>
  35 <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>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="program_cache.html#boost.compute.program_cacheconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="program_cache.html#idm46009691517488-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>
  39   <a class="link" href="program_cache.html#idm46009691515600-bb"><span class="special">~</span><span class="identifier">program_cache</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="program_cache.html#idm46009691544688-bb">public member functions</a></span>
  42   <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idm46009691544128-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="identifier">size_t</span> <a class="link" href="program_cache.html#idm46009691542672-bb"><span class="identifier">capacity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44   <span class="keyword">void</span> <a class="link" href="program_cache.html#idm46009691541232-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <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#idm46009691540080-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>
  46   <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#idm46009691537168-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>
  47   <span class="keyword">void</span> <a class="link" href="program_cache.html#idm46009691532672-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>
  48   <span class="keyword">void</span> <a class="link" href="program_cache.html#idm46009691529264-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>
  49   <span class="identifier">program</span> <a class="link" href="program_cache.html#idm46009691524720-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>
  50                        <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>
  51
  52   <span class="comment">// <a class="link" href="program_cache.html#idm46009691515008-bb">public static functions</a></span>
  53   <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#idm46009691514448-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>
  54 <span class="special">}</span><span class="special">;</span></pre></div>
  55 <div class="refsect1">
  56 <a name="idm46113315123840"></a><h2>Description</h2>
  57 <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>
  58 <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>
  59 <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>
  60 <p>For example, to insert a program into the cache: </p>
  61 <pre class="programlisting"><span class="identifier">cache</span><span class="special">.</span><span class="identifier">insert</span><span class="special">(</span><span class="string">"foo"</span><span class="special">,</span> <span class="identifier">foo_program</span><span class="special">)</span><span class="special">;</span>
  62 </pre>
  63 <p>And to retreive the program later: </p>
  64 <pre class="programlisting"><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> <span class="identifier">p</span> <span class="special">=</span> <span class="identifier">cache</span><span class="special">.</span><span class="identifier">get</span><span class="special">(</span><span class="string">"foo"</span><span class="special">)</span><span class="special">;</span>
  65 <span class="keyword">if</span><span class="special">(</span><span class="identifier">p</span><span class="special">)</span><span class="special">{</span>
  66     <span class="comment">// program found in cache</span>
  67 <span class="special">}</span>
  68 </pre>
  69 <p><span class="bold"><strong>See Also:</strong></span></p>
  70 <p>program </p>
  71 <p>
  72 </p>
  73 <p>
  74 </p>
  75 <div class="refsect2">
  76 <a name="idm46113315100704"></a><h3>
  77 <a name="boost.compute.program_cacheconstruct-copy-destruct"></a><code class="computeroutput">program_cache</code>
  78         public
  79        construct/copy/destruct</h3>
  80 <div class="orderedlist"><ol class="orderedlist" type="1">
  81 <li class="listitem">
  82 <pre class="literallayout"><a name="idm46009691517488-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>
  83 <p>Creates a new program cache with space for <code class="computeroutput">capacity</code> number of program objects. </p>
  84 </li>
  85 <li class="listitem">
  86 <pre class="literallayout"><a name="idm46009691515600-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>
  87 </ol></div>
  88 </div>
  89 <div class="refsect2">
  90 <a name="idm46113315088720"></a><h3>
  91 <a name="idm46009691544688-bb"></a><code class="computeroutput">program_cache</code> public member functions</h3>
  92 <div class="orderedlist"><ol class="orderedlist" type="1">
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009691544128-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>
  95 <li class="listitem">
  96 <pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009691542672-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>
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691541232-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>
  99 <li class="listitem">
 100 <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="idm46009691540080-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>
 101 <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>
 102 </li>
 103 <li class="listitem">
 104 <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>
 105 <a name="idm46009691537168-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>
 106 <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>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691532672-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>
 110 <li class="listitem">
 111 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691529264-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>
 112             <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>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="identifier">program</span> <a name="idm46009691524720-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>
 115                      <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>
 116 <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>
 117 <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>
 118 <p>Equivalent to: </p>
 119 <pre class="programlisting"><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> <span class="identifier">p</span> <span class="special">=</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">key</span><span class="special">,</span> <span class="identifier">options</span><span class="special">)</span><span class="special">;</span>
 120 <span class="keyword">if</span><span class="special">(</span><span class="special">!</span><span class="identifier">p</span><span class="special">)</span><span class="special">{</span>
 121     <span class="identifier">p</span> <span class="special">=</span> <span class="identifier">program</span><span class="special">::</span><span class="identifier">create_with_source</span><span class="special">(</span><span class="identifier">source</span><span class="special">,</span> <span class="identifier">context</span><span class="special">)</span><span class="special">;</span>
 122     <span class="identifier">p</span><span class="special">-&gt;</span><span class="identifier">build</span><span class="special">(</span><span class="identifier">options</span><span class="special">)</span><span class="special">;</span>
 123     <span class="identifier">insert</span><span class="special">(</span><span class="identifier">key</span><span class="special">,</span> <span class="identifier">options</span><span class="special">,</span> <span class="special">*</span><span class="identifier">p</span><span class="special">)</span><span class="special">;</span>
 124 <span class="special">}</span>
 125 <span class="keyword">return</span> <span class="special">*</span><span class="identifier">p</span><span class="special">;</span>
 126 </pre>
 127 <p> </p>
 128 </li>
 129 </ol></div>
 130 </div>
 131 <div class="refsect2">
 132 <a name="idm46113314961504"></a><h3>
 133 <a name="idm46009691515008-bb"></a><code class="computeroutput">program_cache</code> public static functions</h3>
 134 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 135 <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>
 136 <a name="idm46009691514448-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>
 137 <p>Returns the global program cache for <code class="computeroutput">context</code>.</p>
 138 <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>
 139 </li></ol></div>
 140 </div>
 141 </div>
 142 </div>
 143 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 144 <td align="left"></td>
 145 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 146         Distributed under the Boost Software License, Version 1.0. (See accompanying
 147         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>)
 148       </p>
 149 </div></td>
 150 </tr></table>
 151 <hr>
 152 <div class="spirit-nav">
 153 <a accesskey="p" href="../../BOOST_CO_idm46009691554864.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.program_cache_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_CO_idm46009691508864.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 154 </div>
 155 </body>
 156 </html>