arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_kernel_library.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>ARM Compute Library: CLKernelLibrary Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_kernel_library.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> &#124;
119 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">CLKernelLibrary Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class.  
126  <a href="classarm__compute_1_1_c_l_kernel_library.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>&gt;</code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:a670869004281695200784de4648a4e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a670869004281695200784de4648a4e1b">CLKernelLibrary</a> (const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;)=delete</td></tr>
133 <tr class="memdesc:a670869004281695200784de4648a4e1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied.  <a href="#a670869004281695200784de4648a4e1b">More...</a><br /></td></tr>
134 <tr class="separator:a670869004281695200784de4648a4e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a54fb81956f9fb1c25b279e34e1e7d966">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;)=delete</td></tr>
136 <tr class="memdesc:a54fb81956f9fb1c25b279e34e1e7d966"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied.  <a href="#a54fb81956f9fb1c25b279e34e1e7d966">More...</a><br /></td></tr>
137 <tr class="separator:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:af353532ea782387df6bcb6d01894f4ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#af353532ea782387df6bcb6d01894f4ae">init</a> (std::string kernel_path=&quot;.&quot;, cl::Context context=cl::Context::getDefault(), cl::Device device=cl::Device::getDefault())</td></tr>
139 <tr class="memdesc:af353532ea782387df6bcb6d01894f4ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises the kernel library.  <a href="#af353532ea782387df6bcb6d01894f4ae">More...</a><br /></td></tr>
140 <tr class="separator:af353532ea782387df6bcb6d01894f4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a66a558a56f5d0dcd6305c405ebc38cc2">set_kernel_path</a> (const std::string &amp;kernel_path)</td></tr>
142 <tr class="memdesc:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the path that the kernels reside in.  <a href="#a66a558a56f5d0dcd6305c405ebc38cc2">More...</a><br /></td></tr>
143 <tr class="separator:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a293edc1bbcbddffb7228ac97917ed107"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a293edc1bbcbddffb7228ac97917ed107">set_context</a> (cl::Context context)</td></tr>
145 <tr class="memdesc:a293edc1bbcbddffb7228ac97917ed107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the CL context used to create programs.  <a href="#a293edc1bbcbddffb7228ac97917ed107">More...</a><br /></td></tr>
146 <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a5a6865d04c8d3348860f3cb8100fdb97">set_device</a> (cl::Device device)</td></tr>
148 <tr class="memdesc:a5a6865d04c8d3348860f3cb8100fdb97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the CL device for which the programs are created.  <a href="#a5a6865d04c8d3348860f3cb8100fdb97">More...</a><br /></td></tr>
149 <tr class="separator:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a07b37240bd1f09e36cf119dced79f9c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a07b37240bd1f09e36cf119dced79f9c4">create_kernel</a> (const std::string &amp;kernel_name, const StringSet &amp;build_options_set={}) const </td></tr>
151 <tr class="memdesc:a07b37240bd1f09e36cf119dced79f9c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a kernel from the kernel library.  <a href="#a07b37240bd1f09e36cf119dced79f9c4">More...</a><br /></td></tr>
152 <tr class="separator:a07b37240bd1f09e36cf119dced79f9c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a7c0b2aa80e920344936e8e7dbaa73e43">save_binary</a> ()</td></tr>
154 <tr class="memdesc:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes and saves programs to a binary.  <a href="#a7c0b2aa80e920344936e8e7dbaa73e43">More...</a><br /></td></tr>
155 <tr class="separator:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a389a543ae040ca6bf6b57fd6215f154b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a389a543ae040ca6bf6b57fd6215f154b">load_binary</a> ()</td></tr>
157 <tr class="memdesc:a389a543ae040ca6bf6b57fd6215f154b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load serialized binary with all the programs.  <a href="#a389a543ae040ca6bf6b57fd6215f154b">More...</a><br /></td></tr>
158 <tr class="separator:a389a543ae040ca6bf6b57fd6215f154b"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table><table class="memberdecls">
160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
161 Static Public Member Functions</h2></td></tr>
162 <tr class="memitem:aebe2d25607545d31f2b1ace6d60a81da"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">get</a> ()</td></tr>
163 <tr class="memdesc:aebe2d25607545d31f2b1ace6d60a81da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the KernelLibrary singleton.  <a href="#aebe2d25607545d31f2b1ace6d60a81da">More...</a><br /></td></tr>
164 <tr class="separator:aebe2d25607545d31f2b1ace6d60a81da"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 </table>
166 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
167 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class. </p>
168
169 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00140">140</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
170 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
171 <a class="anchor" id="a670869004281695200784de4648a4e1b"></a>
172 <div class="memitem">
173 <div class="memproto">
174 <table class="mlabels">
175   <tr>
176   <td class="mlabels-left">
177       <table class="memname">
178         <tr>
179           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> </td>
180           <td>(</td>
181           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td>
182           <td class="paramname"></td><td>)</td>
183           <td></td>
184         </tr>
185       </table>
186   </td>
187   <td class="mlabels-right">
188 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
189   </tr>
190 </table>
191 </div><div class="memdoc">
192
193 <p>Prevent instances of this class from being copied. </p>
194
195 </div>
196 </div>
197 <h2 class="groupheader">Member Function Documentation</h2>
198 <a class="anchor" id="a07b37240bd1f09e36cf119dced79f9c4"></a>
199 <div class="memitem">
200 <div class="memproto">
201       <table class="memname">
202         <tr>
203           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> create_kernel </td>
204           <td>(</td>
205           <td class="paramtype">const std::string &amp;&#160;</td>
206           <td class="paramname"><em>kernel_name</em>, </td>
207         </tr>
208         <tr>
209           <td class="paramkey"></td>
210           <td></td>
211           <td class="paramtype">const StringSet &amp;&#160;</td>
212           <td class="paramname"><em>build_options_set</em> = <code>{}</code>&#160;</td>
213         </tr>
214         <tr>
215           <td></td>
216           <td>)</td>
217           <td></td><td> const</td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221
222 <p>Creates a kernel from the kernel library. </p>
223 <dl class="params"><dt>Parameters</dt><dd>
224   <table class="params">
225     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_name</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name. </td></tr>
226     <tr><td class="paramdir">[in]</td><td class="paramname">build_options_set</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> build options as a set.</td></tr>
227   </table>
228   </dd>
229 </dl>
230 <dl class="section return"><dt>Returns</dt><dd>The created kernel. </dd></dl>
231
232 </div>
233 </div>
234 <a class="anchor" id="aebe2d25607545d31f2b1ace6d60a81da"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238   <tr>
239   <td class="mlabels-left">
240       <table class="memname">
241         <tr>
242           <td class="memname">static <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>&amp; get </td>
243           <td>(</td>
244           <td class="paramname"></td><td>)</td>
245           <td></td>
246         </tr>
247       </table>
248   </td>
249   <td class="mlabels-right">
250 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
251   </tr>
252 </table>
253 </div><div class="memdoc">
254
255 <p>Access the KernelLibrary singleton. </p>
256 <dl class="section return"><dt>Returns</dt><dd>The KernelLibrary instance. </dd></dl>
257
258 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00050">CLScheduler::default_init()</a>.</p>
259
260 </div>
261 </div>
262 <a class="anchor" id="af353532ea782387df6bcb6d01894f4ae"></a>
263 <div class="memitem">
264 <div class="memproto">
265 <table class="mlabels">
266   <tr>
267   <td class="mlabels-left">
268       <table class="memname">
269         <tr>
270           <td class="memname">void init </td>
271           <td>(</td>
272           <td class="paramtype">std::string&#160;</td>
273           <td class="paramname"><em>kernel_path</em> = <code>&quot;.&quot;</code>, </td>
274         </tr>
275         <tr>
276           <td class="paramkey"></td>
277           <td></td>
278           <td class="paramtype">cl::Context&#160;</td>
279           <td class="paramname"><em>context</em> = <code>cl::Context::getDefault()</code>, </td>
280         </tr>
281         <tr>
282           <td class="paramkey"></td>
283           <td></td>
284           <td class="paramtype">cl::Device&#160;</td>
285           <td class="paramname"><em>device</em> = <code>cl::Device::getDefault()</code>&#160;</td>
286         </tr>
287         <tr>
288           <td></td>
289           <td>)</td>
290           <td></td><td></td>
291         </tr>
292       </table>
293   </td>
294   <td class="mlabels-right">
295 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
296   </tr>
297 </table>
298 </div><div class="memdoc">
299
300 <p>Initialises the kernel library. </p>
301 <dl class="params"><dt>Parameters</dt><dd>
302   <table class="params">
303     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>(Optional) Path of the directory from which kernel sources are loaded. </td></tr>
304     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>(Optional) CL context used to create programs. </td></tr>
305     <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>(Optional) CL device for which the programs are created. </td></tr>
306   </table>
307   </dd>
308 </dl>
309
310 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">163</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
311
312 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00050">CLScheduler::default_init()</a>.</p>
313 <div class="fragment"><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    {</div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;        _kernel_path = std::move(kernel_path);</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;        _context     = std::move(context);</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;        _device      = std::move(device);</div><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    }</div></div><!-- fragment -->
314 </div>
315 </div>
316 <a class="anchor" id="a389a543ae040ca6bf6b57fd6215f154b"></a>
317 <div class="memitem">
318 <div class="memproto">
319       <table class="memname">
320         <tr>
321           <td class="memname">void load_binary </td>
322           <td>(</td>
323           <td class="paramname"></td><td>)</td>
324           <td></td>
325         </tr>
326       </table>
327 </div><div class="memdoc">
328
329 <p>Load serialized binary with all the programs. </p>
330
331 </div>
332 </div>
333 <a class="anchor" id="a54fb81956f9fb1c25b279e34e1e7d966"></a>
334 <div class="memitem">
335 <div class="memproto">
336 <table class="mlabels">
337   <tr>
338   <td class="mlabels-left">
339       <table class="memname">
340         <tr>
341           <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>&amp; operator= </td>
342           <td>(</td>
343           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td>
344           <td class="paramname"></td><td>)</td>
345           <td></td>
346         </tr>
347       </table>
348   </td>
349   <td class="mlabels-right">
350 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
351   </tr>
352 </table>
353 </div><div class="memdoc">
354
355 <p>Prevent instances of this class from being copied. </p>
356
357 </div>
358 </div>
359 <a class="anchor" id="a7c0b2aa80e920344936e8e7dbaa73e43"></a>
360 <div class="memitem">
361 <div class="memproto">
362       <table class="memname">
363         <tr>
364           <td class="memname">void save_binary </td>
365           <td>(</td>
366           <td class="paramname"></td><td>)</td>
367           <td></td>
368         </tr>
369       </table>
370 </div><div class="memdoc">
371
372 <p>Serializes and saves programs to a binary. </p>
373
374 </div>
375 </div>
376 <a class="anchor" id="a293edc1bbcbddffb7228ac97917ed107"></a>
377 <div class="memitem">
378 <div class="memproto">
379 <table class="mlabels">
380   <tr>
381   <td class="mlabels-left">
382       <table class="memname">
383         <tr>
384           <td class="memname">void set_context </td>
385           <td>(</td>
386           <td class="paramtype">cl::Context&#160;</td>
387           <td class="paramname"><em>context</em></td><td>)</td>
388           <td></td>
389         </tr>
390       </table>
391   </td>
392   <td class="mlabels-right">
393 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
394   </tr>
395 </table>
396 </div><div class="memdoc">
397
398 <p>Sets the CL context used to create programs. </p>
399 <dl class="section note"><dt>Note</dt><dd>Setting the context also resets the device to the first one available in the new context.</dd></dl>
400 <dl class="params"><dt>Parameters</dt><dd>
401   <table class="params">
402     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr>
403   </table>
404   </dd>
405 </dl>
406
407 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00184">184</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
408 <div class="fragment"><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    {</div><div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;        _context = std::move(context);</div><div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;</div><div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> cl_devices = _context.getInfo&lt;CL_CONTEXT_DEVICES&gt;();</div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;</div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;        <span class="keywordflow">if</span>(cl_devices.empty())</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;        {</div><div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;            _device = cl::Device();</div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;        }</div><div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        <span class="keywordflow">else</span></div><div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;        {</div><div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;            _device = cl_devices[0];</div><div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;        }</div><div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    };</div></div><!-- fragment -->
409 </div>
410 </div>
411 <a class="anchor" id="a5a6865d04c8d3348860f3cb8100fdb97"></a>
412 <div class="memitem">
413 <div class="memproto">
414 <table class="mlabels">
415   <tr>
416   <td class="mlabels-left">
417       <table class="memname">
418         <tr>
419           <td class="memname">void set_device </td>
420           <td>(</td>
421           <td class="paramtype">cl::Device&#160;</td>
422           <td class="paramname"><em>device</em></td><td>)</td>
423           <td></td>
424         </tr>
425       </table>
426   </td>
427   <td class="mlabels-right">
428 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
429   </tr>
430 </table>
431 </div><div class="memdoc">
432
433 <p>Sets the CL device for which the programs are created. </p>
434 <dl class="params"><dt>Parameters</dt><dd>
435   <table class="params">
436     <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>A CL device. </td></tr>
437   </table>
438   </dd>
439 </dl>
440
441 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00203">203</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
442 <div class="fragment"><div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;    {</div><div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;        _device = std::move(device);</div><div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;    };</div></div><!-- fragment -->
443 </div>
444 </div>
445 <a class="anchor" id="a66a558a56f5d0dcd6305c405ebc38cc2"></a>
446 <div class="memitem">
447 <div class="memproto">
448 <table class="mlabels">
449   <tr>
450   <td class="mlabels-left">
451       <table class="memname">
452         <tr>
453           <td class="memname">void set_kernel_path </td>
454           <td>(</td>
455           <td class="paramtype">const std::string &amp;&#160;</td>
456           <td class="paramname"><em>kernel_path</em></td><td>)</td>
457           <td></td>
458         </tr>
459       </table>
460   </td>
461   <td class="mlabels-right">
462 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
463   </tr>
464 </table>
465 </div><div class="memdoc">
466
467 <p>Sets the path that the kernels reside in. </p>
468 <dl class="params"><dt>Parameters</dt><dd>
469   <table class="params">
470     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>Path of the kernel. </td></tr>
471   </table>
472   </dd>
473 </dl>
474
475 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00173">173</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
476 <div class="fragment"><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    {</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;        _kernel_path = kernel_path;</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    };</div></div><!-- fragment -->
477 </div>
478 </div>
479 <hr/>The documentation for this class was generated from the following file:<ul>
480 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
481 </ul>
482 </div><!-- contents -->
483 </div><!-- doc-content -->
484 <!-- start footer part -->
485 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
486   <ul>
487     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a></li>
488     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
489     <a href="http://www.doxygen.org/index.html">
490     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
491   </ul>
492 </div>
493 </body>
494 </html>