Few minor updates to BuildGuideAndroidNDK.md file
[platform/upstream/armnn.git] / Documentation / structarmnn_1_1_debug_queue_descriptor.xhtml
1 <!-- Copyright (c) 2020 ARM Limited. -->
2 <!--                                 -->
3 <!-- SPDX-License-Identifier: MIT    -->
4 <!--                                 -->
5 <!-- HTML header for doxygen 1.8.13-->
6 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7 <html xmlns="http://www.w3.org/1999/xhtml">
8 <head>
9 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
11 <meta name="generator" content="Doxygen 1.8.13"/>
12 <meta name="robots" content="NOINDEX, NOFOLLOW" />
13 <meta name="viewport" content="width=device-width, initial-scale=1"/>
14 <title>ArmNN: DebugQueueDescriptor Struct Reference</title>
15 <link href="tabs.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="jquery.js"></script>
17 <script type="text/javascript" src="dynsections.js"></script>
18 <link href="navtree.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="resize.js"></script>
20 <script type="text/javascript" src="navtreedata.js"></script>
21 <script type="text/javascript" src="navtree.js"></script>
22 <script type="text/javascript">
23   $(document).ready(initResizable);
24 </script>
25 <link href="search/search.css" rel="stylesheet" type="text/css"/>
26 <script type="text/javascript" src="search/searchdata.js"></script>
27 <script type="text/javascript" src="search/search.js"></script>
28 <script type="text/x-mathjax-config">
29   MathJax.Hub.Config({
30     extensions: ["tex2jax.js"],
31     jax: ["input/TeX","output/HTML-CSS"],
32 });
33 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34 <link href="doxygen.css" rel="stylesheet" type="text/css" />
35 <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36 </head>
37 <body>
38 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39 <div id="titlearea">
40 <table cellspacing="0" cellpadding="0">
41  <tbody>
42  <tr style="height: 56px;">
43   <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44   <td style="padding-left: 0.5em;">
45    <div id="projectname">
46    &#160;<span id="projectnumber">20.02</span>
47    </div>
48   </td>
49  </tr>
50  </tbody>
51 </table>
52 </div>
53 <!-- end header part -->
54 <!-- Generated by Doxygen 1.8.13 -->
55 <script type="text/javascript">
56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
57 </script>
58 <script type="text/javascript" src="menudata.js"></script>
59 <script type="text/javascript" src="menu.js"></script>
60 <script type="text/javascript">
61 $(function() {
62   initMenu('',true,false,'search.php','Search');
63   $(document).ready(function() { init_search(); });
64 });
65 </script>
66 <div id="main-nav"></div>
67 </div><!-- top -->
68 <div id="side-nav" class="ui-resizable side-nav-resizable">
69   <div id="nav-tree">
70     <div id="nav-tree-contents">
71       <div id="nav-sync" class="sync"></div>
72     </div>
73   </div>
74   <div id="splitbar" style="-moz-user-select:none;" 
75        class="ui-resizable-handle">
76   </div>
77 </div>
78 <script type="text/javascript">
79 $(document).ready(function(){initNavTree('structarmnn_1_1_debug_queue_descriptor.xhtml','');});
80 </script>
81 <div id="doc-content">
82 <!-- window showing the filter options -->
83 <div id="MSearchSelectWindow"
84      onmouseover="return searchBox.OnSearchSelectShow()"
85      onmouseout="return searchBox.OnSearchSelectHide()"
86      onkeydown="return searchBox.OnSearchSelectKey(event)">
87 </div>
88
89 <!-- iframe showing the search results (closed by default) -->
90 <div id="MSearchResultsWindow">
91 <iframe src="javascript:void(0)" frameborder="0" 
92         name="MSearchResults" id="MSearchResults">
93 </iframe>
94 </div>
95
96 <div class="header">
97   <div class="summary">
98 <a href="#pub-methods">Public Member Functions</a> &#124;
99 <a href="#pub-attribs">Public Attributes</a> &#124;
100 <a href="structarmnn_1_1_debug_queue_descriptor-members.xhtml">List of all members</a>  </div>
101   <div class="headertitle">
102 <div class="title">DebugQueueDescriptor Struct Reference</div>  </div>
103 </div><!--header-->
104 <div class="contents">
105
106 <p><code>#include &lt;<a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>&gt;</code></p>
107 <div class="dynheader">
108 Inheritance diagram for DebugQueueDescriptor:</div>
109 <div class="dyncontent">
110  <div class="center">
111   <img src="structarmnn_1_1_debug_queue_descriptor.png" usemap="#DebugQueueDescriptor_map" alt=""/>
112   <map id="DebugQueueDescriptor_map" name="DebugQueueDescriptor_map">
113 <area href="structarmnn_1_1_queue_descriptor.xhtml" alt="QueueDescriptor" shape="rect" coords="0,0,146,24"/>
114 </map>
115  </div></div>
116 <table class="memberdecls">
117 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
118 Public Member Functions</h2></td></tr>
119 <tr class="memitem:aa3a1f59f5a8e8ab4ca6dc4044fc776df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml#aa3a1f59f5a8e8ab4ca6dc4044fc776df">DebugQueueDescriptor</a> ()</td></tr>
120 <tr class="separator:aa3a1f59f5a8e8ab4ca6dc4044fc776df"><td class="memSeparator" colspan="2">&#160;</td></tr>
121 <tr class="memitem:a041e495449e22774a34d92b0904c10bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml#a041e495449e22774a34d92b0904c10bf">Validate</a> (const <a class="el" href="structarmnn_1_1_workload_info.xhtml">WorkloadInfo</a> &amp;workloadInfo) const</td></tr>
122 <tr class="separator:a041e495449e22774a34d92b0904c10bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
123 <tr class="inherit_header pub_methods_structarmnn_1_1_queue_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_queue_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a></td></tr>
124 <tr class="memitem:a765d2cee4ccce5b9467e0c2b6d25b84a inherit pub_methods_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a765d2cee4ccce5b9467e0c2b6d25b84a">ValidateInputsOutputs</a> (const std::string &amp;descName, unsigned int numExpectedIn, unsigned int numExpectedOut) const</td></tr>
125 <tr class="separator:a765d2cee4ccce5b9467e0c2b6d25b84a inherit pub_methods_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 </table><table class="memberdecls">
127 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
128 Public Attributes</h2></td></tr>
129 <tr class="memitem:a04f1026633579df1913f80db2877ce8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml#a04f1026633579df1913f80db2877ce8c">m_Guid</a></td></tr>
130 <tr class="separator:a04f1026633579df1913f80db2877ce8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 <tr class="memitem:a2b4595e9b6c840810995558801be6f6c"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml#a2b4595e9b6c840810995558801be6f6c">m_LayerName</a></td></tr>
132 <tr class="separator:a2b4595e9b6c840810995558801be6f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:ab53d42063d018ffebfceb019b26bf65a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml#ab53d42063d018ffebfceb019b26bf65a">m_SlotIndex</a></td></tr>
134 <tr class="separator:ab53d42063d018ffebfceb019b26bf65a"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="inherit_header pub_attribs_structarmnn_1_1_queue_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structarmnn_1_1_queue_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a></td></tr>
136 <tr class="memitem:a4b50e46a6810018f3edecfb68b2a76b3 inherit pub_attribs_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classarmnn_1_1_i_tensor_handle.xhtml">ITensorHandle</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a4b50e46a6810018f3edecfb68b2a76b3">m_Inputs</a></td></tr>
137 <tr class="separator:a4b50e46a6810018f3edecfb68b2a76b3 inherit pub_attribs_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a6abd491bb99ffe88bd472c1ae5a1ed1a inherit pub_attribs_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classarmnn_1_1_i_tensor_handle.xhtml">ITensorHandle</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a6abd491bb99ffe88bd472c1ae5a1ed1a">m_Outputs</a></td></tr>
139 <tr class="separator:a6abd491bb99ffe88bd472c1ae5a1ed1a inherit pub_attribs_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 </table><table class="memberdecls">
141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
142 Additional Inherited Members</h2></td></tr>
143 <tr class="inherit_header pro_methods_structarmnn_1_1_queue_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_structarmnn_1_1_queue_descriptor')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a></td></tr>
144 <tr class="memitem:af67c3785421c91d37fb22132d441f704 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#af67c3785421c91d37fb22132d441f704">~QueueDescriptor</a> ()=default</td></tr>
145 <tr class="separator:af67c3785421c91d37fb22132d441f704 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a40f14131fbead7c8eaf32b67eedd9e01 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a40f14131fbead7c8eaf32b67eedd9e01">QueueDescriptor</a> ()=default</td></tr>
147 <tr class="separator:a40f14131fbead7c8eaf32b67eedd9e01 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a75d3b85e1e50b1dff74ee84a593d089e inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a75d3b85e1e50b1dff74ee84a593d089e">QueueDescriptor</a> (<a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a> const &amp;)=default</td></tr>
149 <tr class="separator:a75d3b85e1e50b1dff74ee84a593d089e inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a1c928b975a0de05cf2536c721ba6b521 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_queue_descriptor.xhtml#a1c928b975a0de05cf2536c721ba6b521">operator=</a> (<a class="el" href="structarmnn_1_1_queue_descriptor.xhtml">QueueDescriptor</a> const &amp;)=default</td></tr>
151 <tr class="separator:a1c928b975a0de05cf2536c721ba6b521 inherit pro_methods_structarmnn_1_1_queue_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 </table>
153 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
154 <div class="textblock">
155 <p class="definition">Definition at line <a class="el" href="_workload_data_8hpp_source.xhtml#l00441">441</a> of file <a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>.</p>
156 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
157 <a id="aa3a1f59f5a8e8ab4ca6dc4044fc776df"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#aa3a1f59f5a8e8ab4ca6dc4044fc776df">&#9670;&nbsp;</a></span>DebugQueueDescriptor()</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162 <table class="mlabels">
163   <tr>
164   <td class="mlabels-left">
165       <table class="memname">
166         <tr>
167           <td class="memname"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml">DebugQueueDescriptor</a> </td>
168           <td>(</td>
169           <td class="paramname"></td><td>)</td>
170           <td></td>
171         </tr>
172       </table>
173   </td>
174   <td class="mlabels-right">
175 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
176   </tr>
177 </table>
178 </div><div class="memdoc">
179
180 <p class="definition">Definition at line <a class="el" href="_workload_data_8hpp_source.xhtml#l00443">443</a> of file <a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>.</p>
181 <div class="fragment"><div class="line"><a name="l00443"></a><span class="lineno">  443</span>&#160;: <a class="code" href="structarmnn_1_1_debug_queue_descriptor.xhtml#a04f1026633579df1913f80db2877ce8c">m_Guid</a>(0) {}</div><div class="ttc" id="structarmnn_1_1_debug_queue_descriptor_xhtml_a04f1026633579df1913f80db2877ce8c"><div class="ttname"><a href="structarmnn_1_1_debug_queue_descriptor.xhtml#a04f1026633579df1913f80db2877ce8c">armnn::DebugQueueDescriptor::m_Guid</a></div><div class="ttdeci">LayerGuid m_Guid</div><div class="ttdef"><b>Definition:</b> <a href="_workload_data_8hpp_source.xhtml#l00447">WorkloadData.hpp:447</a></div></div>
182 </div><!-- fragment -->
183 </div>
184 </div>
185 <h2 class="groupheader">Member Function Documentation</h2>
186 <a id="a041e495449e22774a34d92b0904c10bf"></a>
187 <h2 class="memtitle"><span class="permalink"><a href="#a041e495449e22774a34d92b0904c10bf">&#9670;&nbsp;</a></span>Validate()</h2>
188
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname">void Validate </td>
194           <td>(</td>
195           <td class="paramtype">const <a class="el" href="structarmnn_1_1_workload_info.xhtml">WorkloadInfo</a> &amp;&#160;</td>
196           <td class="paramname"><em>workloadInfo</em></td><td>)</td>
197           <td> const</td>
198         </tr>
199       </table>
200 </div><div class="memdoc">
201
202 <p class="definition">Definition at line <a class="el" href="_workload_data_8cpp_source.xhtml#l02369">2369</a> of file <a class="el" href="_workload_data_8cpp_source.xhtml">WorkloadData.cpp</a>.</p>
203 <div class="fragment"><div class="line"><a name="l02370"></a><span class="lineno"> 2370</span>&#160;{</div><div class="line"><a name="l02371"></a><span class="lineno"> 2371</span>&#160;    <span class="keyword">const</span> std::string descriptorName{<span class="stringliteral">&quot;DebugQueueDescriptor&quot;</span>};</div><div class="line"><a name="l02372"></a><span class="lineno"> 2372</span>&#160;</div><div class="line"><a name="l02373"></a><span class="lineno"> 2373</span>&#160;    ValidateNumInputs(workloadInfo,  descriptorName, 1);</div><div class="line"><a name="l02374"></a><span class="lineno"> 2374</span>&#160;    ValidateNumOutputs(workloadInfo, descriptorName, 1);</div><div class="line"><a name="l02375"></a><span class="lineno"> 2375</span>&#160;}</div></div><!-- fragment -->
204 </div>
205 </div>
206 <h2 class="groupheader">Member Data Documentation</h2>
207 <a id="a04f1026633579df1913f80db2877ce8c"></a>
208 <h2 class="memtitle"><span class="permalink"><a href="#a04f1026633579df1913f80db2877ce8c">&#9670;&nbsp;</a></span>m_Guid</h2>
209
210 <div class="memitem">
211 <div class="memproto">
212       <table class="memname">
213         <tr>
214           <td class="memname"><a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a> m_Guid</td>
215         </tr>
216       </table>
217 </div><div class="memdoc">
218
219 <p class="definition">Definition at line <a class="el" href="_workload_data_8hpp_source.xhtml#l00447">447</a> of file <a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>.</p>
220
221 <p class="reference">Referenced by <a class="el" href="_debug_layer_8cpp_source.xhtml#l00020">DebugLayer::CreateWorkload()</a>.</p>
222
223 </div>
224 </div>
225 <a id="a2b4595e9b6c840810995558801be6f6c"></a>
226 <h2 class="memtitle"><span class="permalink"><a href="#a2b4595e9b6c840810995558801be6f6c">&#9670;&nbsp;</a></span>m_LayerName</h2>
227
228 <div class="memitem">
229 <div class="memproto">
230       <table class="memname">
231         <tr>
232           <td class="memname">std::string m_LayerName</td>
233         </tr>
234       </table>
235 </div><div class="memdoc">
236
237 <p class="definition">Definition at line <a class="el" href="_workload_data_8hpp_source.xhtml#l00448">448</a> of file <a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>.</p>
238
239 <p class="reference">Referenced by <a class="el" href="_debug_layer_8cpp_source.xhtml#l00020">DebugLayer::CreateWorkload()</a>.</p>
240
241 </div>
242 </div>
243 <a id="ab53d42063d018ffebfceb019b26bf65a"></a>
244 <h2 class="memtitle"><span class="permalink"><a href="#ab53d42063d018ffebfceb019b26bf65a">&#9670;&nbsp;</a></span>m_SlotIndex</h2>
245
246 <div class="memitem">
247 <div class="memproto">
248       <table class="memname">
249         <tr>
250           <td class="memname">unsigned int m_SlotIndex</td>
251         </tr>
252       </table>
253 </div><div class="memdoc">
254
255 <p class="definition">Definition at line <a class="el" href="_workload_data_8hpp_source.xhtml#l00449">449</a> of file <a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a>.</p>
256
257 <p class="reference">Referenced by <a class="el" href="_debug_layer_8cpp_source.xhtml#l00020">DebugLayer::CreateWorkload()</a>.</p>
258
259 </div>
260 </div>
261 <hr/>The documentation for this struct was generated from the following files:<ul>
262 <li>src/backends/backendsCommon/<a class="el" href="_workload_data_8hpp_source.xhtml">WorkloadData.hpp</a></li>
263 <li>src/backends/backendsCommon/<a class="el" href="_workload_data_8cpp_source.xhtml">WorkloadData.cpp</a></li>
264 </ul>
265 </div><!-- contents -->
266 </div><!-- doc-content -->
267 <!-- start footer part -->
268 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
269   <ul>
270     <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_debug_queue_descriptor.xhtml">DebugQueueDescriptor</a></li>
271     <li class="footer">Generated on Fri Mar 13 2020 16:09:17 for ArmNN by
272     <a href="http://www.doxygen.org/index.html">
273     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
274   </ul>
275 </div>
276 </body>
277 </html>