documentation/classarm__compute_1_1_kernel.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>Compute Library: Kernel 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">Compute Library
  43    &#160;<span id="projectnumber">18.02</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="pages.xhtml"><span>Related&#160;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&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  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>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_kernel.xhtml','');});
 101 </script>
 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)">
 108 </div>
 109
 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">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">Kernel Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class.
 126  <a href="classarm__compute_1_1_kernel.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:a4d7fb588e6d609d95d8cd491492ed420"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a4d7fb588e6d609d95d8cd491492ed420">Kernel</a> ()</td></tr>
 133 <tr class="memdesc:a4d7fb588e6d609d95d8cd491492ed420"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a4d7fb588e6d609d95d8cd491492ed420">More...</a><br /></td></tr>
 134 <tr class="separator:a4d7fb588e6d609d95d8cd491492ed420"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a83af2718294984c1053223a928164a7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a83af2718294984c1053223a928164a7b">Kernel</a> (const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;)=default</td></tr>
 136 <tr class="memdesc:a83af2718294984c1053223a928164a7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Copy Constructor.  <a href="#a83af2718294984c1053223a928164a7b">More...</a><br /></td></tr>
 137 <tr class="separator:a83af2718294984c1053223a928164a7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a1d1e423ba4b26fdf460aa45bbc4457d1">Kernel</a> (<a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;)=default</td></tr>
 139 <tr class="memdesc:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Move Constructor.  <a href="#a1d1e423ba4b26fdf460aa45bbc4457d1">More...</a><br /></td></tr>
 140 <tr class="separator:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a9729d318da4230e664a923d7419ddf10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a9729d318da4230e664a923d7419ddf10">operator=</a> (const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;)=default</td></tr>
 142 <tr class="memdesc:a9729d318da4230e664a923d7419ddf10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator.  <a href="#a9729d318da4230e664a923d7419ddf10">More...</a><br /></td></tr>
 143 <tr class="separator:a9729d318da4230e664a923d7419ddf10"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a22bb0cebcc049eac830795a517212f75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a22bb0cebcc049eac830795a517212f75">operator=</a> (<a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;)=default</td></tr>
 145 <tr class="memdesc:a22bb0cebcc049eac830795a517212f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator.  <a href="#a22bb0cebcc049eac830795a517212f75">More...</a><br /></td></tr>
 146 <tr class="separator:a22bb0cebcc049eac830795a517212f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a8b2bcac315357d36294d68948e51b925"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a8b2bcac315357d36294d68948e51b925">Kernel</a> (std::string <a class="el" href="classarm__compute_1_1_kernel.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, const cl::Program &amp;program)</td></tr>
 148 <tr class="memdesc:a8b2bcac315357d36294d68948e51b925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a8b2bcac315357d36294d68948e51b925">More...</a><br /></td></tr>
 149 <tr class="separator:a8b2bcac315357d36294d68948e51b925"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
 151 <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns kernel name.  <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07">More...</a><br /></td></tr>
 152 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#ad3a94f90bef30dbf3529c617cb8b2c53">operator cl::Kernel</a> () const </td></tr>
 154 <tr class="memdesc:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns OpenCL kernel.  <a href="#ad3a94f90bef30dbf3529c617cb8b2c53">More...</a><br /></td></tr>
 155 <tr class="separator:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table>
 157 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 158 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class. </p>
 159
 160 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00144">144</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 161 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 162 <a class="anchor" id="a4d7fb588e6d609d95d8cd491492ed420"></a>
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 168           <td>(</td>
 169           <td class="paramname"></td><td>)</td>
 170           <td></td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>Default Constructor. </p>
 176
 177 </div>
 178 </div>
 179 <a class="anchor" id="a83af2718294984c1053223a928164a7b"></a>
 180 <div class="memitem">
 181 <div class="memproto">
 182 <table class="mlabels">
 183   <tr>
 184   <td class="mlabels-left">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 188           <td>(</td>
 189           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td>
 190           <td class="paramname"></td><td>)</td>
 191           <td></td>
 192         </tr>
 193       </table>
 194   </td>
 195   <td class="mlabels-right">
 196 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 197   </tr>
 198 </table>
 199 </div><div class="memdoc">
 200
 201 <p>Default Copy Constructor. </p>
 202
 203 </div>
 204 </div>
 205 <a class="anchor" id="a1d1e423ba4b26fdf460aa45bbc4457d1"></a>
 206 <div class="memitem">
 207 <div class="memproto">
 208 <table class="mlabels">
 209   <tr>
 210   <td class="mlabels-left">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 214           <td>(</td>
 215           <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;&#160;</td>
 216           <td class="paramname"></td><td>)</td>
 217           <td></td>
 218         </tr>
 219       </table>
 220   </td>
 221   <td class="mlabels-right">
 222 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 223   </tr>
 224 </table>
 225 </div><div class="memdoc">
 226
 227 <p>Default Move Constructor. </p>
 228
 229 </div>
 230 </div>
 231 <a class="anchor" id="a8b2bcac315357d36294d68948e51b925"></a>
 232 <div class="memitem">
 233 <div class="memproto">
 234       <table class="memname">
 235         <tr>
 236           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 237           <td>(</td>
 238           <td class="paramtype">std::string&#160;</td>
 239           <td class="paramname"><em>name</em>, </td>
 240         </tr>
 241         <tr>
 242           <td class="paramkey"></td>
 243           <td></td>
 244           <td class="paramtype">const cl::Program &amp;&#160;</td>
 245           <td class="paramname"><em>program</em>&#160;</td>
 246         </tr>
 247         <tr>
 248           <td></td>
 249           <td>)</td>
 250           <td></td><td></td>
 251         </tr>
 252       </table>
 253 </div><div class="memdoc">
 254
 255 <p>Constructor. </p>
 256 <dl class="params"><dt>Parameters</dt><dd>
 257   <table class="params">
 258     <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name. </td></tr>
 259     <tr><td class="paramdir">[in]</td><td class="paramname">program</td><td>Built program. </td></tr>
 260   </table>
 261   </dd>
 262 </dl>
 263
 264 </div>
 265 </div>
 266 <h2 class="groupheader">Member Function Documentation</h2>
 267 <a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a>
 268 <div class="memitem">
 269 <div class="memproto">
 270 <table class="mlabels">
 271   <tr>
 272   <td class="mlabels-left">
 273       <table class="memname">
 274         <tr>
 275           <td class="memname">std::string name </td>
 276           <td>(</td>
 277           <td class="paramname"></td><td>)</td>
 278           <td> const</td>
 279         </tr>
 280       </table>
 281   </td>
 282   <td class="mlabels-right">
 283 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 284   </tr>
 285 </table>
 286 </div><div class="memdoc">
 287
 288 <p>Returns kernel name. </p>
 289 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a>'s name. </dd></dl>
 290
 291 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00167">167</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
 292 <div class="fragment"><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    {</div><div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;        <span class="keywordflow">return</span> _name;</div><div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    }</div></div><!-- fragment -->
 293 </div>
 294 </div>
 295 <a class="anchor" id="ad3a94f90bef30dbf3529c617cb8b2c53"></a>
 296 <div class="memitem">
 297 <div class="memproto">
 298 <table class="mlabels">
 299   <tr>
 300   <td class="mlabels-left">
 301       <table class="memname">
 302         <tr>
 303           <td class="memname">operator cl::Kernel </td>
 304           <td>(</td>
 305           <td class="paramname"></td><td>)</td>
 306           <td> const</td>
 307         </tr>
 308       </table>
 309   </td>
 310   <td class="mlabels-right">
 311 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 312   </tr>
 313 </table>
 314 </div><div class="memdoc">
 315
 316 <p>Returns OpenCL kernel. </p>
 317 <dl class="section return"><dt>Returns</dt><dd>OpenCL <a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a>. </dd></dl>
 318
 319 <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>
 320 <div class="fragment"><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    {</div><div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;        <span class="keywordflow">return</span> _kernel;</div><div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    }</div></div><!-- fragment -->
 321 </div>
 322 </div>
 323 <a class="anchor" id="a9729d318da4230e664a923d7419ddf10"></a>
 324 <div class="memitem">
 325 <div class="memproto">
 326 <table class="mlabels">
 327   <tr>
 328   <td class="mlabels-left">
 329       <table class="memname">
 330         <tr>
 331           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>&amp; operator= </td>
 332           <td>(</td>
 333           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td>
 334           <td class="paramname"></td><td>)</td>
 335           <td></td>
 336         </tr>
 337       </table>
 338   </td>
 339   <td class="mlabels-right">
 340 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 341   </tr>
 342 </table>
 343 </div><div class="memdoc">
 344
 345 <p>Default copy assignment operator. </p>
 346
 347 </div>
 348 </div>
 349 <a class="anchor" id="a22bb0cebcc049eac830795a517212f75"></a>
 350 <div class="memitem">
 351 <div class="memproto">
 352 <table class="mlabels">
 353   <tr>
 354   <td class="mlabels-left">
 355       <table class="memname">
 356         <tr>
 357           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>&amp; operator= </td>
 358           <td>(</td>
 359           <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;&#160;</td>
 360           <td class="paramname"></td><td>)</td>
 361           <td></td>
 362         </tr>
 363       </table>
 364   </td>
 365   <td class="mlabels-right">
 366 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 367   </tr>
 368 </table>
 369 </div><div class="memdoc">
 370
 371 <p>Default move assignment operator. </p>
 372
 373 </div>
 374 </div>
 375 <hr/>The documentation for this class was generated from the following file:<ul>
 376 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
 377 </ul>
 378 </div><!-- contents -->
 379 </div><!-- doc-content -->
 380 <!-- start footer part -->
 381 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 382   <ul>
 383     <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_kernel.xhtml">Kernel</a></li>
 384     <li class="footer">Generated on Thu Feb 22 2018 15:45:24 for Compute Library by
 385     <a href="http://www.doxygen.org/index.html">
 386     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 387   </ul>
 388 </div>
 389 </body>
 390 </html>