arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_convolution_rectangle_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>ARM Compute Library: NEConvolutionRectangleKernel 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_n_e_convolution_rectangle_kernel.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">NEConvolutionRectangleKernel Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> for the running convolution on a rectangle matrix.  
125  <a href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_convolution_kernel_8h_source.xhtml">NEConvolutionKernel.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEConvolutionRectangleKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_convolution_rectangle_kernel__coll__graph.svg" width="218" height="187"><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:a437bfa972bdb089215368c344cce05d3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a437bfa972bdb089215368c344cce05d3">NEConvolutionRectangleKernel</a> ()</td></tr>
138 <tr class="memdesc:a437bfa972bdb089215368c344cce05d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a437bfa972bdb089215368c344cce05d3">More...</a><br /></td></tr>
139 <tr class="separator:a437bfa972bdb089215368c344cce05d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a7f9f7156c38ea608c5cdd440d924540d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a7f9f7156c38ea608c5cdd440d924540d">NEConvolutionRectangleKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a7f9f7156c38ea608c5cdd440d924540d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a7f9f7156c38ea608c5cdd440d924540d">More...</a><br /></td></tr>
142 <tr class="separator:a7f9f7156c38ea608c5cdd440d924540d"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a346f0286bbc7dc19e4aa25ae6acd57e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a346f0286bbc7dc19e4aa25ae6acd57e8">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a346f0286bbc7dc19e4aa25ae6acd57e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a346f0286bbc7dc19e4aa25ae6acd57e8">More...</a><br /></td></tr>
145 <tr class="separator:a346f0286bbc7dc19e4aa25ae6acd57e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a88921c6a68249c84d1a0de6b3bfe5401"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a88921c6a68249c84d1a0de6b3bfe5401">NEConvolutionRectangleKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:a88921c6a68249c84d1a0de6b3bfe5401"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a88921c6a68249c84d1a0de6b3bfe5401">More...</a><br /></td></tr>
148 <tr class="separator:a88921c6a68249c84d1a0de6b3bfe5401"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a098833ba328ff07d483f4d8af88ee9f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a098833ba328ff07d483f4d8af88ee9f8">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:a098833ba328ff07d483f4d8af88ee9f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a098833ba328ff07d483f4d8af88ee9f8">More...</a><br /></td></tr>
151 <tr class="separator:a098833ba328ff07d483f4d8af88ee9f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:a3bb75d0640105ec72239550ec8a086b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a3bb75d0640105ec72239550ec8a086b9">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, const int16_t *conv, uint32_t width, uint32_t height, uint32_t scale, bool border_undefined)</td></tr>
153 <tr class="memdesc:a3bb75d0640105ec72239550ec8a086b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input, output and border mode.  <a href="#a3bb75d0640105ec72239550ec8a086b9">More...</a><br /></td></tr>
154 <tr class="separator:a3bb75d0640105ec72239550ec8a086b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
156 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
157 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
159 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
160 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
162 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
163 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
164 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
166 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
167 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
168 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
170 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
171 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
173 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
174 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
176 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
177 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 </table>
179 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
180 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> for the running convolution on a rectangle matrix. </p>
181 <dl class="section note"><dt>Note</dt><dd>Supports combinations of 3,5,7 and 9. </dd></dl>
182
183 <p>Definition at line <a class="el" href="_n_e_convolution_kernel_8h_source.xhtml#l00200">200</a> of file <a class="el" href="_n_e_convolution_kernel_8h_source.xhtml">NEConvolutionKernel.h</a>.</p>
184 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
185 <a class="anchor" id="a437bfa972bdb089215368c344cce05d3"></a>
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> </td>
191           <td>(</td>
192           <td class="paramname"></td><td>)</td>
193           <td></td>
194         </tr>
195       </table>
196 </div><div class="memdoc">
197
198 <p>Default constructor. </p>
199
200 </div>
201 </div>
202 <a class="anchor" id="a7f9f7156c38ea608c5cdd440d924540d"></a>
203 <div class="memitem">
204 <div class="memproto">
205 <table class="mlabels">
206   <tr>
207   <td class="mlabels-left">
208       <table class="memname">
209         <tr>
210           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> </td>
211           <td>(</td>
212           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&#160;</td>
213           <td class="paramname"></td><td>)</td>
214           <td></td>
215         </tr>
216       </table>
217   </td>
218   <td class="mlabels-right">
219 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
220   </tr>
221 </table>
222 </div><div class="memdoc">
223
224 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
225
226 </div>
227 </div>
228 <a class="anchor" id="a88921c6a68249c84d1a0de6b3bfe5401"></a>
229 <div class="memitem">
230 <div class="memproto">
231 <table class="mlabels">
232   <tr>
233   <td class="mlabels-left">
234       <table class="memname">
235         <tr>
236           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> </td>
237           <td>(</td>
238           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&amp;&#160;</td>
239           <td class="paramname"></td><td>)</td>
240           <td></td>
241         </tr>
242       </table>
243   </td>
244   <td class="mlabels-right">
245 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
246   </tr>
247 </table>
248 </div><div class="memdoc">
249
250 <p>Allow instances of this class to be moved. </p>
251
252 </div>
253 </div>
254 <h2 class="groupheader">Member Function Documentation</h2>
255 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="mlabels">
259   <tr>
260   <td class="mlabels-left">
261       <table class="memname">
262         <tr>
263           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
264           <td>(</td>
265           <td class="paramname"></td><td>)</td>
266           <td> const</td>
267         </tr>
268       </table>
269   </td>
270   <td class="mlabels-right">
271 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
272   </tr>
273 </table>
274 </div><div class="memdoc">
275
276 <p>The size of the border for that kernel. </p>
277 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
278
279 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
280
281 </div>
282 </div>
283 <a class="anchor" id="a3bb75d0640105ec72239550ec8a086b9"></a>
284 <div class="memitem">
285 <div class="memproto">
286       <table class="memname">
287         <tr>
288           <td class="memname">void configure </td>
289           <td>(</td>
290           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
291           <td class="paramname"><em>input</em>, </td>
292         </tr>
293         <tr>
294           <td class="paramkey"></td>
295           <td></td>
296           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
297           <td class="paramname"><em>output</em>, </td>
298         </tr>
299         <tr>
300           <td class="paramkey"></td>
301           <td></td>
302           <td class="paramtype">const int16_t *&#160;</td>
303           <td class="paramname"><em>conv</em>, </td>
304         </tr>
305         <tr>
306           <td class="paramkey"></td>
307           <td></td>
308           <td class="paramtype">uint32_t&#160;</td>
309           <td class="paramname"><em>width</em>, </td>
310         </tr>
311         <tr>
312           <td class="paramkey"></td>
313           <td></td>
314           <td class="paramtype">uint32_t&#160;</td>
315           <td class="paramname"><em>height</em>, </td>
316         </tr>
317         <tr>
318           <td class="paramkey"></td>
319           <td></td>
320           <td class="paramtype">uint32_t&#160;</td>
321           <td class="paramname"><em>scale</em>, </td>
322         </tr>
323         <tr>
324           <td class="paramkey"></td>
325           <td></td>
326           <td class="paramtype">bool&#160;</td>
327           <td class="paramname"><em>border_undefined</em>&#160;</td>
328         </tr>
329         <tr>
330           <td></td>
331           <td>)</td>
332           <td></td><td></td>
333         </tr>
334       </table>
335 </div><div class="memdoc">
336
337 <p>Initialise the kernel's input, output and border mode. </p>
338 <dl class="params"><dt>Parameters</dt><dd>
339   <table class="params">
340     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. </td></tr>
341     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor, Data types supported: U8, S16. </td></tr>
342     <tr><td class="paramdir">[in]</td><td class="paramname">conv</td><td>Convolution matrix to apply to the input tensor. </td></tr>
343     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of convolution matrix (Number of columns) </td></tr>
344     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of convolution matrix (Number of rows) </td></tr>
345     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. </td></tr>
346     <tr><td class="paramdir">[in]</td><td class="paramname">border_undefined</td><td>True if the border mode is undefined. False if it's replicate or constant. </td></tr>
347   </table>
348   </dd>
349 </dl>
350
351 </div>
352 </div>
353 <a class="anchor" id="a346f0286bbc7dc19e4aa25ae6acd57e8"></a>
354 <div class="memitem">
355 <div class="memproto">
356 <table class="mlabels">
357   <tr>
358   <td class="mlabels-left">
359       <table class="memname">
360         <tr>
361           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a>&amp; operator= </td>
362           <td>(</td>
363           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&#160;</td>
364           <td class="paramname"></td><td>)</td>
365           <td></td>
366         </tr>
367       </table>
368   </td>
369   <td class="mlabels-right">
370 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
371   </tr>
372 </table>
373 </div><div class="memdoc">
374
375 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
376
377 </div>
378 </div>
379 <a class="anchor" id="a098833ba328ff07d483f4d8af88ee9f8"></a>
380 <div class="memitem">
381 <div class="memproto">
382 <table class="mlabels">
383   <tr>
384   <td class="mlabels-left">
385       <table class="memname">
386         <tr>
387           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a>&amp; operator= </td>
388           <td>(</td>
389           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a> &amp;&amp;&#160;</td>
390           <td class="paramname"></td><td>)</td>
391           <td></td>
392         </tr>
393       </table>
394   </td>
395   <td class="mlabels-right">
396 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
397   </tr>
398 </table>
399 </div><div class="memdoc">
400
401 <p>Allow instances of this class to be moved. </p>
402
403 </div>
404 </div>
405 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
406 <div class="memitem">
407 <div class="memproto">
408 <table class="mlabels">
409   <tr>
410   <td class="mlabels-left">
411       <table class="memname">
412         <tr>
413           <td class="memname">void run </td>
414           <td>(</td>
415           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
416           <td class="paramname"><em>window</em></td><td>)</td>
417           <td></td>
418         </tr>
419       </table>
420   </td>
421   <td class="mlabels-right">
422 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
423   </tr>
424 </table>
425 </div><div class="memdoc">
426
427 <p>Execute the kernel on the passed window. </p>
428 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
429 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
430 <dd>
431 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
432 <dl class="params"><dt>Parameters</dt><dd>
433   <table class="params">
434     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
435   </table>
436   </dd>
437 </dl>
438
439 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
440
441 </div>
442 </div>
443 <hr/>The documentation for this class was generated from the following file:<ul>
444 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_convolution_kernel_8h_source.xhtml">NEConvolutionKernel.h</a></li>
445 </ul>
446 </div><!-- contents -->
447 </div><!-- doc-content -->
448 <!-- start footer part -->
449 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
450   <ul>
451     <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_n_e_convolution_rectangle_kernel.xhtml">NEConvolutionRectangleKernel</a></li>
452     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
453     <a href="http://www.doxygen.org/index.html">
454     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
455   </ul>
456 </div>
457 </body>
458 </html>