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: 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);
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.03</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_i_c_l_simple_function.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> </div>
120 <div class="headertitle">
121 <div class="title">ICLSimpleFunction Class Reference</div> </div>
123 <div class="contents">
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>
128 <p><code>#include <<a class="el" href="_i_c_l_simple_function_8h_source.xhtml">ICLSimpleFunction.h</a>></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>
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"> </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"> </td><td class="mdescRight">Default constructor. <a href="#aa8149af857c4bface8ad712e418a63f1">More...</a><br /></td></tr>
140 <tr class="separator:aa8149af857c4bface8ad712e418a63f1"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:ab5fd6e96c07aaaed2747c7e16ed5951e"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </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="-"/> 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 </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"> </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"> </td></tr>
149 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
150 <div class="textblock"><p>Basic interface for functions which have a single OpenCL kernel. </p>
152 <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>
153 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
154 <a class="anchor" id="aa8149af857c4bface8ad712e418a63f1"></a>
155 <div class="memitem">
156 <div class="memproto">
157 <table class="memname">
159 <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_simple_function.xhtml">ICLSimpleFunction</a> </td>
161 <td class="paramname"></td><td>)</td>
165 </div><div class="memdoc">
167 <p>Default constructor. </p>
171 <h2 class="groupheader">Member Function Documentation</h2>
172 <a class="anchor" id="ab5fd6e96c07aaaed2747c7e16ed5951e"></a>
173 <div class="memitem">
174 <div class="memproto">
175 <table class="mlabels">
177 <td class="mlabels-left">
178 <table class="memname">
180 <td class="memname">void run </td>
182 <td class="paramname"></td><td>)</td>
187 <td class="mlabels-right">
188 <span class="mlabels"><span class="mlabel">final</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
191 </div><div class="memdoc">
193 <p>Run the kernels contained in the function. </p>
194 <p>For NEON kernels:</p><ul>
195 <li>Multi-threading is used for the kernels which are parallelisable.</li>
196 <li>By default std::thread::hardware_concurrency() threads are used.</li>
198 <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>
199 <p>For OpenCL kernels:</p><ul>
200 <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>
201 <li>The queue is then flushed.</li>
203 <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></dl>
205 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
209 <hr/>The documentation for this class was generated from the following file:<ul>
210 <li>arm_compute/runtime/CL/<a class="el" href="_i_c_l_simple_function_8h_source.xhtml">ICLSimpleFunction.h</a></li>
212 </div><!-- contents -->
213 </div><!-- doc-content -->
214 <!-- start footer part -->
215 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
217 <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>
218 <li class="footer">Generated on Fri Mar 2 2018 12:37:58 for Compute Library by
219 <a href="http://www.doxygen.org/index.html">
220 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>