arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_convolution_layer_reshape_weights.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>Compute Library: CLConvolutionLayerReshapeWeights 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">Compute Library
43    &#160;<span id="projectnumber">18.05</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="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> &#124;
120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
121   <div class="headertitle">
122 <div class="title">CLConvolutionLayerReshapeWeights Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>Function to reshape and transpose the weights.  
127  <a href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_c_l_g_e_m_m_convolution_layer_8h_source.xhtml">CLGEMMConvolutionLayer.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for CLConvolutionLayerReshapeWeights:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_convolution_layer_reshape_weights__coll__graph.svg" width="214" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
134 </div>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <tr class="memitem:a73ef66c1023022fe03cd8d3e3c865ff7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml#a73ef66c1023022fe03cd8d3e3c865ff7">CLConvolutionLayerReshapeWeights</a> ()</td></tr>
140 <tr class="memdesc:a73ef66c1023022fe03cd8d3e3c865ff7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a73ef66c1023022fe03cd8d3e3c865ff7">More...</a><br /></td></tr>
141 <tr class="separator:a73ef66c1023022fe03cd8d3e3c865ff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a9a3d99b364c89f386250cc92dddc6b1b"><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_convolution_layer_reshape_weights.xhtml#a9a3d99b364c89f386250cc92dddc6b1b">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *weights, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *biases, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output)</td></tr>
143 <tr class="memdesc:a9a3d99b364c89f386250cc92dddc6b1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#a9a3d99b364c89f386250cc92dddc6b1b">More...</a><br /></td></tr>
144 <tr class="separator:a9a3d99b364c89f386250cc92dddc6b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <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_convolution_layer_reshape_weights.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
146 <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>
147 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <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>
149 <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>
150 <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>
151 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">prepare</a> ()</td></tr>
153 <tr class="memdesc:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the function for executing.  <a href="#a820f7291c24155a2980512fae45aac26">More...</a><br /></td></tr>
154 <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 </table><table class="memberdecls">
156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
157 Static Public Member Functions</h2></td></tr>
158 <tr class="memitem:a81d17a75f619c824d037e6304fb2e1c2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml#a81d17a75f619c824d037e6304fb2e1c2">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *weights, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *biases, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output)</td></tr>
159 <tr class="memdesc:a81d17a75f619c824d037e6304fb2e1c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml">CLConvolutionLayerReshapeWeights</a>.  <a href="#a81d17a75f619c824d037e6304fb2e1c2">More...</a><br /></td></tr>
160 <tr class="separator:a81d17a75f619c824d037e6304fb2e1c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
163 <div class="textblock"><p>Function to reshape and transpose the weights. </p>
164 <p>This function calls the following kernels:</p><ol type="1">
165 <li><a class="el" href="classarm__compute_1_1_c_l_weights_reshape_kernel.xhtml">CLWeightsReshapeKernel</a> </li>
166 </ol>
167
168 <p>Definition at line <a class="el" href="_c_l_g_e_m_m_convolution_layer_8h_source.xhtml#l00054">54</a> of file <a class="el" href="_c_l_g_e_m_m_convolution_layer_8h_source.xhtml">CLGEMMConvolutionLayer.h</a>.</p>
169 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
170 <a class="anchor" id="a73ef66c1023022fe03cd8d3e3c865ff7"></a>
171 <div class="memitem">
172 <div class="memproto">
173       <table class="memname">
174         <tr>
175           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml">CLConvolutionLayerReshapeWeights</a> </td>
176           <td>(</td>
177           <td class="paramname"></td><td>)</td>
178           <td></td>
179         </tr>
180       </table>
181 </div><div class="memdoc">
182
183 <p>Constructor. </p>
184
185 </div>
186 </div>
187 <h2 class="groupheader">Member Function Documentation</h2>
188 <a class="anchor" id="a9a3d99b364c89f386250cc92dddc6b1b"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">void configure </td>
194           <td>(</td>
195           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
196           <td class="paramname"><em>weights</em>, </td>
197         </tr>
198         <tr>
199           <td class="paramkey"></td>
200           <td></td>
201           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
202           <td class="paramname"><em>biases</em>, </td>
203         </tr>
204         <tr>
205           <td class="paramkey"></td>
206           <td></td>
207           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
208           <td class="paramname"><em>output</em>&#160;</td>
209         </tr>
210         <tr>
211           <td></td>
212           <td>)</td>
213           <td></td><td></td>
214         </tr>
215       </table>
216 </div><div class="memdoc">
217
218 <p>Set the input and output tensors. </p>
219 <dl class="params"><dt>Parameters</dt><dd>
220   <table class="params">
221     <tr><td class="paramdir">[in]</td><td class="paramname">weights</td><td>Weights tensor. Weights are 4D tensor with dimensions [kernel_x, kernel_y, IFM, OFM]. Data type supported: QS8/QASYMM8/QS16/F16/F32. </td></tr>
222     <tr><td class="paramdir">[in]</td><td class="paramname">biases</td><td>Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as <code>weights</code>. </td></tr>
223     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: Same as <code>weights</code>. </td></tr>
224   </table>
225   </dd>
226 </dl>
227
228 </div>
229 </div>
230 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
231 <div class="memitem">
232 <div class="memproto">
233 <table class="mlabels">
234   <tr>
235   <td class="mlabels-left">
236       <table class="memname">
237         <tr>
238           <td class="memname">void run </td>
239           <td>(</td>
240           <td class="paramname"></td><td>)</td>
241           <td></td>
242         </tr>
243       </table>
244   </td>
245   <td class="mlabels-right">
246 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
247   </tr>
248 </table>
249 </div><div class="memdoc">
250
251 <p>Run the kernels contained in the function. </p>
252 <p>For NEON kernels:</p><ul>
253 <li>Multi-threading is used for the kernels which are parallelisable.</li>
254 <li>By default std::thread::hardware_concurrency() threads are used.</li>
255 </ul>
256 <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>
257 <p>For OpenCL kernels:</p><ul>
258 <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>
259 <li>The queue is then flushed.</li>
260 </ul>
261 <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>
262 <dd>
263 Will call <a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26" title="Prepare the function for executing. ">prepare()</a> on first run if hasn't been done </dd></dl>
264
265 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
266
267 </div>
268 </div>
269 <a class="anchor" id="a81d17a75f619c824d037e6304fb2e1c2"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
273   <tr>
274   <td class="mlabels-left">
275       <table class="memname">
276         <tr>
277           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
278           <td>(</td>
279           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
280           <td class="paramname"><em>weights</em>, </td>
281         </tr>
282         <tr>
283           <td class="paramkey"></td>
284           <td></td>
285           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
286           <td class="paramname"><em>biases</em>, </td>
287         </tr>
288         <tr>
289           <td class="paramkey"></td>
290           <td></td>
291           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
292           <td class="paramname"><em>output</em>&#160;</td>
293         </tr>
294         <tr>
295           <td></td>
296           <td>)</td>
297           <td></td><td></td>
298         </tr>
299       </table>
300   </td>
301   <td class="mlabels-right">
302 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
303   </tr>
304 </table>
305 </div><div class="memdoc">
306
307 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_l_convolution_layer_reshape_weights.xhtml">CLConvolutionLayerReshapeWeights</a>. </p>
308 <dl class="params"><dt>Parameters</dt><dd>
309   <table class="params">
310     <tr><td class="paramdir">[in]</td><td class="paramname">weights</td><td>Weights tensor. Weights are 4D tensor with dimensions [kernel_x, kernel_y, IFM, OFM]. Data type supported: QS8/QASYMM8/QS16/F16/F32. </td></tr>
311     <tr><td class="paramdir">[in]</td><td class="paramname">biases</td><td>Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as <code>weights</code>. </td></tr>
312     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor. Data types supported: Same as <code>weights</code>.</td></tr>
313   </table>
314   </dd>
315 </dl>
316 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
317
318 </div>
319 </div>
320 <hr/>The documentation for this class was generated from the following file:<ul>
321 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_g_e_m_m_convolution_layer_8h_source.xhtml">CLGEMMConvolutionLayer.h</a></li>
322 </ul>
323 </div><!-- contents -->
324 </div><!-- doc-content -->
325 <!-- start footer part -->
326 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
327   <ul>
328     <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_layer_reshape_weights.xhtml">CLConvolutionLayerReshapeWeights</a></li>
329     <li class="footer">Generated on Wed May 23 2018 11:36:40 for Compute Library by
330     <a href="http://www.doxygen.org/index.html">
331     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
332   </ul>
333 </div>
334 </body>
335 </html>