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