Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 0800bf541a3c6f5f2d6ff842a30e20ed48fb2eac / . / Documentation / structarmnn_1_1_softmax_descriptor.html
blob: b96598108d5948749ee841e547abfc1302175c8b [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: SoftmaxDescriptor 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_softmax_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_softmax_descriptor-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">SoftmaxDescriptor Struct Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p>A <a class="el" href="structarmnn_1_1_softmax_descriptor.html" title="A SoftmaxDescriptor for the SoftmaxLayer. ">SoftmaxDescriptor</a> for the <a class="el" href="classarmnn_1_1_softmax_layer.html" title="This layer represents a softmax operation. ">SoftmaxLayer</a>.
93 <a href="structarmnn_1_1_softmax_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:ab284d1743a879c8762273540c363174e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#ab284d1743a879c8762273540c363174e">SoftmaxDescriptor</a> ()</td></tr>
100<tr class="separator:ab284d1743a879c8762273540c363174e"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:a3b7fdc72f23079437110c764f0533af5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#a3b7fdc72f23079437110c764f0533af5">operator==</a> (const <a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> &amp;rhs) const</td></tr>
102<tr class="separator:a3b7fdc72f23079437110c764f0533af5"><td class="memSeparator" colspan="2">&#160;</td></tr>
103</table><table class="memberdecls">
104<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
105Public Attributes</h2></td></tr>
106<tr class="memitem:a8275d51ef9a584feb95726ea0522f6e5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a></td></tr>
107<tr class="memdesc:a8275d51ef9a584feb95726ea0522f6e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exponentiation value. <a href="#a8275d51ef9a584feb95726ea0522f6e5">More...</a><br /></td></tr>
108<tr class="separator:a8275d51ef9a584feb95726ea0522f6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a></td></tr>
110<tr class="memdesc:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed on. <a href="#a214c3636fdf0ea5bac8edb42d0e6c7f0">More...</a><br /></td></tr>
111<tr class="separator:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table>
113<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
114<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_softmax_descriptor.html" title="A SoftmaxDescriptor for the SoftmaxLayer. ">SoftmaxDescriptor</a> for the <a class="el" href="classarmnn_1_1_softmax_layer.html" title="This layer represents a softmax operation. ">SoftmaxLayer</a>. </p>
115
116<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00123">123</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
117</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
118<a id="ab284d1743a879c8762273540c363174e"></a>
119<h2 class="memtitle"><span class="permalink"><a href="#ab284d1743a879c8762273540c363174e">&#9670;&nbsp;</a></span>SoftmaxDescriptor()</h2>
120
121<div class="memitem">
122<div class="memproto">
123<table class="mlabels">
124 <tr>
125 <td class="mlabels-left">
126 <table class="memname">
127 <tr>
128 <td class="memname"><a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> </td>
129 <td>(</td>
130 <td class="paramname"></td><td>)</td>
131 <td></td>
132 </tr>
133 </table>
134 </td>
135 <td class="mlabels-right">
136<span class="mlabels"><span class="mlabel">inline</span></span> </td>
137 </tr>
138</table>
139</div><div class="memdoc">
140
141<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00125">125</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
142<div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; : <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a>(1.0f)</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; , <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a>(-1)</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_softmax_descriptor_html_a8275d51ef9a584feb95726ea0522f6e5"><div class="ttname"><a href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">armnn::SoftmaxDescriptor::m_Beta</a></div><div class="ttdeci">float m_Beta</div><div class="ttdoc">Exponentiation value. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00136">Descriptors.hpp:136</a></div></div>
143<div class="ttc" id="structarmnn_1_1_softmax_descriptor_html_a214c3636fdf0ea5bac8edb42d0e6c7f0"><div class="ttname"><a href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">armnn::SoftmaxDescriptor::m_Axis</a></div><div class="ttdeci">int m_Axis</div><div class="ttdoc">Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed o...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00138">Descriptors.hpp:138</a></div></div>
144</div><!-- fragment -->
145</div>
146</div>
147<h2 class="groupheader">Member Function Documentation</h2>
148<a id="a3b7fdc72f23079437110c764f0533af5"></a>
149<h2 class="memtitle"><span class="permalink"><a href="#a3b7fdc72f23079437110c764f0533af5">&#9670;&nbsp;</a></span>operator==()</h2>
150
151<div class="memitem">
152<div class="memproto">
153<table class="mlabels">
154 <tr>
155 <td class="mlabels-left">
156 <table class="memname">
157 <tr>
158 <td class="memname">bool operator== </td>
159 <td>(</td>
160 <td class="paramtype">const <a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> &amp;&#160;</td>
161 <td class="paramname"><em>rhs</em></td><td>)</td>
162 <td> const</td>
163 </tr>
164 </table>
165 </td>
166 <td class="mlabels-right">
167<span class="mlabels"><span class="mlabel">inline</span></span> </td>
168 </tr>
169</table>
170</div><div class="memdoc">
171
172<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00130">130</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
173
174<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00138">SoftmaxDescriptor::m_Axis</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00136">SoftmaxDescriptor::m_Beta</a>.</p>
175<div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a> == rhs.m_Beta &amp;&amp; <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a> == rhs.m_Axis;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_softmax_descriptor_html_a8275d51ef9a584feb95726ea0522f6e5"><div class="ttname"><a href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">armnn::SoftmaxDescriptor::m_Beta</a></div><div class="ttdeci">float m_Beta</div><div class="ttdoc">Exponentiation value. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00136">Descriptors.hpp:136</a></div></div>
176<div class="ttc" id="structarmnn_1_1_softmax_descriptor_html_a214c3636fdf0ea5bac8edb42d0e6c7f0"><div class="ttname"><a href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">armnn::SoftmaxDescriptor::m_Axis</a></div><div class="ttdeci">int m_Axis</div><div class="ttdoc">Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed o...</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00138">Descriptors.hpp:138</a></div></div>
177</div><!-- fragment -->
178</div>
179</div>
180<h2 class="groupheader">Member Data Documentation</h2>
181<a id="a214c3636fdf0ea5bac8edb42d0e6c7f0"></a>
182<h2 class="memtitle"><span class="permalink"><a href="#a214c3636fdf0ea5bac8edb42d0e6c7f0">&#9670;&nbsp;</a></span>m_Axis</h2>
183
184<div class="memitem">
185<div class="memproto">
186 <table class="memname">
187 <tr>
188 <td class="memname">int m_Axis</td>
189 </tr>
190 </table>
191</div><div class="memdoc">
192
193<p>Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed on. </p>
194
195<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00138">138</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
196
197<p class="reference">Referenced by <a class="el" href="_arm_compute_utils_8hpp_source.html#l00138">armnn::ComputeSoftmaxAclAxis()</a>, <a class="el" href="_ref_softmax_workload_8cpp_source.html#l00020">RefSoftmaxWorkload::Execute()</a>, <a class="el" href="_json_printer_test_impl_8cpp_source.html#l00120">GetSoftmaxProfilerJson()</a>, <a class="el" href="_log_softmax_8cpp_source.html#l00030">armnn::LogSoftmax()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00070">LogSoftmaxTest1()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00106">LogSoftmaxTest2()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00142">LogSoftmaxTest3()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00178">LogSoftmaxTest4()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00130">SoftmaxDescriptor::operator==()</a>, <a class="el" href="_caffe_parser_8cpp_source.html#l01208">CaffeParserBase::ParseSoftmaxLayer()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00138">StringifyLayerParameters&lt; SoftmaxDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00538">SerializerVisitor::VisitLogSoftmaxLayer()</a>.</p>
198
199</div>
200</div>
201<a id="a8275d51ef9a584feb95726ea0522f6e5"></a>
202<h2 class="memtitle"><span class="permalink"><a href="#a8275d51ef9a584feb95726ea0522f6e5">&#9670;&nbsp;</a></span>m_Beta</h2>
203
204<div class="memitem">
205<div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">float m_Beta</td>
209 </tr>
210 </table>
211</div><div class="memdoc">
212
213<p>Exponentiation value. </p>
214
215<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00136">136</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
216
217<p class="reference">Referenced by <a class="el" href="_quantizer_test_8cpp_source.html#l01286">armnn::BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_serializer_tests_8cpp_source.html#l01399">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_cl_softmax_uint8_workload_8cpp_source.html#l00016">ClSoftmaxUint8Workload::ClSoftmaxUint8Workload()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.html#l00597">TfLiteParser::CreateNetworkFromBinary()</a>, <a class="el" href="_ref_softmax_workload_8cpp_source.html#l00020">RefSoftmaxWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.html#l00753">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_log_softmax_8cpp_source.html#l00030">armnn::LogSoftmax()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00070">LogSoftmaxTest1()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00106">LogSoftmaxTest2()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00142">LogSoftmaxTest3()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.html#l00178">LogSoftmaxTest4()</a>, <a class="el" href="_neon_softmax_uint8_workload_8cpp_source.html#l00016">NeonSoftmaxUint8Workload::NeonSoftmaxUint8Workload()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00130">SoftmaxDescriptor::operator==()</a>, <a class="el" href="_deserializer_8cpp_source.html#l01927">Deserializer::OutputShapeOfReshape()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00138">StringifyLayerParameters&lt; SoftmaxDescriptor &gt;::Serialize()</a>, <a class="el" href="_serializer_8cpp_source.html#l00538">SerializerVisitor::VisitLogSoftmaxLayer()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00921">SerializerVisitor::VisitSoftmaxLayer()</a>.</p>
218
219</div>
220</div>
221<hr/>The documentation for this struct was generated from the following file:<ul>
222<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
223</ul>
224</div><!-- contents -->
225</div><!-- doc-content -->
226<!-- start footer part -->
227<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
228 <ul>
229 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a></li>
230 <li class="footer">Generated on Fri Mar 13 2020 16:07:05 for ArmNN by
231 <a href="http://www.doxygen.org/index.html">
232 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
233 </ul>
234</div>
235</body>
236</html>