arm_compute v17.09
[platform/upstream/armcl.git] / documentation / _n_e_reduction_operation_8h_source.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: arm_compute/runtime/NEON/functions/NEReductionOperation.h Source File</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><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59       <li class="current"><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="files.xhtml"><span>File&#160;List</span></a></li>
81       <li><a href="globals.xhtml"><span>Globals</span></a></li>
82     </ul>
83   </div>
84 </div><!-- top -->
85 <div id="side-nav" class="ui-resizable side-nav-resizable">
86   <div id="nav-tree">
87     <div id="nav-tree-contents">
88       <div id="nav-sync" class="sync"></div>
89     </div>
90   </div>
91   <div id="splitbar" style="-moz-user-select:none;" 
92        class="ui-resizable-handle">
93   </div>
94 </div>
95 <script type="text/javascript">
96 $(document).ready(function(){initNavTree('_n_e_reduction_operation_8h_source.xhtml','');});
97 </script>
98 <div id="doc-content">
99 <!-- window showing the filter options -->
100 <div id="MSearchSelectWindow"
101      onmouseover="return searchBox.OnSearchSelectShow()"
102      onmouseout="return searchBox.OnSearchSelectHide()"
103      onkeydown="return searchBox.OnSearchSelectKey(event)">
104 <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>
105
106 <!-- iframe showing the search results (closed by default) -->
107 <div id="MSearchResultsWindow">
108 <iframe src="javascript:void(0)" frameborder="0" 
109         name="MSearchResults" id="MSearchResults">
110 </iframe>
111 </div>
112
113 <div class="header">
114   <div class="headertitle">
115 <div class="title">NEReductionOperation.h</div>  </div>
116 </div><!--header-->
117 <div class="contents">
118 <a href="_n_e_reduction_operation_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
119 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2017 ARM Limited.</span></div>
120 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
121 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div>
122 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
123 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
124 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div>
125 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div>
126 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div>
127 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div>
128 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
129 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
130 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
131 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div>
132 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
133 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
134 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
135 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
136 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
137 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
138 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
139 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * SOFTWARE.</span></div>
140 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
141 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef __ARM_COMPUTE_NEREDUCTIONOPERATION_H__</span></div>
142 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __ARM_COMPUTE_NEREDUCTIONOPERATION_H__</span></div>
143 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor"></span></div>
144 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_function_8h.xhtml">arm_compute/runtime/IFunction.h</a>&quot;</span></div>
145 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
146 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_n_e_fill_border_kernel_8h.xhtml">arm_compute/core/NEON/kernels/NEFillBorderKernel.h</a>&quot;</span></div>
147 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_n_e_reduction_operation_kernel_8h.xhtml">arm_compute/core/NEON/kernels/NEReductionOperationKernel.h</a>&quot;</span></div>
148 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="arm__compute_2core_2_types_8h.xhtml">arm_compute/core/Types.h</a>&quot;</span></div>
149 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
150 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span>arm_compute</div>
151 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div>
152 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">class </span>ITensor;</div>
153 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
154 <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_n_e_reduction_operation.xhtml">   43</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1_n_e_reduction_operation.xhtml">NEReductionOperation</a> : <span class="keyword">public</span> <a class="code" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></div>
155 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;{</div>
156 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">public</span>:</div>
157 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <a class="code" href="classarm__compute_1_1_n_e_reduction_operation.xhtml#a20574f46cffa32ed112fcffa4e3af223">NEReductionOperation</a>();</div>
158 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_n_e_reduction_operation.xhtml#a5a8b455c425ea5b09a3ad7686c619434">configure</a>(<a class="code" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="code" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> axis, <a class="code" href="namespacearm__compute.xhtml#a5827eb9cb394e74af87f74bd354fb45b">ReductionOperation</a> op);</div>
159 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
160 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="comment">// Inherited methods overridden:</span></div>
161 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_n_e_reduction_operation.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a>() <span class="keyword">override</span>;</div>
162 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
163 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">private</span>:</div>
164 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <a class="code" href="classarm__compute_1_1_n_e_reduction_operation_kernel.xhtml">NEReductionOperationKernel</a> _reduction_kernel;</div>
165 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">NEFillBorderKernel</a>         _fill_border_kernel;</div>
166 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keywordtype">size_t</span>                     _window_split;</div>
167 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;};</div>
168 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}</div>
169 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ARM_COMPUTE_NEREDUCTIONOPERATION_H__ */</span><span class="preprocessor"></span></div>
170 <div class="ttc" id="classarm__compute_1_1_i_function_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_function.xhtml">arm_compute::IFunction</a></div><div class="ttdoc">Base class for all functions. </div><div class="ttdef"><b>Definition:</b> <a href="_i_function_8h_source.xhtml#l00030">IFunction.h:30</a></div></div>
171 <div class="ttc" id="classarm__compute_1_1_n_e_reduction_operation_xhtml_ad1717410afd0be936c6213a63c8005fb"><div class="ttname"><a href="classarm__compute_1_1_n_e_reduction_operation.xhtml#ad1717410afd0be936c6213a63c8005fb">arm_compute::NEReductionOperation::run</a></div><div class="ttdeci">void run() override</div><div class="ttdoc">Run the kernels contained in the function. </div></div>
172 <div class="ttc" id="namespacearm__compute_xhtml_a5827eb9cb394e74af87f74bd354fb45b"><div class="ttname"><a href="namespacearm__compute.xhtml#a5827eb9cb394e74af87f74bd354fb45b">arm_compute::ReductionOperation</a></div><div class="ttdeci">ReductionOperation</div><div class="ttdoc">Available reduction operations. </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2core_2_types_8h_source.xhtml#l00350">Types.h:350</a></div></div>
173 <div class="ttc" id="classarm__compute_1_1_i_tensor_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_tensor.xhtml">arm_compute::ITensor</a></div><div class="ttdoc">Interface for NEON tensor. </div><div class="ttdef"><b>Definition:</b> <a href="_i_tensor_8h_source.xhtml#l00036">ITensor.h:36</a></div></div>
174 <div class="ttc" id="_n_e_fill_border_kernel_8h_xhtml"><div class="ttname"><a href="_n_e_fill_border_kernel_8h.xhtml">NEFillBorderKernel.h</a></div></div>
175 <div class="ttc" id="classarm__compute_1_1_n_e_reduction_operation_kernel_xhtml"><div class="ttname"><a href="classarm__compute_1_1_n_e_reduction_operation_kernel.xhtml">arm_compute::NEReductionOperationKernel</a></div><div class="ttdoc">NEON kernel to perform a reduction operation. </div><div class="ttdef"><b>Definition:</b> <a href="_n_e_reduction_operation_kernel_8h_source.xhtml#l00034">NEReductionOperationKernel.h:34</a></div></div>
176 <div class="ttc" id="_n_e_reduction_operation_kernel_8h_xhtml"><div class="ttname"><a href="_n_e_reduction_operation_kernel_8h.xhtml">NEReductionOperationKernel.h</a></div></div>
177 <div class="ttc" id="classarm__compute_1_1_n_e_reduction_operation_xhtml_a20574f46cffa32ed112fcffa4e3af223"><div class="ttname"><a href="classarm__compute_1_1_n_e_reduction_operation.xhtml#a20574f46cffa32ed112fcffa4e3af223">arm_compute::NEReductionOperation::NEReductionOperation</a></div><div class="ttdeci">NEReductionOperation()</div><div class="ttdoc">Default constructor. </div></div>
178 <div class="ttc" id="_i_function_8h_xhtml"><div class="ttname"><a href="_i_function_8h.xhtml">IFunction.h</a></div></div>
179 <div class="ttc" id="classarm__compute_1_1_n_e_fill_border_kernel_xhtml"><div class="ttname"><a href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">arm_compute::NEFillBorderKernel</a></div><div class="ttdoc">Interface for the kernel to fill borders. </div><div class="ttdef"><b>Definition:</b> <a href="_n_e_fill_border_kernel_8h_source.xhtml#l00036">NEFillBorderKernel.h:36</a></div></div>
180 <div class="ttc" id="classarm__compute_1_1_n_e_reduction_operation_xhtml_a5a8b455c425ea5b09a3ad7686c619434"><div class="ttname"><a href="classarm__compute_1_1_n_e_reduction_operation.xhtml#a5a8b455c425ea5b09a3ad7686c619434">arm_compute::NEReductionOperation::configure</a></div><div class="ttdeci">void configure(ITensor *input, ITensor *output, unsigned int axis, ReductionOperation op)</div><div class="ttdoc">Set the input and output tensors. </div></div>
181 <div class="ttc" id="classarm__compute_1_1_n_e_reduction_operation_xhtml"><div class="ttname"><a href="classarm__compute_1_1_n_e_reduction_operation.xhtml">arm_compute::NEReductionOperation</a></div><div class="ttdoc">Basic function to simulate a reduction operation. </div><div class="ttdef"><b>Definition:</b> <a href="_n_e_reduction_operation_8h_source.xhtml#l00043">NEReductionOperation.h:43</a></div></div>
182 <div class="ttc" id="arm__compute_2core_2_types_8h_xhtml"><div class="ttname"><a href="arm__compute_2core_2_types_8h.xhtml">Types.h</a></div></div>
183 </div><!-- fragment --></div><!-- contents -->
184 </div><!-- doc-content -->
185 <!-- start footer part -->
186 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
187   <ul>
188     <li class="navelem"><a class="el" href="dir_d4d363c0979c7ffda4833df3f93b5668.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_9464f60aea3c9b524aea6b3ae09a377f.xhtml">runtime</a></li><li class="navelem"><a class="el" href="dir_19dd10388c828caf656635151589eeb5.xhtml">NEON</a></li><li class="navelem"><a class="el" href="dir_35f65bf11a4f103b6aa0588a205e65e2.xhtml">functions</a></li><li class="navelem"><a class="el" href="_n_e_reduction_operation_8h.xhtml">NEReductionOperation.h</a></li>
189     <li class="footer">Generated on Thu Sep 28 2017 14:37:50 for Compute Library by
190     <a href="http://www.doxygen.org/index.html">
191     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
192   </ul>
193 </div>
194 </body>
195 </html>