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">
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>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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.05</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_kernel_library.xhtml','');});
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105 onmouseover="return searchBox.OnSearchSelectShow()"
106 onmouseout="return searchBox.OnSearchSelectHide()"
107 onkeydown="return searchBox.OnSearchSelectKey(event)">
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0"
113 name="MSearchResults" id="MSearchResults">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> |
120 <a href="#pub-static-methods">Static Public Member Functions</a> </div>
121 <div class="headertitle">
122 <div class="title">CLKernelLibrary Class Reference</div> </div>
124 <div class="contents">
126 <p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class.
127 <a href="classarm__compute_1_1_c_l_kernel_library.xhtml#details">More...</a></p>
129 <p><code>#include <<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>></code></p>
130 <table class="memberdecls">
131 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
132 Public Member Functions</h2></td></tr>
133 <tr class="memitem:a670869004281695200784de4648a4e1b"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
134 <tr class="memdesc:a670869004281695200784de4648a4e1b"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied. <a href="#a670869004281695200784de4648a4e1b">More...</a><br /></td></tr>
135 <tr class="separator:a670869004281695200784de4648a4e1b"><td class="memSeparator" colspan="2"> </td></tr>
136 <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> & </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> &)=delete</td></tr>
137 <tr class="memdesc:a54fb81956f9fb1c25b279e34e1e7d966"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied. <a href="#a54fb81956f9fb1c25b279e34e1e7d966">More...</a><br /></td></tr>
138 <tr class="separator:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memSeparator" colspan="2"> </td></tr>
139 <tr class="memitem:af353532ea782387df6bcb6d01894f4ae"><td class="memItemLeft" align="right" valign="top">void </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=".", cl::Context <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>=cl::Context::getDefault(), cl::Device device=cl::Device::getDefault())</td></tr>
140 <tr class="memdesc:af353532ea782387df6bcb6d01894f4ae"><td class="mdescLeft"> </td><td class="mdescRight">Initialises the kernel library. <a href="#af353532ea782387df6bcb6d01894f4ae">More...</a><br /></td></tr>
141 <tr class="separator:af353532ea782387df6bcb6d01894f4ae"><td class="memSeparator" colspan="2"> </td></tr>
142 <tr class="memitem:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memItemLeft" align="right" valign="top">void </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 &kernel_path)</td></tr>
143 <tr class="memdesc:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the path that the kernels reside in. <a href="#a66a558a56f5d0dcd6305c405ebc38cc2">More...</a><br /></td></tr>
144 <tr class="separator:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#ad7395c158d8e31b9af211b9bc1f65a08">get_kernel_path</a> ()</td></tr>
146 <tr class="memdesc:ad7395c158d8e31b9af211b9bc1f65a08"><td class="mdescLeft"> </td><td class="mdescRight">Gets the path that the kernels reside in. <a href="#ad7395c158d8e31b9af211b9bc1f65a08">More...</a><br /></td></tr>
147 <tr class="separator:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:a44e90c4fa1204a708499ece56d4c82f0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a44e90c4fa1204a708499ece56d4c82f0">get_program_source</a> (const std::string &program_name)</td></tr>
149 <tr class="memdesc:a44e90c4fa1204a708499ece56d4c82f0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the source of the selected program. <a href="#a44e90c4fa1204a708499ece56d4c82f0">More...</a><br /></td></tr>
150 <tr class="separator:a44e90c4fa1204a708499ece56d4c82f0"><td class="memSeparator" colspan="2"> </td></tr>
151 <tr class="memitem:a293edc1bbcbddffb7228ac97917ed107"><td class="memItemLeft" align="right" valign="top">void </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 <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>)</td></tr>
152 <tr class="memdesc:a293edc1bbcbddffb7228ac97917ed107"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CL context used to create programs. <a href="#a293edc1bbcbddffb7228ac97917ed107">More...</a><br /></td></tr>
153 <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2"> </td></tr>
154 <tr class="memitem:a252f5440564c77d68459f2baa978f86a"><td class="memItemLeft" align="right" valign="top">cl::Context & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">context</a> ()</td></tr>
155 <tr class="memdesc:a252f5440564c77d68459f2baa978f86a"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the associated CL context. <a href="#a252f5440564c77d68459f2baa978f86a">More...</a><br /></td></tr>
156 <tr class="separator:a252f5440564c77d68459f2baa978f86a"><td class="memSeparator" colspan="2"> </td></tr>
157 <tr class="memitem:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memItemLeft" align="right" valign="top">void </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>
158 <tr class="memdesc:a5a6865d04c8d3348860f3cb8100fdb97"><td class="mdescLeft"> </td><td class="mdescRight">Sets the CL device for which the programs are created. <a href="#a5a6865d04c8d3348860f3cb8100fdb97">More...</a><br /></td></tr>
159 <tr class="separator:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memSeparator" colspan="2"> </td></tr>
160 <tr class="memitem:aef78b2e57b5203f8a184465e2da020ef"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aef78b2e57b5203f8a184465e2da020ef">get_device_version</a> ()</td></tr>
161 <tr class="memdesc:aef78b2e57b5203f8a184465e2da020ef"><td class="mdescLeft"> </td><td class="mdescRight">Return the device version. <a href="#aef78b2e57b5203f8a184465e2da020ef">More...</a><br /></td></tr>
162 <tr class="separator:aef78b2e57b5203f8a184465e2da020ef"><td class="memSeparator" colspan="2"> </td></tr>
163 <tr class="memitem:a07b37240bd1f09e36cf119dced79f9c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </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 &kernel_name, const StringSet &build_options_set={}) const </td></tr>
164 <tr class="memdesc:a07b37240bd1f09e36cf119dced79f9c4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a kernel from the kernel library. <a href="#a07b37240bd1f09e36cf119dced79f9c4">More...</a><br /></td></tr>
165 <tr class="separator:a07b37240bd1f09e36cf119dced79f9c4"><td class="memSeparator" colspan="2"> </td></tr>
166 <tr class="memitem:ab04a95a810e685a1207c7f3443668261"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#ab04a95a810e685a1207c7f3443668261">max_local_workgroup_size</a> (const cl::Kernel &kernel) const </td></tr>
167 <tr class="memdesc:ab04a95a810e685a1207c7f3443668261"><td class="mdescLeft"> </td><td class="mdescRight">Find the maximum number of local work items in a workgroup can be supported for the kernel. <a href="#ab04a95a810e685a1207c7f3443668261">More...</a><br /></td></tr>
168 <tr class="separator:ab04a95a810e685a1207c7f3443668261"><td class="memSeparator" colspan="2"> </td></tr>
169 <tr class="memitem:a6dc2398a934f02224ad3743185f27699"><td class="memItemLeft" align="right" valign="top">cl::NDRange </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a6dc2398a934f02224ad3743185f27699">default_ndrange</a> () const </td></tr>
170 <tr class="memdesc:a6dc2398a934f02224ad3743185f27699"><td class="mdescLeft"> </td><td class="mdescRight">Return the default NDRange for the device. <a href="#a6dc2398a934f02224ad3743185f27699">More...</a><br /></td></tr>
171 <tr class="separator:a6dc2398a934f02224ad3743185f27699"><td class="memSeparator" colspan="2"> </td></tr>
172 <tr class="memitem:a0ad613086cc79a2e32d5b87bcefc7488"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a0ad613086cc79a2e32d5b87bcefc7488">clear_programs_cache</a> ()</td></tr>
173 <tr class="memdesc:a0ad613086cc79a2e32d5b87bcefc7488"><td class="mdescLeft"> </td><td class="mdescRight">Clear the library's cache of binary programs. <a href="#a0ad613086cc79a2e32d5b87bcefc7488">More...</a><br /></td></tr>
174 <tr class="separator:a0ad613086cc79a2e32d5b87bcefc7488"><td class="memSeparator" colspan="2"> </td></tr>
175 <tr class="memitem:a06fff433db9536097242dd9ab2188007"><td class="memItemLeft" align="right" valign="top">const std::map< std::string, cl::Program > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a06fff433db9536097242dd9ab2188007">get_built_programs</a> () const </td></tr>
176 <tr class="memdesc:a06fff433db9536097242dd9ab2188007"><td class="mdescLeft"> </td><td class="mdescRight">Access the cache of built OpenCL programs. <a href="#a06fff433db9536097242dd9ab2188007">More...</a><br /></td></tr>
177 <tr class="separator:a06fff433db9536097242dd9ab2188007"><td class="memSeparator" colspan="2"> </td></tr>
178 <tr class="memitem:a76d1513abb2d86ece6044a4fe2a83f56"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a76d1513abb2d86ece6044a4fe2a83f56">add_built_program</a> (const std::string &built_program_name, cl::Program program)</td></tr>
179 <tr class="memdesc:a76d1513abb2d86ece6044a4fe2a83f56"><td class="mdescLeft"> </td><td class="mdescRight">Add a new built program to the cache. <a href="#a76d1513abb2d86ece6044a4fe2a83f56">More...</a><br /></td></tr>
180 <tr class="separator:a76d1513abb2d86ece6044a4fe2a83f56"><td class="memSeparator" colspan="2"> </td></tr>
181 </table><table class="memberdecls">
182 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
183 Static Public Member Functions</h2></td></tr>
184 <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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#aebe2d25607545d31f2b1ace6d60a81da">get</a> ()</td></tr>
185 <tr class="memdesc:aebe2d25607545d31f2b1ace6d60a81da"><td class="mdescLeft"> </td><td class="mdescRight">Access the KernelLibrary singleton. <a href="#aebe2d25607545d31f2b1ace6d60a81da">More...</a><br /></td></tr>
186 <tr class="separator:aebe2d25607545d31f2b1ace6d60a81da"><td class="memSeparator" colspan="2"> </td></tr>
188 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
189 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class. </p>
191 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00192">192</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
192 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
193 <a class="anchor" id="a670869004281695200784de4648a4e1b"></a>
194 <div class="memitem">
195 <div class="memproto">
196 <table class="mlabels">
198 <td class="mlabels-left">
199 <table class="memname">
201 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> </td>
203 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td>
204 <td class="paramname"></td><td>)</td>
209 <td class="mlabels-right">
210 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
213 </div><div class="memdoc">
215 <p>Prevent instances of this class from being copied. </p>
219 <h2 class="groupheader">Member Function Documentation</h2>
220 <a class="anchor" id="a76d1513abb2d86ece6044a4fe2a83f56"></a>
221 <div class="memitem">
222 <div class="memproto">
223 <table class="memname">
225 <td class="memname">void add_built_program </td>
227 <td class="paramtype">const std::string & </td>
228 <td class="paramname"><em>built_program_name</em>, </td>
231 <td class="paramkey"></td>
233 <td class="paramtype">cl::Program </td>
234 <td class="paramname"><em>program</em> </td>
242 </div><div class="memdoc">
244 <p>Add a new built program to the cache. </p>
245 <dl class="params"><dt>Parameters</dt><dd>
246 <table class="params">
247 <tr><td class="paramdir">[in]</td><td class="paramname">built_program_name</td><td>Name of the program </td></tr>
248 <tr><td class="paramdir">[in]</td><td class="paramname">program</td><td>Built program to add to the cache </td></tr>
255 <a class="anchor" id="a0ad613086cc79a2e32d5b87bcefc7488"></a>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="mlabels">
260 <td class="mlabels-left">
261 <table class="memname">
263 <td class="memname">void clear_programs_cache </td>
265 <td class="paramname"></td><td>)</td>
270 <td class="mlabels-right">
271 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
274 </div><div class="memdoc">
276 <p>Clear the library's cache of binary programs. </p>
278 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00313">313</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
280 <p>Referenced by <a class="el" href="_framework_8cpp_source.xhtml#l00508">Framework::run()</a>.</p>
281 <div class="fragment"><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  {</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>  _programs_map.clear();</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  _built_programs_map.clear();</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  }</div></div><!-- fragment -->
284 <a class="anchor" id="a252f5440564c77d68459f2baa978f86a"></a>
285 <div class="memitem">
286 <div class="memproto">
287 <table class="mlabels">
289 <td class="mlabels-left">
290 <table class="memname">
292 <td class="memname">cl::Context& context </td>
294 <td class="paramname"></td><td>)</td>
299 <td class="mlabels-right">
300 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
303 </div><div class="memdoc">
305 <p>Accessor for the associated CL context. </p>
306 <dl class="section return"><dt>Returns</dt><dd>A CL context. </dd></dl>
308 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00275">275</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
310 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00137">CLScheduler::context()</a>.</p>
311 <div class="fragment"><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  {</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordflow">return</span> _context;</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  }</div></div><!-- fragment -->
314 <a class="anchor" id="a07b37240bd1f09e36cf119dced79f9c4"></a>
315 <div class="memitem">
316 <div class="memproto">
317 <table class="memname">
319 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> create_kernel </td>
321 <td class="paramtype">const std::string & </td>
322 <td class="paramname"><em>kernel_name</em>, </td>
325 <td class="paramkey"></td>
327 <td class="paramtype">const StringSet & </td>
328 <td class="paramname"><em>build_options_set</em> = <code>{}</code> </td>
333 <td></td><td> const</td>
336 </div><div class="memdoc">
338 <p>Creates a kernel from the kernel library. </p>
339 <dl class="params"><dt>Parameters</dt><dd>
340 <table class="params">
341 <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>
342 <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>
346 <dl class="section return"><dt>Returns</dt><dd>The created kernel. </dd></dl>
350 <a class="anchor" id="a6dc2398a934f02224ad3743185f27699"></a>
351 <div class="memitem">
352 <div class="memproto">
353 <table class="memname">
355 <td class="memname">cl::NDRange default_ndrange </td>
357 <td class="paramname"></td><td>)</td>
361 </div><div class="memdoc">
363 <p>Return the default NDRange for the device. </p>
367 <a class="anchor" id="aebe2d25607545d31f2b1ace6d60a81da"></a>
368 <div class="memitem">
369 <div class="memproto">
370 <table class="mlabels">
372 <td class="mlabels-left">
373 <table class="memname">
375 <td class="memname">static <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>& get </td>
377 <td class="paramname"></td><td>)</td>
382 <td class="mlabels-right">
383 <span class="mlabels"><span class="mlabel">static</span></span> </td>
386 </div><div class="memdoc">
388 <p>Access the KernelLibrary singleton. </p>
389 <dl class="section return"><dt>Returns</dt><dd>The KernelLibrary instance. </dd></dl>
391 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00137">CLScheduler::context()</a>, <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00071">CLScheduler::default_init()</a>, <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00245">ICLKernel::get_target()</a>, <a class="el" href="main_8cpp_source.xhtml#l00063">main()</a>, <a class="el" href="_framework_8cpp_source.xhtml#l00508">Framework::run()</a>, <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00147">CLScheduler::set_context()</a>, and <a class="el" href="_open_c_l_memory_usage_8cpp_source.xhtml#l00185">OpenCLMemoryUsage::test_measurements()</a>.</p>
395 <a class="anchor" id="a06fff433db9536097242dd9ab2188007"></a>
396 <div class="memitem">
397 <div class="memproto">
398 <table class="mlabels">
400 <td class="mlabels-left">
401 <table class="memname">
403 <td class="memname">const std::map<std::string, cl::Program>& get_built_programs </td>
405 <td class="paramname"></td><td>)</td>
410 <td class="mlabels-right">
411 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
414 </div><div class="memdoc">
416 <p>Access the cache of built OpenCL programs. </p>
418 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00320">320</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
420 <p>Referenced by <a class="el" href="_open_c_l_memory_usage_8cpp_source.xhtml#l00185">OpenCLMemoryUsage::test_measurements()</a>.</p>
421 <div class="fragment"><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  {</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keywordflow">return</span> _built_programs_map;</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  }</div></div><!-- fragment -->
424 <a class="anchor" id="aef78b2e57b5203f8a184465e2da020ef"></a>
425 <div class="memitem">
426 <div class="memproto">
427 <table class="memname">
429 <td class="memname">std::string get_device_version </td>
431 <td class="paramname"></td><td>)</td>
435 </div><div class="memdoc">
437 <p>Return the device version. </p>
438 <dl class="section return"><dt>Returns</dt><dd>The content of CL_DEVICE_VERSION </dd></dl>
442 <a class="anchor" id="ad7395c158d8e31b9af211b9bc1f65a08"></a>
443 <div class="memitem">
444 <div class="memproto">
445 <table class="mlabels">
447 <td class="mlabels-left">
448 <table class="memname">
450 <td class="memname">std::string get_kernel_path </td>
452 <td class="paramname"></td><td>)</td>
457 <td class="mlabels-right">
458 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
461 </div><div class="memdoc">
463 <p>Gets the path that the kernels reside in. </p>
465 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00231">231</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
466 <div class="fragment"><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  {</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">return</span> _kernel_path;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  };</div></div><!-- fragment -->
469 <a class="anchor" id="a44e90c4fa1204a708499ece56d4c82f0"></a>
470 <div class="memitem">
471 <div class="memproto">
472 <table class="memname">
474 <td class="memname">std::string get_program_source </td>
476 <td class="paramtype">const std::string & </td>
477 <td class="paramname"><em>program_name</em></td><td>)</td>
481 </div><div class="memdoc">
483 <p>Gets the source of the selected program. </p>
484 <dl class="params"><dt>Parameters</dt><dd>
485 <table class="params">
486 <tr><td class="paramdir">[in]</td><td class="paramname">program_name</td><td><a class="el" href="classarm__compute_1_1_program.xhtml" title="Program class. ">Program</a> name.</td></tr>
490 <dl class="section return"><dt>Returns</dt><dd>Source of the selected program. </dd></dl>
494 <a class="anchor" id="af353532ea782387df6bcb6d01894f4ae"></a>
495 <div class="memitem">
496 <div class="memproto">
497 <table class="mlabels">
499 <td class="mlabels-left">
500 <table class="memname">
502 <td class="memname">void init </td>
504 <td class="paramtype">std::string </td>
505 <td class="paramname"><em>kernel_path</em> = <code>"."</code>, </td>
508 <td class="paramkey"></td>
510 <td class="paramtype">cl::Context </td>
511 <td class="paramname"><em>context</em> = <code>cl::Context::getDefault()</code>, </td>
514 <td class="paramkey"></td>
516 <td class="paramtype">cl::Device </td>
517 <td class="paramname"><em>device</em> = <code>cl::Device::getDefault()</code> </td>
526 <td class="mlabels-right">
527 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
530 </div><div class="memdoc">
532 <p>Initialises the kernel library. </p>
533 <dl class="params"><dt>Parameters</dt><dd>
534 <table class="params">
535 <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>
536 <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>(Optional) CL context used to create programs. </td></tr>
537 <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>(Optional) CL device for which the programs are created. </td></tr>
542 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00215">215</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
544 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00071">CLScheduler::default_init()</a>.</p>
545 <div class="fragment"><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  {</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  _kernel_path = std::move(kernel_path);</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  _device = std::move(device);</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  }</div><div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a252f5440564c77d68459f2baa978f86a"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">arm_compute::CLKernelLibrary::context</a></div><div class="ttdeci">cl::Context & context()</div><div class="ttdoc">Accessor for the associated CL context. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_kernel_library_8h_source.xhtml#l00275">CLKernelLibrary.h:275</a></div></div>
546 </div><!-- fragment -->
549 <a class="anchor" id="ab04a95a810e685a1207c7f3443668261"></a>
550 <div class="memitem">
551 <div class="memproto">
552 <table class="memname">
554 <td class="memname">size_t max_local_workgroup_size </td>
556 <td class="paramtype">const cl::Kernel & </td>
557 <td class="paramname"><em>kernel</em></td><td>)</td>
561 </div><div class="memdoc">
563 <p>Find the maximum number of local work items in a workgroup can be supported for the kernel. </p>
567 <a class="anchor" id="a54fb81956f9fb1c25b279e34e1e7d966"></a>
568 <div class="memitem">
569 <div class="memproto">
570 <table class="mlabels">
572 <td class="mlabels-left">
573 <table class="memname">
575 <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>& operator= </td>
577 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> & </td>
578 <td class="paramname"></td><td>)</td>
583 <td class="mlabels-right">
584 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
587 </div><div class="memdoc">
589 <p>Prevent instances of this class from being copied. </p>
593 <a class="anchor" id="a293edc1bbcbddffb7228ac97917ed107"></a>
594 <div class="memitem">
595 <div class="memproto">
596 <table class="mlabels">
598 <td class="mlabels-left">
599 <table class="memname">
601 <td class="memname">void set_context </td>
603 <td class="paramtype">cl::Context </td>
604 <td class="paramname"><em>context</em></td><td>)</td>
609 <td class="mlabels-right">
610 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
613 </div><div class="memdoc">
615 <p>Sets the CL context used to create programs. </p>
616 <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>
617 <dl class="params"><dt>Parameters</dt><dd>
618 <table class="params">
619 <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr>
624 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00249">249</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
626 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00147">CLScheduler::set_context()</a>.</p>
627 <div class="fragment"><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  {</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  _context = std::move(<a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">context</a>);</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keywordflow">if</span>(_context.get() == <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  {</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  _device = cl::Device();</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  }</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  {</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keyword">const</span> <span class="keyword">auto</span> cl_devices = _context.getInfo<CL_CONTEXT_DEVICES>();</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordflow">if</span>(cl_devices.empty())</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  {</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  _device = cl::Device();</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  }</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  {</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  _device = cl_devices[0];</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  }</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  }</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  }</div><div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a252f5440564c77d68459f2baa978f86a"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a252f5440564c77d68459f2baa978f86a">arm_compute::CLKernelLibrary::context</a></div><div class="ttdeci">cl::Context & context()</div><div class="ttdoc">Accessor for the associated CL context. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_kernel_library_8h_source.xhtml#l00275">CLKernelLibrary.h:275</a></div></div>
628 </div><!-- fragment -->
631 <a class="anchor" id="a5a6865d04c8d3348860f3cb8100fdb97"></a>
632 <div class="memitem">
633 <div class="memproto">
634 <table class="mlabels">
636 <td class="mlabels-left">
637 <table class="memname">
639 <td class="memname">void set_device </td>
641 <td class="paramtype">cl::Device </td>
642 <td class="paramname"><em>device</em></td><td>)</td>
647 <td class="mlabels-right">
648 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
651 </div><div class="memdoc">
653 <p>Sets the CL device for which the programs are created. </p>
654 <dl class="params"><dt>Parameters</dt><dd>
655 <table class="params">
656 <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>A CL device. </td></tr>
661 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00284">284</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
663 <p>References <a class="el" href="arm__compute_2core_2_helpers_8h_source.xhtml#l00086">arm_compute::create_kernel()</a>.</p>
664 <div class="fragment"><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  {</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  _device = std::move(device);</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  }</div></div><!-- fragment -->
667 <a class="anchor" id="a66a558a56f5d0dcd6305c405ebc38cc2"></a>
668 <div class="memitem">
669 <div class="memproto">
670 <table class="mlabels">
672 <td class="mlabels-left">
673 <table class="memname">
675 <td class="memname">void set_kernel_path </td>
677 <td class="paramtype">const std::string & </td>
678 <td class="paramname"><em>kernel_path</em></td><td>)</td>
683 <td class="mlabels-right">
684 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
687 </div><div class="memdoc">
689 <p>Sets the path that the kernels reside in. </p>
690 <dl class="params"><dt>Parameters</dt><dd>
691 <table class="params">
692 <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>Path of the kernel. </td></tr>
697 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00225">225</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
698 <div class="fragment"><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  {</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  _kernel_path = kernel_path;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  };</div></div><!-- fragment -->
701 <hr/>The documentation for this class was generated from the following file:<ul>
702 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
704 </div><!-- contents -->
705 </div><!-- doc-content -->
706 <!-- start footer part -->
707 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
709 <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>
710 <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
711 <a href="http://www.doxygen.org/index.html">
712 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>