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.6"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: CLConvolutionSquare< matrix_size > Class Template 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="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
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); });
25 <script type="text/x-mathjax-config">
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36 <table cellspacing="0" cellpadding="0">
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
40 <div id="projectname">Compute Library
41  <span id="projectnumber">17.09</span>
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');
53 <div id="navrow1" class="tabs">
55 <li><a href="index.xhtml"><span>Main Page</span></a></li>
56 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
59 <li><a href="files.xhtml"><span>Files</span></a></li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
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>
78 <div id="navrow2" class="tabs2">
80 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
81 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
82 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
83 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_convolution_square.xhtml','');});
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
116 <div class="summary">
117 <a href="#pub-methods">Public Member Functions</a> </div>
118 <div class="headertitle">
119 <div class="title">CLConvolutionSquare< matrix_size > Class Template Reference</div> </div>
121 <div class="contents">
123 <p>Basic function to execute square convolution.Currently it supports 5x5, 7x7, 9x9.
124 <a href="classarm__compute_1_1_c_l_convolution_square.xhtml#details">More...</a></p>
126 <p><code>#include <<a class="el" href="_c_l_convolution_8h_source.xhtml">CLConvolution.h</a>></code></p>
127 <div class="dynheader">
128 Collaboration diagram for CLConvolutionSquare< matrix_size >:</div>
129 <div class="dyncontent">
130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_convolution_square__coll__graph.svg" width="160" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
133 <table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135 Public Member Functions</h2></td></tr>
136 <tr class="memitem:af1fdf57638e930af4a602f3a8393ccc4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_square.xhtml#af1fdf57638e930af4a602f3a8393ccc4">CLConvolutionSquare</a> (std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> > memory_manager=nullptr)</td></tr>
137 <tr class="memdesc:af1fdf57638e930af4a602f3a8393ccc4"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#af1fdf57638e930af4a602f3a8393ccc4">More...</a><br/></td></tr>
138 <tr class="separator:af1fdf57638e930af4a602f3a8393ccc4"><td class="memSeparator" colspan="2"> </td></tr>
139 <tr class="memitem:a26e1b4686b1f2d591d62d11585114a82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_square.xhtml#a26e1b4686b1f2d591d62d11585114a82">configure</a> (<a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</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>
140 <tr class="memdesc:a26e1b4686b1f2d591d62d11585114a82"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the function's source, destination, conv and border_mode. <a href="#a26e1b4686b1f2d591d62d11585114a82">More...</a><br/></td></tr>
141 <tr class="separator:a26e1b4686b1f2d591d62d11585114a82"><td class="memSeparator" colspan="2"> </td></tr>
142 <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_c_l_convolution_square.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
143 <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>
144 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2"> </td></tr>
145 <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>
146 <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>
147 <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>
148 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
151 <div class="textblock"><h3>template<unsigned int matrix_size><br/>
152 class arm_compute::CLConvolutionSquare< matrix_size ></h3>
154 <p>Basic function to execute square convolution.Currently it supports 5x5, 7x7, 9x9. </p>
155 <p>This function calls the following OpenCL kernels:</p>
157 <li><a class="el" href="classarm__compute_1_1_c_l_fill_border_kernel.xhtml">CLFillBorderKernel</a> (executed if border_mode == CONSTANT or border_mode == REPLICATE)</li>
158 <li><a class="el" href="classarm__compute_1_1_c_l_convolution_kernel.xhtml">CLConvolutionKernel</a> or<br/>
159 <a class="el" href="classarm__compute_1_1_c_l_separable_convolution_hor_kernel.xhtml">CLSeparableConvolutionHorKernel</a> and <a class="el" href="classarm__compute_1_1_c_l_separable_convolution_vert_kernel.xhtml">CLSeparableConvolutionVertKernel</a> (if convolution matrix is separable) </li>
162 <p>Definition at line <a class="el" href="_c_l_convolution_8h_source.xhtml#l00072">72</a> of file <a class="el" href="_c_l_convolution_8h_source.xhtml">CLConvolution.h</a>.</p>
163 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
164 <a class="anchor" id="af1fdf57638e930af4a602f3a8393ccc4"></a>
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
169 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_square.xhtml">CLConvolutionSquare</a> </td>
171 <td class="paramtype">std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> > </td>
172 <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
176 </div><div class="memdoc">
178 <p>Default constructor. </p>
182 <h2 class="groupheader">Member Function Documentation</h2>
183 <a class="anchor" id="a26e1b4686b1f2d591d62d11585114a82"></a>
184 <div class="memitem">
185 <div class="memproto">
186 <table class="memname">
188 <td class="memname">void configure </td>
190 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
191 <td class="paramname"><em>input</em>, </td>
194 <td class="paramkey"></td>
196 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
197 <td class="paramname"><em>output</em>, </td>
200 <td class="paramkey"></td>
202 <td class="paramtype">const int16_t * </td>
203 <td class="paramname"><em>conv</em>, </td>
206 <td class="paramkey"></td>
208 <td class="paramtype">uint32_t </td>
209 <td class="paramname"><em>scale</em>, </td>
212 <td class="paramkey"></td>
214 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a15a05537a472ee742404821851529327">BorderMode</a> </td>
215 <td class="paramname"><em>border_mode</em>, </td>
218 <td class="paramkey"></td>
220 <td class="paramtype">uint8_t </td>
221 <td class="paramname"><em>constant_border_value</em> = <code>0</code> </td>
229 </div><div class="memdoc">
231 <p>Initialize the function's source, destination, conv and border_mode. </p>
232 <dl class="params"><dt>Parameters</dt><dd>
233 <table class="params">
234 <tr><td class="paramdir">[in,out]</td><td class="paramname">input</td><td>Source tensor. Data types supported: U8. (Written to only for <code>border_mode</code> != UNDEFINED) </td></tr>
235 <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor, Data types supported: U8 or S16. </td></tr>
236 <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>
237 <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>
238 <tr><td class="paramdir">[in]</td><td class="paramname">border_mode</td><td>Strategy to use for borders. </td></tr>
239 <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>
244 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00056">main_cl_convolution()</a>.</p>
248 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
249 <div class="memitem">
250 <div class="memproto">
251 <table class="mlabels">
253 <td class="mlabels-left">
254 <table class="memname">
256 <td class="memname">void run </td>
258 <td class="paramname"></td><td>)</td>
263 <td class="mlabels-right">
264 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
267 </div><div class="memdoc">
269 <p>Run the kernels contained in the function. </p>
270 <p>For NEON kernels:</p>
272 <li>Multi-threading is used for the kernels which are parallelisable.</li>
273 <li>By default std::thread::hardware_concurrency() threads are used.</li>
275 <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>
276 <p>For OpenCL kernels:</p>
278 <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>
279 <li>The queue is then flushed.</li>
281 <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>
283 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
285 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00056">main_cl_convolution()</a>.</p>
289 <hr/>The documentation for this class was generated from the following file:<ul>
290 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_convolution_8h_source.xhtml">CLConvolution.h</a></li>
292 </div><!-- contents -->
293 </div><!-- doc-content -->
294 <!-- start footer part -->
295 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
297 <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_convolution_square.xhtml">CLConvolutionSquare</a></li>
298 <li class="footer">Generated on Thu Sep 28 2017 14:37:57 for Compute Library by
299 <a href="http://www.doxygen.org/index.html">
300 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>