documentation/classarm__compute_1_1_i_c_l_simple_function.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: ICLSimpleFunction 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.05</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_i_c_l_simple_function.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">ICLSimpleFunction Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic interface for functions which have a single OpenCL kernel.
 126  <a href="classarm__compute_1_1_i_c_l_simple_function.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_i_c_l_simple_function_8h_source.xhtml">ICLSimpleFunction.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for ICLSimpleFunction:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_simple_function__coll__graph.svg" width="150" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:aa8149af857c4bface8ad712e418a63f1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml#aa8149af857c4bface8ad712e418a63f1">ICLSimpleFunction</a> ()</td></tr>
 139 <tr class="memdesc:aa8149af857c4bface8ad712e418a63f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aa8149af857c4bface8ad712e418a63f1">More...</a><br /></td></tr>
 140 <tr class="separator:aa8149af857c4bface8ad712e418a63f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ab5fd6e96c07aaaed2747c7e16ed5951e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml#ab5fd6e96c07aaaed2747c7e16ed5951e">run</a> () overridefinal</td></tr>
 142 <tr class="memdesc:ab5fd6e96c07aaaed2747c7e16ed5951e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ab5fd6e96c07aaaed2747c7e16ed5951e">More...</a><br /></td></tr>
 143 <tr class="separator:ab5fd6e96c07aaaed2747c7e16ed5951e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
 145 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
 146 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
 147 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">prepare</a> ()</td></tr>
 149 <tr class="memdesc:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the function for executing.  <a href="#a820f7291c24155a2980512fae45aac26">More...</a><br /></td></tr>
 150 <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 </table>
 152 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 153 <div class="textblock"><p>Basic interface for functions which have a single OpenCL kernel. </p>
 154
 155 <p>Definition at line <a class="el" href="_i_c_l_simple_function_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_i_c_l_simple_function_8h_source.xhtml">ICLSimpleFunction.h</a>.</p>
 156 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 157 <a class="anchor" id="aa8149af857c4bface8ad712e418a63f1"></a>
 158 <div class="memitem">
 159 <div class="memproto">
 160       <table class="memname">
 161         <tr>
 162           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml">ICLSimpleFunction</a> </td>
 163           <td>(</td>
 164           <td class="paramname"></td><td>)</td>
 165           <td></td>
 166         </tr>
 167       </table>
 168 </div><div class="memdoc">
 169
 170 <p>Default constructor. </p>
 171
 172 </div>
 173 </div>
 174 <h2 class="groupheader">Member Function Documentation</h2>
 175 <a class="anchor" id="ab5fd6e96c07aaaed2747c7e16ed5951e"></a>
 176 <div class="memitem">
 177 <div class="memproto">
 178 <table class="mlabels">
 179   <tr>
 180   <td class="mlabels-left">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">void run </td>
 184           <td>(</td>
 185           <td class="paramname"></td><td>)</td>
 186           <td></td>
 187         </tr>
 188       </table>
 189   </td>
 190   <td class="mlabels-right">
 191 <span class="mlabels"><span class="mlabel">final</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 192   </tr>
 193 </table>
 194 </div><div class="memdoc">
 195
 196 <p>Run the kernels contained in the function. </p>
 197 <p>For NEON kernels:</p><ul>
 198 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 199 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 200 </ul>
 201 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler::set_num_threads()</a> can be used to manually set the number of threads</dd></dl>
 202 <p>For OpenCL kernels:</p><ul>
 203 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
 204 <li>The queue is then flushed.</li>
 205 </ul>
 206 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd>
 207 <dd>
 208 Will call <a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26" title="Prepare the function for executing. ">prepare()</a> on first run if hasn't been done </dd></dl>
 209
 210 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 211
 212 </div>
 213 </div>
 214 <hr/>The documentation for this class was generated from the following file:<ul>
 215 <li>arm_compute/runtime/CL/<a class="el" href="_i_c_l_simple_function_8h_source.xhtml">ICLSimpleFunction.h</a></li>
 216 </ul>
 217 </div><!-- contents -->
 218 </div><!-- doc-content -->
 219 <!-- start footer part -->
 220 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 221   <ul>
 222     <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_i_c_l_simple_function.xhtml">ICLSimpleFunction</a></li>
 223     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
 224     <a href="http://www.doxygen.org/index.html">
 225     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 226   </ul>
 227 </div>
 228 </body>
 229 </html>