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>ARM Compute Library: NEConvolution9x9 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">ARM Compute Library
43  <span id="projectnumber">17.03.1</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="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_convolution9x9.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">NEConvolution9x9 Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic function to execute convolution of size 9x9.
125 <a href="classarm__compute_1_1_n_e_convolution9x9.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_n_e_convolution_8h_source.xhtml">NEConvolution.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEConvolution9x9:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_convolution9x9__coll__graph.svg" width="142" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:ada1aa23065a11fa05e6880a84392b471"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution9x9.xhtml#ada1aa23065a11fa05e6880a84392b471">NEConvolution9x9</a> ()</td></tr>
138 <tr class="memdesc:ada1aa23065a11fa05e6880a84392b471"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ada1aa23065a11fa05e6880a84392b471">More...</a><br /></td></tr>
139 <tr class="separator:ada1aa23065a11fa05e6880a84392b471"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a58d050865536a28b56a92eeaf3ac478e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution9x9.xhtml#a58d050865536a28b56a92eeaf3ac478e">configure</a> (<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 scale, <a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> border_mode, uint8_t constant_border_value=0)</td></tr>
141 <tr class="memdesc:a58d050865536a28b56a92eeaf3ac478e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the function's source, destination, conv and border_mode. <a href="#a58d050865536a28b56a92eeaf3ac478e">More...</a><br /></td></tr>
142 <tr class="separator:a58d050865536a28b56a92eeaf3ac478e"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convolution9x9.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
144 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
145 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2"> </td></tr>
146 <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>
147 <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>
148 <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>
149 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
151 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
152 <div class="textblock"><p>Basic function to execute convolution of size 9x9. </p>
153 <p>This function calls the following NEON kernels:</p>
155 <li><a class="el" href="classarm__compute_1_1_n_e_fill_border_kernel.xhtml">NEFillBorderKernel</a> (executed if border_mode == CONSTANT or border_mode == REPLICATE)</li>
156 <li><a class="el" href="namespacearm__compute.xhtml#a1025306f820a9e76df7e5891caacff7b">NEConvolution9x9Kernel</a> or<br />
157 <a class="el" href="namespacearm__compute.xhtml#a4ba5f6b7cd6b70b75e42149f3bc08f38">NESeparableConvolution9x9HorKernel</a> and <a class="el" href="namespacearm__compute.xhtml#a6310d21f215fface41df4cde725a62b9">NESeparableConvolution9x9VertKernel</a> (if convolution matrix is separable) </li>
160 <p>Definition at line <a class="el" href="_n_e_convolution_8h_source.xhtml#l00138">138</a> of file <a class="el" href="_n_e_convolution_8h_source.xhtml">NEConvolution.h</a>.</p>
161 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
162 <a class="anchor" id="ada1aa23065a11fa05e6880a84392b471"></a>
163 <div class="memitem">
164 <div class="memproto">
165 <table class="memname">
167 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convolution9x9.xhtml">NEConvolution9x9</a> </td>
169 <td class="paramname"></td><td>)</td>
173 </div><div class="memdoc">
175 <p>Default constructor. </p>
179 <h2 class="groupheader">Member Function Documentation</h2>
180 <a class="anchor" id="a58d050865536a28b56a92eeaf3ac478e"></a>
181 <div class="memitem">
182 <div class="memproto">
183 <table class="memname">
185 <td class="memname">void configure </td>
187 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
188 <td class="paramname"><em>input</em>, </td>
191 <td class="paramkey"></td>
193 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
194 <td class="paramname"><em>output</em>, </td>
197 <td class="paramkey"></td>
199 <td class="paramtype">const int16_t * </td>
200 <td class="paramname"><em>conv</em>, </td>
203 <td class="paramkey"></td>
205 <td class="paramtype">uint32_t </td>
206 <td class="paramname"><em>scale</em>, </td>
209 <td class="paramkey"></td>
211 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> </td>
212 <td class="paramname"><em>border_mode</em>, </td>
215 <td class="paramkey"></td>
217 <td class="paramtype">uint8_t </td>
218 <td class="paramname"><em>constant_border_value</em> = <code>0</code> </td>
226 </div><div class="memdoc">
228 <p>Initialize the function's source, destination, conv and border_mode. </p>
229 <dl class="params"><dt>Parameters</dt><dd>
230 <table class="params">
231 <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. (Written to only for <code>border_mode</code> != UNDEFINED) </td></tr>
232 <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor, Data types supported: U8 or S16. </td></tr>
233 <tr><td class="paramdir">[in]</td><td class="paramname">conv</td><td>matrix_size x matrix_size S16 coefficients structured as a row-major 2D array in a linear buffer. </td></tr>
234 <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>
235 <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Strategy to use for borders. </td></tr>
236 <tr><td class="paramdir">[in]</td><td class="paramname">constant_border_value</td><td>(Optional) Constant value to use for borders if border_mode is set to CONSTANT. </td></tr>
243 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
248 <td class="mlabels-left">
249 <table class="memname">
251 <td class="memname">void run </td>
253 <td class="paramname"></td><td>)</td>
258 <td class="mlabels-right">
259 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
262 </div><div class="memdoc">
264 <p>Run the kernels contained in the function. </p>
265 <p>For NEON kernels:</p><ul>
266 <li>Multi-threading is used for the kernels which are parallelisable.</li>
267 <li>By default std::thread::hardware_concurrency() threads are used.</li>
269 <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>
270 <p>For OpenCL kernels:</p><ul>
271 <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>
272 <li>The queue is then flushed.</li>
274 <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>
276 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
280 <hr/>The documentation for this class was generated from the following file:<ul>
281 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_convolution_8h_source.xhtml">NEConvolution.h</a></li>
283 </div><!-- contents -->
284 </div><!-- doc-content -->
285 <!-- start footer part -->
286 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
288 <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_convolution9x9.xhtml">NEConvolution9x9</a></li>
289 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
290 <a href="http://www.doxygen.org/index.html">
291 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>