Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 7ddbbae7ad3e0000d8e6a76458cac68254dc8048 / . / Documentation / structarmnn_1_1_mean_descriptor.html
blob: 8feeb12be45a89d4353463ae4a40bce718592476 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: MeanDescriptor Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('structarmnn_1_1_mean_descriptor.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="#pub-attribs">Public Attributes</a> &#124;
86<a href="structarmnn_1_1_mean_descriptor-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">MeanDescriptor Struct Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p>A <a class="el" href="structarmnn_1_1_mean_descriptor.html" title="A MeanDescriptor for the MeanLayer. ">MeanDescriptor</a> for the <a class="el" href="classarmnn_1_1_mean_layer.html" title="This layer represents a mean operation. ">MeanLayer</a>.
93 <a href="structarmnn_1_1_mean_descriptor.html#details">More...</a></p>
94
95<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>&gt;</code></p>
96<table class="memberdecls">
97<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
98Public Member Functions</h2></td></tr>
99<tr class="memitem:a71ab37b5cafc60ab26a1728354cafe77"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mean_descriptor.html#a71ab37b5cafc60ab26a1728354cafe77">MeanDescriptor</a> ()</td></tr>
100<tr class="separator:a71ab37b5cafc60ab26a1728354cafe77"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:aeb36ba495f90f46580887217835290ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mean_descriptor.html#aeb36ba495f90f46580887217835290ba">MeanDescriptor</a> (const std::vector&lt; unsigned int &gt; &amp;axis, bool keepDims)</td></tr>
102<tr class="separator:aeb36ba495f90f46580887217835290ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
103<tr class="memitem:a45ddc9ab5e076c7740d54e0fb74f104c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mean_descriptor.html#a45ddc9ab5e076c7740d54e0fb74f104c">operator==</a> (const <a class="el" href="structarmnn_1_1_mean_descriptor.html">MeanDescriptor</a> &amp;rhs) const</td></tr>
104<tr class="separator:a45ddc9ab5e076c7740d54e0fb74f104c"><td class="memSeparator" colspan="2">&#160;</td></tr>
105</table><table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
107Public Attributes</h2></td></tr>
108<tr class="memitem:a1f0d67b087c491248bd1cde3ff995a95"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">m_Axis</a></td></tr>
109<tr class="memdesc:a1f0d67b087c491248bd1cde3ff995a95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Values for the dimensions to reduce. <a href="#a1f0d67b087c491248bd1cde3ff995a95">More...</a><br /></td></tr>
110<tr class="separator:a1f0d67b087c491248bd1cde3ff995a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:a28e0548abfc4e79c48f29a3d11a062e9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">m_KeepDims</a></td></tr>
112<tr class="memdesc:a28e0548abfc4e79c48f29a3d11a062e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept. <a href="#a28e0548abfc4e79c48f29a3d11a062e9">More...</a><br /></td></tr>
113<tr class="separator:a28e0548abfc4e79c48f29a3d11a062e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
114</table>
115<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
116<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_mean_descriptor.html" title="A MeanDescriptor for the MeanLayer. ">MeanDescriptor</a> for the <a class="el" href="classarmnn_1_1_mean_layer.html" title="This layer represents a mean operation. ">MeanLayer</a>. </p>
117
118<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00877">877</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
119</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
120<a id="a71ab37b5cafc60ab26a1728354cafe77"></a>
121<h2 class="memtitle"><span class="permalink"><a href="#a71ab37b5cafc60ab26a1728354cafe77">&#9670;&nbsp;</a></span>MeanDescriptor() <span class="overload">[1/2]</span></h2>
122
123<div class="memitem">
124<div class="memproto">
125<table class="mlabels">
126 <tr>
127 <td class="mlabels-left">
128 <table class="memname">
129 <tr>
130 <td class="memname"><a class="el" href="structarmnn_1_1_mean_descriptor.html">MeanDescriptor</a> </td>
131 <td>(</td>
132 <td class="paramname"></td><td>)</td>
133 <td></td>
134 </tr>
135 </table>
136 </td>
137 <td class="mlabels-right">
138<span class="mlabels"><span class="mlabel">inline</span></span> </td>
139 </tr>
140</table>
141</div><div class="memdoc">
142
143<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00879">879</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
144<div class="fragment"><div class="line"><a name="l00880"></a><span class="lineno"> 880</span>&#160; : <a class="code" href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">m_Axis</a>()</div><div class="line"><a name="l00881"></a><span class="lineno"> 881</span>&#160; , <a class="code" href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">m_KeepDims</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00882"></a><span class="lineno"> 882</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a1f0d67b087c491248bd1cde3ff995a95"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">armnn::MeanDescriptor::m_Axis</a></div><div class="ttdeci">std::vector&lt; unsigned int &gt; m_Axis</div><div class="ttdoc">Values for the dimensions to reduce. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00895">Descriptors.hpp:895</a></div></div>
145<div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a28e0548abfc4e79c48f29a3d11a062e9"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">armnn::MeanDescriptor::m_KeepDims</a></div><div class="ttdeci">bool m_KeepDims</div><div class="ttdoc">Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00897">Descriptors.hpp:897</a></div></div>
146</div><!-- fragment -->
147</div>
148</div>
149<a id="aeb36ba495f90f46580887217835290ba"></a>
150<h2 class="memtitle"><span class="permalink"><a href="#aeb36ba495f90f46580887217835290ba">&#9670;&nbsp;</a></span>MeanDescriptor() <span class="overload">[2/2]</span></h2>
151
152<div class="memitem">
153<div class="memproto">
154<table class="mlabels">
155 <tr>
156 <td class="mlabels-left">
157 <table class="memname">
158 <tr>
159 <td class="memname"><a class="el" href="structarmnn_1_1_mean_descriptor.html">MeanDescriptor</a> </td>
160 <td>(</td>
161 <td class="paramtype">const std::vector&lt; unsigned int &gt; &amp;&#160;</td>
162 <td class="paramname"><em>axis</em>, </td>
163 </tr>
164 <tr>
165 <td class="paramkey"></td>
166 <td></td>
167 <td class="paramtype">bool&#160;</td>
168 <td class="paramname"><em>keepDims</em>&#160;</td>
169 </tr>
170 <tr>
171 <td></td>
172 <td>)</td>
173 <td></td><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.html#l00884">884</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
184<div class="fragment"><div class="line"><a name="l00885"></a><span class="lineno"> 885</span>&#160; : <a class="code" href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">m_Axis</a>(axis)</div><div class="line"><a name="l00886"></a><span class="lineno"> 886</span>&#160; , <a class="code" href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">m_KeepDims</a>(keepDims)</div><div class="line"><a name="l00887"></a><span class="lineno"> 887</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a1f0d67b087c491248bd1cde3ff995a95"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">armnn::MeanDescriptor::m_Axis</a></div><div class="ttdeci">std::vector&lt; unsigned int &gt; m_Axis</div><div class="ttdoc">Values for the dimensions to reduce. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00895">Descriptors.hpp:895</a></div></div>
185<div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a28e0548abfc4e79c48f29a3d11a062e9"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">armnn::MeanDescriptor::m_KeepDims</a></div><div class="ttdeci">bool m_KeepDims</div><div class="ttdoc">Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00897">Descriptors.hpp:897</a></div></div>
186</div><!-- fragment -->
187</div>
188</div>
189<h2 class="groupheader">Member Function Documentation</h2>
190<a id="a45ddc9ab5e076c7740d54e0fb74f104c"></a>
191<h2 class="memtitle"><span class="permalink"><a href="#a45ddc9ab5e076c7740d54e0fb74f104c">&#9670;&nbsp;</a></span>operator==()</h2>
192
193<div class="memitem">
194<div class="memproto">
195<table class="mlabels">
196 <tr>
197 <td class="mlabels-left">
198 <table class="memname">
199 <tr>
200 <td class="memname">bool operator== </td>
201 <td>(</td>
202 <td class="paramtype">const <a class="el" href="structarmnn_1_1_mean_descriptor.html">MeanDescriptor</a> &amp;&#160;</td>
203 <td class="paramname"><em>rhs</em></td><td>)</td>
204 <td> const</td>
205 </tr>
206 </table>
207 </td>
208 <td class="mlabels-right">
209<span class="mlabels"><span class="mlabel">inline</span></span> </td>
210 </tr>
211</table>
212</div><div class="memdoc">
213
214<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00889">889</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
215
216<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00895">MeanDescriptor::m_Axis</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00897">MeanDescriptor::m_KeepDims</a>.</p>
217<div class="fragment"><div class="line"><a name="l00890"></a><span class="lineno"> 890</span>&#160; {</div><div class="line"><a name="l00891"></a><span class="lineno"> 891</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">m_Axis</a> == rhs.m_Axis &amp;&amp; <a class="code" href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">m_KeepDims</a> == rhs.m_KeepDims;</div><div class="line"><a name="l00892"></a><span class="lineno"> 892</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a1f0d67b087c491248bd1cde3ff995a95"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a1f0d67b087c491248bd1cde3ff995a95">armnn::MeanDescriptor::m_Axis</a></div><div class="ttdeci">std::vector&lt; unsigned int &gt; m_Axis</div><div class="ttdoc">Values for the dimensions to reduce. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00895">Descriptors.hpp:895</a></div></div>
218<div class="ttc" id="structarmnn_1_1_mean_descriptor_html_a28e0548abfc4e79c48f29a3d11a062e9"><div class="ttname"><a href="structarmnn_1_1_mean_descriptor.html#a28e0548abfc4e79c48f29a3d11a062e9">armnn::MeanDescriptor::m_KeepDims</a></div><div class="ttdeci">bool m_KeepDims</div><div class="ttdoc">Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00897">Descriptors.hpp:897</a></div></div>
219</div><!-- fragment -->
220</div>
221</div>
222<h2 class="groupheader">Member Data Documentation</h2>
223<a id="a1f0d67b087c491248bd1cde3ff995a95"></a>
224<h2 class="memtitle"><span class="permalink"><a href="#a1f0d67b087c491248bd1cde3ff995a95">&#9670;&nbsp;</a></span>m_Axis</h2>
225
226<div class="memitem">
227<div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname">std::vector&lt;unsigned int&gt; m_Axis</td>
231 </tr>
232 </table>
233</div><div class="memdoc">
234
235<p>Values for the dimensions to reduce. </p>
236
237<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00895">895</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
238
239<p class="reference">Referenced by <a class="el" href="_serializer_tests_8cpp_source.html#l01456">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_mean_layer_8cpp_source.html#l00031">MeanLayer::Clone()</a>, <a class="el" href="_mean_layer_8cpp_source.html#l00022">MeanLayer::CreateWorkload()</a>, <a class="el" href="_ref_mean_workload_8cpp_source.html#l00021">RefMeanWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.html#l02148">Deserializer::GetNormalizationDescriptor()</a>, <a class="el" href="_ref_layer_support_8cpp_source.html#l01148">RefLayerSupport::IsMeanSupported()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00889">MeanDescriptor::operator==()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.html#l01466">TfLiteParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_tf_parser_8cpp_source.html#l02414">armnnTfParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00361">StringifyLayerParameters&lt; MeanDescriptor &gt;::Serialize()</a>, <a class="el" href="_mean_layer_8cpp_source.html#l00041">MeanLayer::ValidateTensorShapesFromInputs()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00680">SerializerVisitor::VisitMeanLayer()</a>.</p>
240
241</div>
242</div>
243<a id="a28e0548abfc4e79c48f29a3d11a062e9"></a>
244<h2 class="memtitle"><span class="permalink"><a href="#a28e0548abfc4e79c48f29a3d11a062e9">&#9670;&nbsp;</a></span>m_KeepDims</h2>
245
246<div class="memitem">
247<div class="memproto">
248 <table class="memname">
249 <tr>
250 <td class="memname">bool m_KeepDims</td>
251 </tr>
252 </table>
253</div><div class="memdoc">
254
255<p>Enable/disable keep dimensions. If true, then the reduced dimensions that are of length 1 are kept. </p>
256
257<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00897">897</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
258
259<p class="reference">Referenced by <a class="el" href="_mean_layer_8cpp_source.html#l00022">MeanLayer::CreateWorkload()</a>, <a class="el" href="_deserializer_8cpp_source.html#l02148">Deserializer::GetNormalizationDescriptor()</a>, <a class="el" href="_ref_layer_support_8cpp_source.html#l01148">RefLayerSupport::IsMeanSupported()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00889">MeanDescriptor::operator==()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.html#l01466">TfLiteParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_tf_parser_8cpp_source.html#l02414">armnnTfParser::OutputShapeOfSqueeze()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00361">StringifyLayerParameters&lt; MeanDescriptor &gt;::Serialize()</a>, <a class="el" href="_mean_layer_8cpp_source.html#l00041">MeanLayer::ValidateTensorShapesFromInputs()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00680">SerializerVisitor::VisitMeanLayer()</a>.</p>
260
261</div>
262</div>
263<hr/>The documentation for this struct was generated from the following file:<ul>
264<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
265</ul>
266</div><!-- contents -->
267</div><!-- doc-content -->
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_mean_descriptor.html">MeanDescriptor</a></li>
272 <li class="footer">Generated on Fri Mar 13 2020 16:07:04 for ArmNN by
273 <a href="http://www.doxygen.org/index.html">
274 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
275 </ul>
276</div>
277</body>
278</html>