Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / fdad393d5611dad69f65f9765c9472fc41cbcfe4 / . / Documentation / structarmnn_1_1_pad_descriptor.xhtml
blob: 350aa267210a355b912743f4bb3e69e996180bc6 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]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: PadDescriptor 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_pad_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_pad_descriptor-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">PadDescriptor Struct Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p>A <a class="el" href="structarmnn_1_1_pad_descriptor.xhtml" title="A PadDescriptor for the PadLayer. ">PadDescriptor</a> for the <a class="el" href="classarmnn_1_1_pad_layer.xhtml" title="This layer represents a pad operation. ">PadLayer</a>.
107 <a href="structarmnn_1_1_pad_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:abf96ff8314156a991f72d107d4f325ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml#abf96ff8314156a991f72d107d4f325ce">PadDescriptor</a> ()</td></tr>
114<tr class="separator:abf96ff8314156a991f72d107d4f325ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:a66868daa768672bfda2d019a9d2c43ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml#a66868daa768672bfda2d019a9d2c43ca">PadDescriptor</a> (const std::vector&lt; std::pair&lt; unsigned int, unsigned int &gt;&gt; &amp;padList, const float &amp;padValue=0)</td></tr>
116<tr class="separator:a66868daa768672bfda2d019a9d2c43ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:acd6df4cac247b20fb2b6a1077299cb1f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml#acd6df4cac247b20fb2b6a1077299cb1f">operator==</a> (const <a class="el" href="structarmnn_1_1_pad_descriptor.xhtml">PadDescriptor</a> &amp;rhs) const</td></tr>
118<tr class="separator:acd6df4cac247b20fb2b6a1077299cb1f"><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:a85f98c94e11f65a6b73f831735c040f3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::pair&lt; unsigned int, unsigned int &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml#a85f98c94e11f65a6b73f831735c040f3">m_PadList</a></td></tr>
123<tr class="memdesc:a85f98c94e11f65a6b73f831735c040f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the padding for input dimension. <a href="#a85f98c94e11f65a6b73f831735c040f3">More...</a><br /></td></tr>
124<tr class="separator:a85f98c94e11f65a6b73f831735c040f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a410fa919f78af0f0f100bd1594eca4ab"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">m_PadValue</a></td></tr>
126<tr class="memdesc:a410fa919f78af0f0f100bd1594eca4ab"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a> value to use for padding, defaults to 0. <a href="#a410fa919f78af0f0f100bd1594eca4ab">More...</a><br /></td></tr>
127<tr class="separator:a410fa919f78af0f0f100bd1594eca4ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table>
129<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_pad_descriptor.xhtml" title="A PadDescriptor for the PadLayer. ">PadDescriptor</a> for the <a class="el" href="classarmnn_1_1_pad_layer.xhtml" title="This layer represents a pad operation. ">PadLayer</a>. </p>
131
132<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00901">901</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
133</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
134<a id="abf96ff8314156a991f72d107d4f325ce"></a>
135<h2 class="memtitle"><span class="permalink"><a href="#abf96ff8314156a991f72d107d4f325ce">&#9670;&nbsp;</a></span>PadDescriptor() <span class="overload">[1/2]</span></h2>
136
137<div class="memitem">
138<div class="memproto">
139<table class="mlabels">
140 <tr>
141 <td class="mlabels-left">
142 <table class="memname">
143 <tr>
144 <td class="memname"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml">PadDescriptor</a> </td>
145 <td>(</td>
146 <td class="paramname"></td><td>)</td>
147 <td></td>
148 </tr>
149 </table>
150 </td>
151 <td class="mlabels-right">
152<span class="mlabels"><span class="mlabel">inline</span></span> </td>
153 </tr>
154</table>
155</div><div class="memdoc">
156
157<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00903">903</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
158<div class="fragment"><div class="line"><a name="l00903"></a><span class="lineno"> 903</span>&#160; : <a class="code" href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">m_PadValue</a>(0)</div><div class="line"><a name="l00904"></a><span class="lineno"> 904</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_pad_descriptor_xhtml_a410fa919f78af0f0f100bd1594eca4ab"><div class="ttname"><a href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">armnn::PadDescriptor::m_PadValue</a></div><div class="ttdeci">float m_PadValue</div><div class="ttdoc">Optional value to use for padding, defaults to 0. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00923">Descriptors.hpp:923</a></div></div>
159</div><!-- fragment -->
160</div>
161</div>
162<a id="a66868daa768672bfda2d019a9d2c43ca"></a>
163<h2 class="memtitle"><span class="permalink"><a href="#a66868daa768672bfda2d019a9d2c43ca">&#9670;&nbsp;</a></span>PadDescriptor() <span class="overload">[2/2]</span></h2>
164
165<div class="memitem">
166<div class="memproto">
167<table class="mlabels">
168 <tr>
169 <td class="mlabels-left">
170 <table class="memname">
171 <tr>
172 <td class="memname"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml">PadDescriptor</a> </td>
173 <td>(</td>
174 <td class="paramtype">const std::vector&lt; std::pair&lt; unsigned int, unsigned int &gt;&gt; &amp;&#160;</td>
175 <td class="paramname"><em>padList</em>, </td>
176 </tr>
177 <tr>
178 <td class="paramkey"></td>
179 <td></td>
180 <td class="paramtype">const float &amp;&#160;</td>
181 <td class="paramname"><em>padValue</em> = <code>0</code>&#160;</td>
182 </tr>
183 <tr>
184 <td></td>
185 <td>)</td>
186 <td></td><td></td>
187 </tr>
188 </table>
189 </td>
190 <td class="mlabels-right">
191<span class="mlabels"><span class="mlabel">inline</span></span> </td>
192 </tr>
193</table>
194</div><div class="memdoc">
195
196<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00906">906</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
197<div class="fragment"><div class="line"><a name="l00907"></a><span class="lineno"> 907</span>&#160; : <a class="code" href="structarmnn_1_1_pad_descriptor.xhtml#a85f98c94e11f65a6b73f831735c040f3">m_PadList</a>(padList)</div><div class="line"><a name="l00908"></a><span class="lineno"> 908</span>&#160; , <a class="code" href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">m_PadValue</a>(padValue)</div><div class="line"><a name="l00909"></a><span class="lineno"> 909</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_pad_descriptor_xhtml_a410fa919f78af0f0f100bd1594eca4ab"><div class="ttname"><a href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">armnn::PadDescriptor::m_PadValue</a></div><div class="ttdeci">float m_PadValue</div><div class="ttdoc">Optional value to use for padding, defaults to 0. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00923">Descriptors.hpp:923</a></div></div>
198<div class="ttc" id="structarmnn_1_1_pad_descriptor_xhtml_a85f98c94e11f65a6b73f831735c040f3"><div class="ttname"><a href="structarmnn_1_1_pad_descriptor.xhtml#a85f98c94e11f65a6b73f831735c040f3">armnn::PadDescriptor::m_PadList</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; unsigned int, unsigned int &gt; &gt; m_PadList</div><div class="ttdoc">Specifies the padding for input dimension. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00920">Descriptors.hpp:920</a></div></div>
199</div><!-- fragment -->
200</div>
201</div>
202<h2 class="groupheader">Member Function Documentation</h2>
203<a id="acd6df4cac247b20fb2b6a1077299cb1f"></a>
204<h2 class="memtitle"><span class="permalink"><a href="#acd6df4cac247b20fb2b6a1077299cb1f">&#9670;&nbsp;</a></span>operator==()</h2>
205
206<div class="memitem">
207<div class="memproto">
208<table class="mlabels">
209 <tr>
210 <td class="mlabels-left">
211 <table class="memname">
212 <tr>
213 <td class="memname">bool operator== </td>
214 <td>(</td>
215 <td class="paramtype">const <a class="el" href="structarmnn_1_1_pad_descriptor.xhtml">PadDescriptor</a> &amp;&#160;</td>
216 <td class="paramname"><em>rhs</em></td><td>)</td>
217 <td> const</td>
218 </tr>
219 </table>
220 </td>
221 <td class="mlabels-right">
222<span class="mlabels"><span class="mlabel">inline</span></span> </td>
223 </tr>
224</table>
225</div><div class="memdoc">
226
227<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00911">911</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
228
229<p class="reference">References <a class="el" href="_descriptors_8hpp_source.xhtml#l00920">PadDescriptor::m_PadList</a>, and <a class="el" href="_descriptors_8hpp_source.xhtml#l00923">PadDescriptor::m_PadValue</a>.</p>
230<div class="fragment"><div class="line"><a name="l00912"></a><span class="lineno"> 912</span>&#160; {</div><div class="line"><a name="l00913"></a><span class="lineno"> 913</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_pad_descriptor.xhtml#a85f98c94e11f65a6b73f831735c040f3">m_PadList</a> == rhs.m_PadList &amp;&amp; <a class="code" href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">m_PadValue</a> == rhs.m_PadValue;</div><div class="line"><a name="l00914"></a><span class="lineno"> 914</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_pad_descriptor_xhtml_a410fa919f78af0f0f100bd1594eca4ab"><div class="ttname"><a href="structarmnn_1_1_pad_descriptor.xhtml#a410fa919f78af0f0f100bd1594eca4ab">armnn::PadDescriptor::m_PadValue</a></div><div class="ttdeci">float m_PadValue</div><div class="ttdoc">Optional value to use for padding, defaults to 0. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00923">Descriptors.hpp:923</a></div></div>
231<div class="ttc" id="structarmnn_1_1_pad_descriptor_xhtml_a85f98c94e11f65a6b73f831735c040f3"><div class="ttname"><a href="structarmnn_1_1_pad_descriptor.xhtml#a85f98c94e11f65a6b73f831735c040f3">armnn::PadDescriptor::m_PadList</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; unsigned int, unsigned int &gt; &gt; m_PadList</div><div class="ttdoc">Specifies the padding for input dimension. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00920">Descriptors.hpp:920</a></div></div>
232</div><!-- fragment -->
233</div>
234</div>
235<h2 class="groupheader">Member Data Documentation</h2>
236<a id="a85f98c94e11f65a6b73f831735c040f3"></a>
237<h2 class="memtitle"><span class="permalink"><a href="#a85f98c94e11f65a6b73f831735c040f3">&#9670;&nbsp;</a></span>m_PadList</h2>
238
239<div class="memitem">
240<div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">std::vector&lt;std::pair&lt;unsigned int, unsigned int&gt; &gt; m_PadList</td>
244 </tr>
245 </table>
246</div><div class="memdoc">
247
248<p>Specifies the padding for input dimension. </p>
249<p>First is the number of values to add before the tensor in the dimension. Second is the number of values to add after the tensor in the dimension. The number of pairs should match the number of dimensions in the input tensor. </p>
250
251<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00920">920</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
252
253<p class="reference">Referenced by <a class="el" href="_pad_layer_8cpp_source.xhtml#l00030">PadLayer::Clone()</a>, <a class="el" href="_cl_pad_workload_8cpp_source.xhtml#l00018">ClPadWorkload::ClPadWorkload()</a>, <a class="el" href="_pad_layer_8cpp_source.xhtml#l00022">PadLayer::CreateWorkload()</a>, <a class="el" href="_neon_pad_workload_8cpp_source.xhtml#l00019">NeonPadWorkload::NeonPadWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00911">PadDescriptor::operator==()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.xhtml#l01463">TfLiteParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_pad_test_impl_8cpp_source.xhtml#l00020">Pad2dTestCommon()</a>, <a class="el" href="_pad_test_impl_8cpp_source.xhtml#l00093">Pad3dTestCommon()</a>, <a class="el" href="_pad_test_impl_8cpp_source.xhtml#l00177">Pad4dTestCommon()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00380">StringifyLayerParameters&lt; PadDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00775">SerializerVisitor::VisitPadLayer()</a>.</p>
254
255</div>
256</div>
257<a id="a410fa919f78af0f0f100bd1594eca4ab"></a>
258<h2 class="memtitle"><span class="permalink"><a href="#a410fa919f78af0f0f100bd1594eca4ab">&#9670;&nbsp;</a></span>m_PadValue</h2>
259
260<div class="memitem">
261<div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">float m_PadValue</td>
265 </tr>
266 </table>
267</div><div class="memdoc">
268
269<p><a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a> value to use for padding, defaults to 0. </p>
270
271<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00923">923</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
272
273<p class="reference">Referenced by <a class="el" href="_descriptors_8hpp_source.xhtml#l00911">PadDescriptor::operator==()</a>, <a class="el" href="_pad_test_impl_8cpp_source.xhtml#l00020">Pad2dTestCommon()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00380">StringifyLayerParameters&lt; PadDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00775">SerializerVisitor::VisitPadLayer()</a>.</p>
274
275</div>
276</div>
277<hr/>The documentation for this struct was generated from the following file:<ul>
278<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a></li>
279</ul>
280</div><!-- contents -->
281</div><!-- doc-content -->
282<!-- start footer part -->
283<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
284 <ul>
285 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_pad_descriptor.xhtml">PadDescriptor</a></li>
286 <li class="footer">Generated on Fri Mar 13 2020 16:09:19 for ArmNN by
287 <a href="http://www.doxygen.org/index.html">
288 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
289 </ul>
290</div>
291</body>
292</html>