blob: 472863fe7be37e0b2675e6b0f432a09c23115c43 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +00001<!-- 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: PermuteDescriptor 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">
56var 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_permute_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_permute_descriptor-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">PermuteDescriptor Struct Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p>A <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml" title="A PermuteDescriptor for the PermuteLayer. ">PermuteDescriptor</a> for the <a class="el" href="classarmnn_1_1_permute_layer.xhtml" title="This layer represents a permutation operation. ">PermuteLayer</a>.
107 <a href="structarmnn_1_1_permute_descriptor.xhtml#details">More...</a></p>
108
109<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>&gt;</code></p>
110<table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
112Public Member Functions</h2></td></tr>
113<tr class="memitem:a89323bcff3f2fad728ddb0ba2673049f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a89323bcff3f2fad728ddb0ba2673049f">PermuteDescriptor</a> ()</td></tr>
114<tr class="separator:a89323bcff3f2fad728ddb0ba2673049f"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:abaafe52396509f67f8cde6578c75df01"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#abaafe52396509f67f8cde6578c75df01">PermuteDescriptor</a> (const <a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> &amp;dimMappings)</td></tr>
116<tr class="separator:abaafe52396509f67f8cde6578c75df01"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:a515ce4ad34d652a553e685ff9abecb33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a515ce4ad34d652a553e685ff9abecb33">operator==</a> (const <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> &amp;rhs) const</td></tr>
118<tr class="separator:a515ce4ad34d652a553e685ff9abecb33"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table><table class="memberdecls">
120<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
121Public Attributes</h2></td></tr>
122<tr class="memitem:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a></td></tr>
123<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="#a14433af2b223695b40d8c8f8ba2ebb8f">More...</a><br /></td></tr>
124<tr class="separator:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml" title="A PermuteDescriptor for the PermuteLayer. ">PermuteDescriptor</a> for the <a class="el" href="classarmnn_1_1_permute_layer.xhtml" title="This layer represents a permutation operation. ">PermuteLayer</a>. </p>
128
129<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00102">102</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
130</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
131<a id="a89323bcff3f2fad728ddb0ba2673049f"></a>
132<h2 class="memtitle"><span class="permalink"><a href="#a89323bcff3f2fad728ddb0ba2673049f">&#9670;&nbsp;</a></span>PermuteDescriptor() <span class="overload">[1/2]</span></h2>
133
134<div class="memitem">
135<div class="memproto">
136<table class="mlabels">
137 <tr>
138 <td class="mlabels-left">
139 <table class="memname">
140 <tr>
141 <td class="memname"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> </td>
142 <td>(</td>
143 <td class="paramname"></td><td>)</td>
144 <td></td>
145 </tr>
146 </table>
147 </td>
148 <td class="mlabels-right">
149<span class="mlabels"><span class="mlabel">inline</span></span> </td>
150 </tr>
151</table>
152</div><div class="memdoc">
153
154<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00104">104</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
155<div class="fragment"><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; : <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>{}</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::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, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div>
156</div><!-- fragment -->
157</div>
158</div>
159<a id="abaafe52396509f67f8cde6578c75df01"></a>
160<h2 class="memtitle"><span class="permalink"><a href="#abaafe52396509f67f8cde6578c75df01">&#9670;&nbsp;</a></span>PermuteDescriptor() <span class="overload">[2/2]</span></h2>
161
162<div class="memitem">
163<div class="memproto">
164<table class="mlabels">
165 <tr>
166 <td class="mlabels-left">
167 <table class="memname">
168 <tr>
169 <td class="memname"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> </td>
170 <td>(</td>
171 <td class="paramtype">const <a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> &amp;&#160;</td>
172 <td class="paramname"><em>dimMappings</em></td><td>)</td>
173 <td></td>
174 </tr>
175 </table>
176 </td>
177 <td class="mlabels-right">
178<span class="mlabels"><span class="mlabel">inline</span></span> </td>
179 </tr>
180</table>
181</div><div class="memdoc">
182
183<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00108">108</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
184<div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; : <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>(dimMappings)</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::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, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div>
185</div><!-- fragment -->
186</div>
187</div>
188<h2 class="groupheader">Member Function Documentation</h2>
189<a id="a515ce4ad34d652a553e685ff9abecb33"></a>
190<h2 class="memtitle"><span class="permalink"><a href="#a515ce4ad34d652a553e685ff9abecb33">&#9670;&nbsp;</a></span>operator==()</h2>
191
192<div class="memitem">
193<div class="memproto">
194<table class="mlabels">
195 <tr>
196 <td class="mlabels-left">
197 <table class="memname">
198 <tr>
199 <td class="memname">bool operator== </td>
200 <td>(</td>
201 <td class="paramtype">const <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> &amp;&#160;</td>
202 <td class="paramname"><em>rhs</em></td><td>)</td>
203 <td> const</td>
204 </tr>
205 </table>
206 </td>
207 <td class="mlabels-right">
208<span class="mlabels"><span class="mlabel">inline</span></span> </td>
209 </tr>
210</table>
211</div><div class="memdoc">
212
213<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00112">112</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
214
215<p class="reference">References <a class="el" href="_descriptors_8hpp_source.xhtml#l00119">PermuteDescriptor::m_DimMappings</a>.</p>
216<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>.<a class="code" href="classarmnn_1_1_permutation_vector.xhtml#aae44e4154aa80fba7616747450ff69d5">IsEqual</a>(rhs.m_DimMappings);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::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, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div>
217<div class="ttc" id="classarmnn_1_1_permutation_vector_xhtml_aae44e4154aa80fba7616747450ff69d5"><div class="ttname"><a href="classarmnn_1_1_permutation_vector.xhtml#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.xhtml#l00207">Types.hpp:207</a></div></div>
218</div><!-- fragment -->
219</div>
220</div>
221<h2 class="groupheader">Member Data Documentation</h2>
222<a id="a14433af2b223695b40d8c8f8ba2ebb8f"></a>
223<h2 class="memtitle"><span class="permalink"><a href="#a14433af2b223695b40d8c8f8ba2ebb8f">&#9670;&nbsp;</a></span>m_DimMappings</h2>
224
225<div class="memitem">
226<div class="memproto">
227 <table class="memname">
228 <tr>
229 <td class="memname"><a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> m_DimMappings</td>
230 </tr>
231 </table>
232</div><div class="memdoc">
233
234<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>
235<p>{0U, 3U, 1U, 2U}. </p>
236
237<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00119">119</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
238
239<p class="reference">Referenced by <a class="el" href="_permute_layer_8hpp_source.xhtml#l00037">PermuteLayer::GetPermutation()</a>, <a class="el" href="_permute_layer_8cpp_source.xhtml#l00036">PermuteLayer::InferOutputShapes()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00112">PermuteDescriptor::operator==()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00107">PermuteValueSet1Test()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00157">PermuteValueSet2Test()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00207">PermuteValueSet3Test()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00014">StringifyLayerParameters&lt; PermuteDescriptor &gt;::Serialize()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00058">SimplePermuteTest()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00801">SerializerVisitor::VisitPermuteLayer()</a>.</p>
240
241</div>
242</div>
243<hr/>The documentation for this struct was generated from the following file:<ul>
244<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a></li>
245</ul>
246</div><!-- contents -->
247</div><!-- doc-content -->
248<!-- start footer part -->
249<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
250 <ul>
251 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a></li>
252 <li class="footer">Generated on Fri Mar 13 2020 16:09:19 for ArmNN by
253 <a href="http://www.doxygen.org/index.html">
254 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
255 </ul>
256</div>
257</body>
258</html>