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.6"/>
   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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_kernel_library.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a> &#124;
 118 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">CLKernelLibrary Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class.
 125  <a href="classarm__compute_1_1_c_l_kernel_library.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 130 Public Member Functions</h2></td></tr>
 131 <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>
 132 <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>
 133 <tr class="separator:a670869004281695200784de4648a4e1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <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>
 135 <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>
 136 <tr class="separator:a54fb81956f9fb1c25b279e34e1e7d966"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <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>
 138 <tr class="memdesc:af353532ea782387df6bcb6d01894f4ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises the kernel library.  <a href="#af353532ea782387df6bcb6d01894f4ae">More...</a><br/></td></tr>
 139 <tr class="separator:af353532ea782387df6bcb6d01894f4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:a66a558a56f5d0dcd6305c405ebc38cc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memItemLeft" align="right" valign="top">std::string&#160;</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>
 144 <tr class="memdesc:ad7395c158d8e31b9af211b9bc1f65a08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the path that the kernels reside in.  <a href="#ad7395c158d8e31b9af211b9bc1f65a08">More...</a><br/></td></tr>
 145 <tr class="separator:ad7395c158d8e31b9af211b9bc1f65a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a44e90c4fa1204a708499ece56d4c82f0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</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 &amp;program_name)</td></tr>
 147 <tr class="memdesc:a44e90c4fa1204a708499ece56d4c82f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the source of the selected program.  <a href="#a44e90c4fa1204a708499ece56d4c82f0">More...</a><br/></td></tr>
 148 <tr class="separator:a44e90c4fa1204a708499ece56d4c82f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <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>
 151 <tr class="separator:a293edc1bbcbddffb7228ac97917ed107"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <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>
 153 <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>
 154 <tr class="separator:a5a6865d04c8d3348860f3cb8100fdb97"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <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>
 156 <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>
 157 <tr class="separator:a07b37240bd1f09e36cf119dced79f9c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <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>
 159 <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>
 160 <tr class="separator:a7c0b2aa80e920344936e8e7dbaa73e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <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>
 162 <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>
 163 <tr class="separator:a389a543ae040ca6bf6b57fd6215f154b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a> ()</td></tr>
 165 <tr class="memdesc:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the maximum number of local work items in a workgroup can be supported by the device.  <a href="#a69db47516e8f80b6c29c9c3fd5da1e60">More...</a><br/></td></tr>
 166 <tr class="separator:a69db47516e8f80b6c29c9c3fd5da1e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:a5a02c8fbe0324dbb3703feb09cc4da8d"><td class="memItemLeft" align="right" valign="top">cl::NDRange&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a5a02c8fbe0324dbb3703feb09cc4da8d">default_ndrange</a> ()</td></tr>
 168 <tr class="memdesc:a5a02c8fbe0324dbb3703feb09cc4da8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the default NDRange that is suitable for the device.  <a href="#a5a02c8fbe0324dbb3703feb09cc4da8d">More...</a><br/></td></tr>
 169 <tr class="separator:a5a02c8fbe0324dbb3703feb09cc4da8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 </table><table class="memberdecls">
 171 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 172 Static Public Member Functions</h2></td></tr>
 173 <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>
 174 <tr class="memdesc:aebe2d25607545d31f2b1ace6d60a81da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the KernelLibrary singleton.  <a href="#aebe2d25607545d31f2b1ace6d60a81da">More...</a><br/></td></tr>
 175 <tr class="separator:aebe2d25607545d31f2b1ace6d60a81da"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 </table>
 177 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 178 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml" title="CLKernelLibrary class. ">CLKernelLibrary</a> class. </p>
 179
 180 <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>
 181 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 182 <a class="anchor" id="a670869004281695200784de4648a4e1b"></a>
 183 <div class="memitem">
 184 <div class="memproto">
 185 <table class="mlabels">
 186   <tr>
 187   <td class="mlabels-left">
 188       <table class="memname">
 189         <tr>
 190           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> </td>
 191           <td>(</td>
 192           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td>
 193           <td class="paramname"></td><td>)</td>
 194           <td></td>
 195         </tr>
 196       </table>
 197   </td>
 198   <td class="mlabels-right">
 199 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 200   </tr>
 201 </table>
 202 </div><div class="memdoc">
 203
 204 <p>Prevent instances of this class from being copied. </p>
 205
 206 </div>
 207 </div>
 208 <h2 class="groupheader">Member Function Documentation</h2>
 209 <a class="anchor" id="a07b37240bd1f09e36cf119dced79f9c4"></a>
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> create_kernel </td>
 215           <td>(</td>
 216           <td class="paramtype">const std::string &amp;&#160;</td>
 217           <td class="paramname"><em>kernel_name</em>, </td>
 218         </tr>
 219         <tr>
 220           <td class="paramkey"></td>
 221           <td></td>
 222           <td class="paramtype">const StringSet &amp;&#160;</td>
 223           <td class="paramname"><em>build_options_set</em> = <code>{}</code>&#160;</td>
 224         </tr>
 225         <tr>
 226           <td></td>
 227           <td>)</td>
 228           <td></td><td> const</td>
 229         </tr>
 230       </table>
 231 </div><div class="memdoc">
 232
 233 <p>Creates a kernel from the kernel library. </p>
 234 <dl class="params"><dt>Parameters</dt><dd>
 235   <table class="params">
 236     <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>
 237     <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>
 238   </table>
 239   </dd>
 240 </dl>
 241 <dl class="section return"><dt>Returns</dt><dd>The created kernel. </dd></dl>
 242
 243 </div>
 244 </div>
 245 <a class="anchor" id="a5a02c8fbe0324dbb3703feb09cc4da8d"></a>
 246 <div class="memitem">
 247 <div class="memproto">
 248       <table class="memname">
 249         <tr>
 250           <td class="memname">cl::NDRange default_ndrange </td>
 251           <td>(</td>
 252           <td class="paramname"></td><td>)</td>
 253           <td></td>
 254         </tr>
 255       </table>
 256 </div><div class="memdoc">
 257
 258 <p>Return the default NDRange that is suitable for the device. </p>
 259
 260 </div>
 261 </div>
 262 <a class="anchor" id="aebe2d25607545d31f2b1ace6d60a81da"></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">static <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>&amp; get </td>
 271           <td>(</td>
 272           <td class="paramname"></td><td>)</td>
 273           <td></td>
 274         </tr>
 275       </table>
 276   </td>
 277   <td class="mlabels-right">
 278 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 279   </tr>
 280 </table>
 281 </div><div class="memdoc">
 282
 283 <p>Access the KernelLibrary singleton. </p>
 284 <dl class="section return"><dt>Returns</dt><dd>The KernelLibrary instance. </dd></dl>
 285
 286 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00061">CLScheduler::default_init()</a>.</p>
 287
 288 </div>
 289 </div>
 290 <a class="anchor" id="ad7395c158d8e31b9af211b9bc1f65a08"></a>
 291 <div class="memitem">
 292 <div class="memproto">
 293 <table class="mlabels">
 294   <tr>
 295   <td class="mlabels-left">
 296       <table class="memname">
 297         <tr>
 298           <td class="memname">std::string get_kernel_path </td>
 299           <td>(</td>
 300           <td class="paramname"></td><td>)</td>
 301           <td></td>
 302         </tr>
 303       </table>
 304   </td>
 305   <td class="mlabels-right">
 306 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 307   </tr>
 308 </table>
 309 </div><div class="memdoc">
 310
 311 <p>Gets the path that the kernels reside in. </p>
 312
 313 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00181">181</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 314 <div class="fragment"><div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    {</div>
 315 <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;        <span class="keywordflow">return</span> _kernel_path;</div>
 316 <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    };</div>
 317 </div><!-- fragment -->
 318 </div>
 319 </div>
 320 <a class="anchor" id="a44e90c4fa1204a708499ece56d4c82f0"></a>
 321 <div class="memitem">
 322 <div class="memproto">
 323       <table class="memname">
 324         <tr>
 325           <td class="memname">std::string get_program_source </td>
 326           <td>(</td>
 327           <td class="paramtype">const std::string &amp;&#160;</td>
 328           <td class="paramname"><em>program_name</em></td><td>)</td>
 329           <td></td>
 330         </tr>
 331       </table>
 332 </div><div class="memdoc">
 333
 334 <p>Gets the source of the selected program. </p>
 335 <dl class="params"><dt>Parameters</dt><dd>
 336   <table class="params">
 337     <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>
 338   </table>
 339   </dd>
 340 </dl>
 341
 342 </div>
 343 </div>
 344 <a class="anchor" id="af353532ea782387df6bcb6d01894f4ae"></a>
 345 <div class="memitem">
 346 <div class="memproto">
 347 <table class="mlabels">
 348   <tr>
 349   <td class="mlabels-left">
 350       <table class="memname">
 351         <tr>
 352           <td class="memname">void init </td>
 353           <td>(</td>
 354           <td class="paramtype">std::string&#160;</td>
 355           <td class="paramname"><em>kernel_path</em> = <code>&quot;.&quot;</code>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype">cl::Context&#160;</td>
 361           <td class="paramname"><em>context</em> = <code>cl::Context::getDefault()</code>, </td>
 362         </tr>
 363         <tr>
 364           <td class="paramkey"></td>
 365           <td></td>
 366           <td class="paramtype">cl::Device&#160;</td>
 367           <td class="paramname"><em>device</em> = <code>cl::Device::getDefault()</code>&#160;</td>
 368         </tr>
 369         <tr>
 370           <td></td>
 371           <td>)</td>
 372           <td></td><td></td>
 373         </tr>
 374       </table>
 375   </td>
 376   <td class="mlabels-right">
 377 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 378   </tr>
 379 </table>
 380 </div><div class="memdoc">
 381
 382 <p>Initialises the kernel library. </p>
 383 <dl class="params"><dt>Parameters</dt><dd>
 384   <table class="params">
 385     <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>
 386     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>(Optional) CL context used to create programs. </td></tr>
 387     <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>(Optional) CL device for which the programs are created. </td></tr>
 388   </table>
 389   </dd>
 390 </dl>
 391
 392 <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>
 393
 394 <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p>
 395
 396 <p>Referenced by <a class="el" href="_c_l_scheduler_8h_source.xhtml#l00061">CLScheduler::default_init()</a>.</p>
 397 <div class="fragment"><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    {</div>
 398 <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;        _kernel_path        = std::move(kernel_path);</div>
 399 <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;        _context            = std::move(context);</div>
 400 <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;        _device             = std::move(device);</div>
 401 <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;        _max_workgroup_size = 0;</div>
 402 <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;        <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div>
 403 <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    }</div>
 404 <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div>
 405 </div><!-- fragment -->
 406 </div>
 407 </div>
 408 <a class="anchor" id="a389a543ae040ca6bf6b57fd6215f154b"></a>
 409 <div class="memitem">
 410 <div class="memproto">
 411       <table class="memname">
 412         <tr>
 413           <td class="memname">void load_binary </td>
 414           <td>(</td>
 415           <td class="paramname"></td><td>)</td>
 416           <td></td>
 417         </tr>
 418       </table>
 419 </div><div class="memdoc">
 420
 421 <p>Load serialized binary with all the programs. </p>
 422
 423 </div>
 424 </div>
 425 <a class="anchor" id="a69db47516e8f80b6c29c9c3fd5da1e60"></a>
 426 <div class="memitem">
 427 <div class="memproto">
 428       <table class="memname">
 429         <tr>
 430           <td class="memname">size_t max_local_workgroup_size </td>
 431           <td>(</td>
 432           <td class="paramname"></td><td>)</td>
 433           <td></td>
 434         </tr>
 435       </table>
 436 </div><div class="memdoc">
 437
 438 <p>Find the maximum number of local work items in a workgroup can be supported by the device. </p>
 439
 440 <p>Referenced by <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00163">CLKernelLibrary::init()</a>, <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00197">CLKernelLibrary::set_context()</a>, and <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00219">CLKernelLibrary::set_device()</a>.</p>
 441
 442 </div>
 443 </div>
 444 <a class="anchor" id="a54fb81956f9fb1c25b279e34e1e7d966"></a>
 445 <div class="memitem">
 446 <div class="memproto">
 447 <table class="mlabels">
 448   <tr>
 449   <td class="mlabels-left">
 450       <table class="memname">
 451         <tr>
 452           <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a>&amp; operator= </td>
 453           <td>(</td>
 454           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml">CLKernelLibrary</a> &amp;&#160;</td>
 455           <td class="paramname"></td><td>)</td>
 456           <td></td>
 457         </tr>
 458       </table>
 459   </td>
 460   <td class="mlabels-right">
 461 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 462   </tr>
 463 </table>
 464 </div><div class="memdoc">
 465
 466 <p>Prevent instances of this class from being copied. </p>
 467
 468 </div>
 469 </div>
 470 <a class="anchor" id="a7c0b2aa80e920344936e8e7dbaa73e43"></a>
 471 <div class="memitem">
 472 <div class="memproto">
 473       <table class="memname">
 474         <tr>
 475           <td class="memname">void save_binary </td>
 476           <td>(</td>
 477           <td class="paramname"></td><td>)</td>
 478           <td></td>
 479         </tr>
 480       </table>
 481 </div><div class="memdoc">
 482
 483 <p>Serializes and saves programs to a binary. </p>
 484
 485 </div>
 486 </div>
 487 <a class="anchor" id="a293edc1bbcbddffb7228ac97917ed107"></a>
 488 <div class="memitem">
 489 <div class="memproto">
 490 <table class="mlabels">
 491   <tr>
 492   <td class="mlabels-left">
 493       <table class="memname">
 494         <tr>
 495           <td class="memname">void set_context </td>
 496           <td>(</td>
 497           <td class="paramtype">cl::Context&#160;</td>
 498           <td class="paramname"><em>context</em></td><td>)</td>
 499           <td></td>
 500         </tr>
 501       </table>
 502   </td>
 503   <td class="mlabels-right">
 504 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 505   </tr>
 506 </table>
 507 </div><div class="memdoc">
 508
 509 <p>Sets the CL context used to create programs. </p>
 510 <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>
 511 <dl class="params"><dt>Parameters</dt><dd>
 512   <table class="params">
 513     <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>A CL context. </td></tr>
 514   </table>
 515   </dd>
 516 </dl>
 517
 518 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00197">197</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 519
 520 <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p>
 521 <div class="fragment"><div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    {</div>
 522 <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;        _context = std::move(context);</div>
 523 <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div>
 524 <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;        <span class="keyword">const</span> <span class="keyword">auto</span> cl_devices = _context.getInfo&lt;CL_CONTEXT_DEVICES&gt;();</div>
 525 <div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;</div>
 526 <div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;        <span class="keywordflow">if</span>(cl_devices.empty())</div>
 527 <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;        {</div>
 528 <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;            _device = cl::Device();</div>
 529 <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;        }</div>
 530 <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;        <span class="keywordflow">else</span></div>
 531 <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;        {</div>
 532 <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;            _device = cl_devices[0];</div>
 533 <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;        }</div>
 534 <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;</div>
 535 <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;        _max_workgroup_size = 0;</div>
 536 <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;        <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div>
 537 <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;    };</div>
 538 <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div>
 539 </div><!-- fragment -->
 540 </div>
 541 </div>
 542 <a class="anchor" id="a5a6865d04c8d3348860f3cb8100fdb97"></a>
 543 <div class="memitem">
 544 <div class="memproto">
 545 <table class="mlabels">
 546   <tr>
 547   <td class="mlabels-left">
 548       <table class="memname">
 549         <tr>
 550           <td class="memname">void set_device </td>
 551           <td>(</td>
 552           <td class="paramtype">cl::Device&#160;</td>
 553           <td class="paramname"><em>device</em></td><td>)</td>
 554           <td></td>
 555         </tr>
 556       </table>
 557   </td>
 558   <td class="mlabels-right">
 559 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 560   </tr>
 561 </table>
 562 </div><div class="memdoc">
 563
 564 <p>Sets the CL device for which the programs are created. </p>
 565 <dl class="params"><dt>Parameters</dt><dd>
 566   <table class="params">
 567     <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>A CL device. </td></tr>
 568   </table>
 569   </dd>
 570 </dl>
 571
 572 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00219">219</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 573
 574 <p>References <a class="el" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">CLKernelLibrary::max_local_workgroup_size()</a>.</p>
 575 <div class="fragment"><div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    {</div>
 576 <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;        _device             = std::move(device);</div>
 577 <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;        _max_workgroup_size = 0;</div>
 578 <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;        <a class="code" href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">max_local_workgroup_size</a>();</div>
 579 <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;    };</div>
 580 <div class="ttc" id="classarm__compute_1_1_c_l_kernel_library_xhtml_a69db47516e8f80b6c29c9c3fd5da1e60"><div class="ttname"><a href="classarm__compute_1_1_c_l_kernel_library.xhtml#a69db47516e8f80b6c29c9c3fd5da1e60">arm_compute::CLKernelLibrary::max_local_workgroup_size</a></div><div class="ttdeci">size_t max_local_workgroup_size()</div><div class="ttdoc">Find the maximum number of local work items in a workgroup can be supported by the device...</div></div>
 581 </div><!-- fragment -->
 582 </div>
 583 </div>
 584 <a class="anchor" id="a66a558a56f5d0dcd6305c405ebc38cc2"></a>
 585 <div class="memitem">
 586 <div class="memproto">
 587 <table class="mlabels">
 588   <tr>
 589   <td class="mlabels-left">
 590       <table class="memname">
 591         <tr>
 592           <td class="memname">void set_kernel_path </td>
 593           <td>(</td>
 594           <td class="paramtype">const std::string &amp;&#160;</td>
 595           <td class="paramname"><em>kernel_path</em></td><td>)</td>
 596           <td></td>
 597         </tr>
 598       </table>
 599   </td>
 600   <td class="mlabels-right">
 601 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 602   </tr>
 603 </table>
 604 </div><div class="memdoc">
 605
 606 <p>Sets the path that the kernels reside in. </p>
 607 <dl class="params"><dt>Parameters</dt><dd>
 608   <table class="params">
 609     <tr><td class="paramdir">[in]</td><td class="paramname">kernel_path</td><td>Path of the kernel. </td></tr>
 610   </table>
 611   </dd>
 612 </dl>
 613
 614 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00175">175</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 615 <div class="fragment"><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    {</div>
 616 <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;        _kernel_path = kernel_path;</div>
 617 <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    };</div>
 618 </div><!-- fragment -->
 619 </div>
 620 </div>
 621 <hr/>The documentation for this class was generated from the following file:<ul>
 622 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
 623 </ul>
 624 </div><!-- contents -->
 625 </div><!-- doc-content -->
 626 <!-- start footer part -->
 627 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 628   <ul>
 629     <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>
 630     <li class="footer">Generated on Thu Sep 28 2017 14:37:55 for Compute Library by
 631     <a href="http://www.doxygen.org/index.html">
 632     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 633   </ul>
 634 </div>
 635 </body>
 636 </html>