blob: ff6b17a2e75e19a0e7d26e3e5b2f92c534338f98 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +00001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: TransposeDescriptor Struct 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<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('structarmnn_1_1_transpose_descriptor.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="#pub-attribs">Public Attributes</a> &#124;
98<a href="structarmnn_1_1_transpose_descriptor-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">TransposeDescriptor Struct Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p>A <a class="el" href="structarmnn_1_1_transpose_descriptor.html" title="A TransposeDescriptor for the TransposeLayer.">TransposeDescriptor</a> for the <a class="el" href="classarmnn_1_1_transpose_layer.html" title="This layer represents a transpose operation.">TransposeLayer</a>.
105 <a href="structarmnn_1_1_transpose_descriptor.html#details">More...</a></p>
106
107<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>&gt;</code></p>
108<div class="dynheader">
109Inheritance diagram for TransposeDescriptor:</div>
110<div class="dyncontent">
111<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_transpose_descriptor__inherit__graph.svg" width="166" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
112</div>
113<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
114<div class="dynheader">
115Collaboration diagram for TransposeDescriptor:</div>
116<div class="dyncontent">
117<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_transpose_descriptor__coll__graph.svg" width="308" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
118</div>
119<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:af4d882230882f20ef1500510e5ff4c87"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_transpose_descriptor.html#af4d882230882f20ef1500510e5ff4c87">TransposeDescriptor</a> ()</td></tr>
124<tr class="separator:af4d882230882f20ef1500510e5ff4c87"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:ae7fbf819ce2bbdbdc55d546dd40a1213"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_transpose_descriptor.html#ae7fbf819ce2bbdbdc55d546dd40a1213">TransposeDescriptor</a> (const <a class="el" href="classarmnn_1_1_permutation_vector.html">PermutationVector</a> &amp;dimMappings)</td></tr>
126<tr class="separator:ae7fbf819ce2bbdbdc55d546dd40a1213"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a08d0e3a8b7b074f7c101366f0d431c47"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_transpose_descriptor.html#a08d0e3a8b7b074f7c101366f0d431c47">operator==</a> (const <a class="el" href="structarmnn_1_1_transpose_descriptor.html">TransposeDescriptor</a> &amp;rhs) const</td></tr>
128<tr class="separator:a08d0e3a8b7b074f7c101366f0d431c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="inherit_header pub_methods_structarmnn_1_1_base_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_base_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a></td></tr>
130<tr class="memitem:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#ac618666b3c6d65d2c88bcbb7abeed343">IsNull</a> () const</td></tr>
131<tr class="separator:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#a5e0f82ef2f18eb897e6d6f1845e74033">~BaseDescriptor</a> ()=default</td></tr>
133<tr class="separator:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
134</table><table class="memberdecls">
135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
136Public Attributes</h2></td></tr>
137<tr class="memitem:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_permutation_vector.html">PermutationVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a></td></tr>
138<tr class="memdesc:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. <a href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">More...</a><br /></td></tr>
139<tr class="separator:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
140</table>
141<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
142<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_transpose_descriptor.html" title="A TransposeDescriptor for the TransposeLayer.">TransposeDescriptor</a> for the <a class="el" href="classarmnn_1_1_transpose_layer.html" title="This layer represents a transpose operation.">TransposeLayer</a>. </p>
143
144<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l01490">1490</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
145</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
146<a id="af4d882230882f20ef1500510e5ff4c87"></a>
147<h2 class="memtitle"><span class="permalink"><a href="#af4d882230882f20ef1500510e5ff4c87">&#9670;&nbsp;</a></span>TransposeDescriptor() <span class="overload">[1/2]</span></h2>
148
149<div class="memitem">
150<div class="memproto">
151<table class="mlabels">
152 <tr>
153 <td class="mlabels-left">
154 <table class="memname">
155 <tr>
156 <td class="memname"><a class="el" href="structarmnn_1_1_transpose_descriptor.html">TransposeDescriptor</a> </td>
157 <td>(</td>
158 <td class="paramname"></td><td>)</td>
159 <td></td>
160 </tr>
161 </table>
162 </td>
163 <td class="mlabels-right">
164<span class="mlabels"><span class="mlabel">inline</span></span> </td>
165 </tr>
166</table>
167</div><div class="memdoc">
168
169<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l01492">1492</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
170<div class="fragment"><div class="line"><a name="l01493"></a><span class="lineno"> 1493</span>&#160; : <a class="code" href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>{}</div>
171<div class="line"><a name="l01494"></a><span class="lineno"> 1494</span>&#160; {}</div>
172</div><!-- fragment -->
173</div>
174</div>
175<a id="ae7fbf819ce2bbdbdc55d546dd40a1213"></a>
176<h2 class="memtitle"><span class="permalink"><a href="#ae7fbf819ce2bbdbdc55d546dd40a1213">&#9670;&nbsp;</a></span>TransposeDescriptor() <span class="overload">[2/2]</span></h2>
177
178<div class="memitem">
179<div class="memproto">
180<table class="mlabels">
181 <tr>
182 <td class="mlabels-left">
183 <table class="memname">
184 <tr>
185 <td class="memname"><a class="el" href="structarmnn_1_1_transpose_descriptor.html">TransposeDescriptor</a> </td>
186 <td>(</td>
187 <td class="paramtype">const <a class="el" href="classarmnn_1_1_permutation_vector.html">PermutationVector</a> &amp;&#160;</td>
188 <td class="paramname"><em>dimMappings</em></td><td>)</td>
189 <td></td>
190 </tr>
191 </table>
192 </td>
193 <td class="mlabels-right">
194<span class="mlabels"><span class="mlabel">inline</span></span> </td>
195 </tr>
196</table>
197</div><div class="memdoc">
198
199<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l01496">1496</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
200<div class="fragment"><div class="line"><a name="l01497"></a><span class="lineno"> 1497</span>&#160; : <a class="code" href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>(dimMappings)</div>
201<div class="line"><a name="l01498"></a><span class="lineno"> 1498</span>&#160; {}</div>
202</div><!-- fragment -->
203</div>
204</div>
205<h2 class="groupheader">Member Function Documentation</h2>
206<a id="a08d0e3a8b7b074f7c101366f0d431c47"></a>
207<h2 class="memtitle"><span class="permalink"><a href="#a08d0e3a8b7b074f7c101366f0d431c47">&#9670;&nbsp;</a></span>operator==()</h2>
208
209<div class="memitem">
210<div class="memproto">
211<table class="mlabels">
212 <tr>
213 <td class="mlabels-left">
214 <table class="memname">
215 <tr>
216 <td class="memname">bool operator== </td>
217 <td>(</td>
218 <td class="paramtype">const <a class="el" href="structarmnn_1_1_transpose_descriptor.html">TransposeDescriptor</a> &amp;&#160;</td>
219 <td class="paramname"><em>rhs</em></td><td>)</td>
220 <td> const</td>
221 </tr>
222 </table>
223 </td>
224 <td class="mlabels-right">
225<span class="mlabels"><span class="mlabel">inline</span></span> </td>
226 </tr>
227</table>
228</div><div class="memdoc">
229
230<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l01500">1500</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
231<div class="fragment"><div class="line"><a name="l01501"></a><span class="lineno"> 1501</span>&#160; {</div>
232<div class="line"><a name="l01502"></a><span class="lineno"> 1502</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>.<a class="code" href="classarmnn_1_1_permutation_vector.html#aae44e4154aa80fba7616747450ff69d5">IsEqual</a>(rhs.m_DimMappings);</div>
233<div class="line"><a name="l01503"></a><span class="lineno"> 1503</span>&#160; }</div>
234</div><!-- fragment -->
235<p class="reference">References <a class="el" href="_types_8hpp_source.html#l00366">PermutationVector::IsEqual()</a>, and <a class="el" href="_descriptors_8hpp_source.html#l01514">TransposeDescriptor::m_DimMappings</a>.</p>
236
237</div>
238</div>
239<h2 class="groupheader">Member Data Documentation</h2>
240<a id="a14433af2b223695b40d8c8f8ba2ebb8f"></a>
241<h2 class="memtitle"><span class="permalink"><a href="#a14433af2b223695b40d8c8f8ba2ebb8f">&#9670;&nbsp;</a></span>m_DimMappings</h2>
242
243<div class="memitem">
244<div class="memproto">
245 <table class="memname">
246 <tr>
247 <td class="memname"><a class="el" href="classarmnn_1_1_permutation_vector.html">PermutationVector</a> m_DimMappings</td>
248 </tr>
249 </table>
250</div><div class="memdoc">
251
252<p>Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. </p>
253<p>Input Shape {1, 1, 4, 4} Permutation Vector {0, 2, 3, 1} Output Shape {1, 4, 4, 1} dim "0" of input goes into index 0 ([ 1, X, X, X]) dim "2" of input goes into index 1 ([ 1, 4, X, X ]) dim "3" of input goes into index 2 ([ 1, 4, 4, X ]) dim "1" of input goes into index 3 ([ 1, 4, 4, 1 ]) </p>
254
255<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l01514">1514</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
256
257<p class="reference">Referenced by <a class="el" href="_cl_transpose_workload_8cpp_source.html#l00029">ClTransposeWorkload::ClTransposeWorkload()</a>, <a class="el" href="_transpose_operator_8cpp_source.html#l00008">ConvertTransposeToTosaOperator()</a>, <a class="el" href="_transpose_layer_8hpp_source.html#l00037">TransposeLayer::GetPermutation()</a>, <a class="el" href="_transpose_layer_8cpp_source.html#l00038">TransposeLayer::InferOutputShapes()</a>, <a class="el" href="_neon_transpose_workload_8cpp_source.html#l00027">NeonTransposeWorkload::NeonTransposeWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.html#l01500">TransposeDescriptor::operator==()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00608">StringifyLayerParameters&lt; TransposeDescriptor &gt;::Serialize()</a>, and <a class="el" href="_workload_data_8cpp_source.html#l03104">TransposeQueueDescriptor::Validate()</a>.</p>
258
259</div>
260</div>
261<hr/>The documentation for this struct was generated from the following file:<ul>
262<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
263</ul>
264</div><!-- contents -->
265</div><!-- doc-content -->
266<div class="ttc" id="aclassarmnn_1_1_permutation_vector_html_aae44e4154aa80fba7616747450ff69d5"><div class="ttname"><a href="classarmnn_1_1_permutation_vector.html#aae44e4154aa80fba7616747450ff69d5">armnn::PermutationVector::IsEqual</a></div><div class="ttdeci">bool IsEqual(const PermutationVector &amp;other) const</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00366">Types.hpp:366</a></div></div>
267<div class="ttc" id="astructarmnn_1_1_transpose_descriptor_html_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_transpose_descriptor.html#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::TransposeDescriptor::m_DimMappings</a></div><div class="ttdeci">PermutationVector m_DimMappings</div><div class="ttdoc">Indicates how to translate tensor elements from a given source into the target destination,...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l01514">Descriptors.hpp:1514</a></div></div>
268<!-- start footer part -->
269<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
270 <ul>
271 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_transpose_descriptor.html">TransposeDescriptor</a></li>
272 <li class="footer">Generated on Wed Feb 14 2024 16:36:25 for Arm NN by
273 <a href="http://www.doxygen.org/index.html">
274 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
275 </ul>
276</div>
277</body>
278</html>