arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_min_max_location.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>ARM Compute Library: CLMinMaxLocation 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">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_min_max_location.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">CLMinMaxLocation Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Basic function to execute min and max location.  
125  <a href="classarm__compute_1_1_c_l_min_max_location.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_c_l_min_max_location_8h_source.xhtml">CLMinMaxLocation.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for CLMinMaxLocation:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_min_max_location__coll__graph.svg" width="146" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
132 </div>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:a9071fb1db3bb78426f8557bd22107c56"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml#a9071fb1db3bb78426f8557bd22107c56">CLMinMaxLocation</a> ()</td></tr>
138 <tr class="memdesc:a9071fb1db3bb78426f8557bd22107c56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9071fb1db3bb78426f8557bd22107c56">More...</a><br /></td></tr>
139 <tr class="separator:a9071fb1db3bb78426f8557bd22107c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a6d994e3b951dcf164932421d6ae155c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml#a6d994e3b951dcf164932421d6ae155c5">CLMinMaxLocation</a> (const <a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a6d994e3b951dcf164932421d6ae155c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a6d994e3b951dcf164932421d6ae155c5">More...</a><br /></td></tr>
142 <tr class="separator:a6d994e3b951dcf164932421d6ae155c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a5ec34a951324ad9bd8bf06d8620369ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml#a5ec34a951324ad9bd8bf06d8620369ed">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a5ec34a951324ad9bd8bf06d8620369ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a5ec34a951324ad9bd8bf06d8620369ed">More...</a><br /></td></tr>
145 <tr class="separator:a5ec34a951324ad9bd8bf06d8620369ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a5ef3e0081a18bd7c09723477f1625ab0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml#a5ef3e0081a18bd7c09723477f1625ab0">CLMinMaxLocation</a> (<a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:a5ef3e0081a18bd7c09723477f1625ab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a5ef3e0081a18bd7c09723477f1625ab0">More...</a><br /></td></tr>
148 <tr class="separator:a5ef3e0081a18bd7c09723477f1625ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a54669d0a20e3df491886372d4cffef69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml#a54669d0a20e3df491886372d4cffef69">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:a54669d0a20e3df491886372d4cffef69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a54669d0a20e3df491886372d4cffef69">More...</a><br /></td></tr>
151 <tr class="separator:a54669d0a20e3df491886372d4cffef69"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:ae1b53cbaac6ac40f1a8bfa6a46e99cce"><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_min_max_location.xhtml#ae1b53cbaac6ac40f1a8bfa6a46e99cce">configure</a> (const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *input, int32_t *min, int32_t *max, <a class="el" href="namespacearm__compute.xhtml#a0fd5f0310a26faad00b905bac3792726">CLCoordinates2DArray</a> *min_loc=nullptr, <a class="el" href="namespacearm__compute.xhtml#a0fd5f0310a26faad00b905bac3792726">CLCoordinates2DArray</a> *max_loc=nullptr, uint32_t *min_count=nullptr, uint32_t *max_count=nullptr)</td></tr>
153 <tr class="memdesc:ae1b53cbaac6ac40f1a8bfa6a46e99cce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's inputs and outputs.  <a href="#ae1b53cbaac6ac40f1a8bfa6a46e99cce">More...</a><br /></td></tr>
154 <tr class="separator:ae1b53cbaac6ac40f1a8bfa6a46e99cce"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><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_min_max_location.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
156 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
157 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <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>
159 <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>
160 <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>
161 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 </table>
163 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
164 <div class="textblock"><p>Basic function to execute min and max location. </p>
165 <p>This function calls the following OpenCL kernels:</p>
166 <ol type="1">
167 <li><a class="el" href="classarm__compute_1_1_c_l_min_max_kernel.xhtml">CLMinMaxKernel</a></li>
168 <li><a class="el" href="classarm__compute_1_1_c_l_min_max_location_kernel.xhtml">CLMinMaxLocationKernel</a> </li>
169 </ol>
170
171 <p>Definition at line <a class="el" href="_c_l_min_max_location_8h_source.xhtml#l00041">41</a> of file <a class="el" href="_c_l_min_max_location_8h_source.xhtml">CLMinMaxLocation.h</a>.</p>
172 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
173 <a class="anchor" id="a9071fb1db3bb78426f8557bd22107c56"></a>
174 <div class="memitem">
175 <div class="memproto">
176       <table class="memname">
177         <tr>
178           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> </td>
179           <td>(</td>
180           <td class="paramname"></td><td>)</td>
181           <td></td>
182         </tr>
183       </table>
184 </div><div class="memdoc">
185
186 <p>Constructor. </p>
187
188 </div>
189 </div>
190 <a class="anchor" id="a6d994e3b951dcf164932421d6ae155c5"></a>
191 <div class="memitem">
192 <div class="memproto">
193 <table class="mlabels">
194   <tr>
195   <td class="mlabels-left">
196       <table class="memname">
197         <tr>
198           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> </td>
199           <td>(</td>
200           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&#160;</td>
201           <td class="paramname"></td><td>)</td>
202           <td></td>
203         </tr>
204       </table>
205   </td>
206   <td class="mlabels-right">
207 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
208   </tr>
209 </table>
210 </div><div class="memdoc">
211
212 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
213
214 </div>
215 </div>
216 <a class="anchor" id="a5ef3e0081a18bd7c09723477f1625ab0"></a>
217 <div class="memitem">
218 <div class="memproto">
219 <table class="mlabels">
220   <tr>
221   <td class="mlabels-left">
222       <table class="memname">
223         <tr>
224           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> </td>
225           <td>(</td>
226           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&amp;&#160;</td>
227           <td class="paramname"></td><td>)</td>
228           <td></td>
229         </tr>
230       </table>
231   </td>
232   <td class="mlabels-right">
233 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
234   </tr>
235 </table>
236 </div><div class="memdoc">
237
238 <p>Allow instances of this class to be moved. </p>
239
240 </div>
241 </div>
242 <h2 class="groupheader">Member Function Documentation</h2>
243 <a class="anchor" id="ae1b53cbaac6ac40f1a8bfa6a46e99cce"></a>
244 <div class="memitem">
245 <div class="memproto">
246       <table class="memname">
247         <tr>
248           <td class="memname">void configure </td>
249           <td>(</td>
250           <td class="paramtype">const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *&#160;</td>
251           <td class="paramname"><em>input</em>, </td>
252         </tr>
253         <tr>
254           <td class="paramkey"></td>
255           <td></td>
256           <td class="paramtype">int32_t *&#160;</td>
257           <td class="paramname"><em>min</em>, </td>
258         </tr>
259         <tr>
260           <td class="paramkey"></td>
261           <td></td>
262           <td class="paramtype">int32_t *&#160;</td>
263           <td class="paramname"><em>max</em>, </td>
264         </tr>
265         <tr>
266           <td class="paramkey"></td>
267           <td></td>
268           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a0fd5f0310a26faad00b905bac3792726">CLCoordinates2DArray</a> *&#160;</td>
269           <td class="paramname"><em>min_loc</em> = <code>nullptr</code>, </td>
270         </tr>
271         <tr>
272           <td class="paramkey"></td>
273           <td></td>
274           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a0fd5f0310a26faad00b905bac3792726">CLCoordinates2DArray</a> *&#160;</td>
275           <td class="paramname"><em>max_loc</em> = <code>nullptr</code>, </td>
276         </tr>
277         <tr>
278           <td class="paramkey"></td>
279           <td></td>
280           <td class="paramtype">uint32_t *&#160;</td>
281           <td class="paramname"><em>min_count</em> = <code>nullptr</code>, </td>
282         </tr>
283         <tr>
284           <td class="paramkey"></td>
285           <td></td>
286           <td class="paramtype">uint32_t *&#160;</td>
287           <td class="paramname"><em>max_count</em> = <code>nullptr</code>&#160;</td>
288         </tr>
289         <tr>
290           <td></td>
291           <td>)</td>
292           <td></td><td></td>
293         </tr>
294       </table>
295 </div><div class="memdoc">
296
297 <p>Initialise the kernel's inputs and outputs. </p>
298 <dl class="section note"><dt>Note</dt><dd>When locations of min and max occurrences are requested, the reported number of locations is limited to the given array size.</dd></dl>
299 <dl class="params"><dt>Parameters</dt><dd>
300   <table class="params">
301     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input image. Data types supported: U8 or S16. </td></tr>
302     <tr><td class="paramdir">[out]</td><td class="paramname">min</td><td>Minimum value of image. </td></tr>
303     <tr><td class="paramdir">[out]</td><td class="paramname">max</td><td>Maximum value of image. </td></tr>
304     <tr><td class="paramdir">[out]</td><td class="paramname">min_loc</td><td>(Optional) <a class="el" href="classarm__compute_1_1_array.xhtml" title="Basic implementation of the IArray interface which allocates a static number of T values...">Array</a> of <a class="el" href="structarm__compute_1_1_coordinates2_d.xhtml" title="Coordinate type. ">Coordinates2D</a> used to store minimum value locations. </td></tr>
305     <tr><td class="paramdir">[out]</td><td class="paramname">max_loc</td><td>(Optional) <a class="el" href="classarm__compute_1_1_array.xhtml" title="Basic implementation of the IArray interface which allocates a static number of T values...">Array</a> of <a class="el" href="structarm__compute_1_1_coordinates2_d.xhtml" title="Coordinate type. ">Coordinates2D</a> used to store maximum value locations. </td></tr>
306     <tr><td class="paramdir">[out]</td><td class="paramname">min_count</td><td>(Optional) Number of minimum value encounters. </td></tr>
307     <tr><td class="paramdir">[out]</td><td class="paramname">max_count</td><td>(Optional) Number of maximum value encounters. </td></tr>
308   </table>
309   </dd>
310 </dl>
311
312 </div>
313 </div>
314 <a class="anchor" id="a5ec34a951324ad9bd8bf06d8620369ed"></a>
315 <div class="memitem">
316 <div class="memproto">
317 <table class="mlabels">
318   <tr>
319   <td class="mlabels-left">
320       <table class="memname">
321         <tr>
322           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a>&amp; operator= </td>
323           <td>(</td>
324           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&#160;</td>
325           <td class="paramname"></td><td>)</td>
326           <td></td>
327         </tr>
328       </table>
329   </td>
330   <td class="mlabels-right">
331 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
332   </tr>
333 </table>
334 </div><div class="memdoc">
335
336 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
337
338 </div>
339 </div>
340 <a class="anchor" id="a54669d0a20e3df491886372d4cffef69"></a>
341 <div class="memitem">
342 <div class="memproto">
343 <table class="mlabels">
344   <tr>
345   <td class="mlabels-left">
346       <table class="memname">
347         <tr>
348           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a>&amp; operator= </td>
349           <td>(</td>
350           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_min_max_location.xhtml">CLMinMaxLocation</a> &amp;&amp;&#160;</td>
351           <td class="paramname"></td><td>)</td>
352           <td></td>
353         </tr>
354       </table>
355   </td>
356   <td class="mlabels-right">
357 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
358   </tr>
359 </table>
360 </div><div class="memdoc">
361
362 <p>Allow instances of this class to be moved. </p>
363
364 </div>
365 </div>
366 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
367 <div class="memitem">
368 <div class="memproto">
369 <table class="mlabels">
370   <tr>
371   <td class="mlabels-left">
372       <table class="memname">
373         <tr>
374           <td class="memname">void run </td>
375           <td>(</td>
376           <td class="paramname"></td><td>)</td>
377           <td></td>
378         </tr>
379       </table>
380   </td>
381   <td class="mlabels-right">
382 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
383   </tr>
384 </table>
385 </div><div class="memdoc">
386
387 <p>Run the kernels contained in the function. </p>
388 <p>For NEON kernels:</p><ul>
389 <li>Multi-threading is used for the kernels which are parallelisable.</li>
390 <li>By default std::thread::hardware_concurrency() threads are used.</li>
391 </ul>
392 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae9dc1846ff1612778bbac85d46344aef">CPPScheduler::force_number_of_threads()</a> can be used to manually set the number of threads</dd></dl>
393 <p>For OpenCL kernels:</p><ul>
394 <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>
395 <li>The queue is then flushed.</li>
396 </ul>
397 <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>
398
399 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
400
401 </div>
402 </div>
403 <hr/>The documentation for this class was generated from the following file:<ul>
404 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_min_max_location_8h_source.xhtml">CLMinMaxLocation.h</a></li>
405 </ul>
406 </div><!-- contents -->
407 </div><!-- doc-content -->
408 <!-- start footer part -->
409 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
410   <ul>
411     <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_min_max_location.xhtml">CLMinMaxLocation</a></li>
412     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
413     <a href="http://www.doxygen.org/index.html">
414     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
415   </ul>
416 </div>
417 </body>
418 </html>