Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / structarmnn_1_1_softmax_descriptor.html
blob: e7c48181e1f976bb98ece28207c578f36e020dd1 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: SoftmaxDescriptor Struct Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('structarmnn_1_1_softmax_descriptor.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="#pub-attribs">Public Attributes</a> &#124;
98<a href="structarmnn_1_1_softmax_descriptor-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">SoftmaxDescriptor Struct Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<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>.
105 <a href="structarmnn_1_1_softmax_descriptor.html#details">More...</a></p>
106
107<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>&gt;</code></p>
108<div class="dynheader">
109Inheritance diagram for SoftmaxDescriptor:</div>
110<div class="dyncontent">
111<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_softmax_descriptor__inherit__graph.svg" width="154" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
112</div>
113<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
114<div class="dynheader">
115Collaboration diagram for SoftmaxDescriptor:</div>
116<div class="dyncontent">
117<div class="center"><iframe scrolling="no" frameborder="0" src="structarmnn_1_1_softmax_descriptor__coll__graph.svg" width="154" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
118</div>
119<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<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>
124<tr class="separator:ab284d1743a879c8762273540c363174e"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<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>
126<tr class="separator:a3b7fdc72f23079437110c764f0533af5"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="inherit_header pub_methods_structarmnn_1_1_base_descriptor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_base_descriptor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a></td></tr>
128<tr class="memitem:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#ac618666b3c6d65d2c88bcbb7abeed343">IsNull</a> () const</td></tr>
129<tr class="separator:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#a5e0f82ef2f18eb897e6d6f1845e74033">~BaseDescriptor</a> ()=default</td></tr>
131<tr class="separator:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2">&#160;</td></tr>
132</table><table class="memberdecls">
133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
134Public Attributes</h2></td></tr>
135<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>
136<tr class="memdesc:a8275d51ef9a584feb95726ea0522f6e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exponentiation value. <a href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">More...</a><br /></td></tr>
137<tr class="separator:a8275d51ef9a584feb95726ea0522f6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<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>
139<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="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">More...</a><br /></td></tr>
140<tr class="separator:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
141</table>
142<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143<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>
144
145<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00177">177</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
146</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
147<a id="ab284d1743a879c8762273540c363174e"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#ab284d1743a879c8762273540c363174e">&#9670;&nbsp;</a></span>SoftmaxDescriptor()</h2>
149
150<div class="memitem">
151<div class="memproto">
152<table class="mlabels">
153 <tr>
154 <td class="mlabels-left">
155 <table class="memname">
156 <tr>
157 <td class="memname"><a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> </td>
158 <td>(</td>
159 <td class="paramname"></td><td>)</td>
160 <td></td>
161 </tr>
162 </table>
163 </td>
164 <td class="mlabels-right">
165<span class="mlabels"><span class="mlabel">inline</span></span> </td>
166 </tr>
167</table>
168</div><div class="memdoc">
169
170<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00179">179</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
171<div class="fragment"><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; : <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a>(1.0f)</div>
172<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; , <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a>(-1)</div>
173<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; {}</div>
174</div><!-- fragment -->
175</div>
176</div>
177<h2 class="groupheader">Member Function Documentation</h2>
178<a id="a3b7fdc72f23079437110c764f0533af5"></a>
179<h2 class="memtitle"><span class="permalink"><a href="#a3b7fdc72f23079437110c764f0533af5">&#9670;&nbsp;</a></span>operator==()</h2>
180
181<div class="memitem">
182<div class="memproto">
183<table class="mlabels">
184 <tr>
185 <td class="mlabels-left">
186 <table class="memname">
187 <tr>
188 <td class="memname">bool operator== </td>
189 <td>(</td>
190 <td class="paramtype">const <a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> &amp;&#160;</td>
191 <td class="paramname"><em>rhs</em></td><td>)</td>
192 <td> const</td>
193 </tr>
194 </table>
195 </td>
196 <td class="mlabels-right">
197<span class="mlabels"><span class="mlabel">inline</span></span> </td>
198 </tr>
199</table>
200</div><div class="memdoc">
201
202<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00184">184</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
203<div class="fragment"><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; {</div>
204<div class="line"><a name="l00186"></a><span class="lineno"> 186</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>
205<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; }</div>
206</div><!-- fragment -->
207<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00192">SoftmaxDescriptor::m_Axis</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00190">SoftmaxDescriptor::m_Beta</a>.</p>
208
209</div>
210</div>
211<h2 class="groupheader">Member Data Documentation</h2>
212<a id="a214c3636fdf0ea5bac8edb42d0e6c7f0"></a>
213<h2 class="memtitle"><span class="permalink"><a href="#a214c3636fdf0ea5bac8edb42d0e6c7f0">&#9670;&nbsp;</a></span>m_Axis</h2>
214
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">int m_Axis</td>
220 </tr>
221 </table>
222</div><div class="memdoc">
223
224<p>Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed on. </p>
225
226<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00192">192</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
227
228<p class="reference">Referenced by <a class="el" href="_cl_log_softmax_workload_8cpp_source.html#l00028">ClLogSoftmaxWorkload::ClLogSoftmaxWorkload()</a>, <a class="el" href="_cl_softmax_workload_8cpp_source.html#l00028">ClSoftmaxWorkload::ClSoftmaxWorkload()</a>, <a class="el" href="_arm_compute_utils_8hpp_source.html#l00227">armnn::ComputeSoftmaxAclAxis()</a>, <a class="el" href="_log_softmax_8cpp_source.html#l00027">armnn::LogSoftmax()</a>, <a class="el" href="_neon_log_softmax_workload_8cpp_source.html#l00033">NeonLogSoftmaxWorkload::NeonLogSoftmaxWorkload()</a>, <a class="el" href="_neon_softmax_workload_8cpp_source.html#l00033">NeonSoftmaxWorkload::NeonSoftmaxWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00184">SoftmaxDescriptor::operator==()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00453">StringifyLayerParameters&lt; SoftmaxDescriptor &gt;::Serialize()</a>.</p>
229
230</div>
231</div>
232<a id="a8275d51ef9a584feb95726ea0522f6e5"></a>
233<h2 class="memtitle"><span class="permalink"><a href="#a8275d51ef9a584feb95726ea0522f6e5">&#9670;&nbsp;</a></span>m_Beta</h2>
234
235<div class="memitem">
236<div class="memproto">
237 <table class="memname">
238 <tr>
239 <td class="memname">float m_Beta</td>
240 </tr>
241 </table>
242</div><div class="memdoc">
243
244<p>Exponentiation value. </p>
245
246<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00190">190</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p>
247
248<p class="reference">Referenced by <a class="el" href="_cl_log_softmax_workload_8cpp_source.html#l00028">ClLogSoftmaxWorkload::ClLogSoftmaxWorkload()</a>, <a class="el" href="_cl_softmax_workload_8cpp_source.html#l00028">ClSoftmaxWorkload::ClSoftmaxWorkload()</a>, <a class="el" href="_log_softmax_8cpp_source.html#l00027">armnn::LogSoftmax()</a>, <a class="el" href="_neon_log_softmax_workload_8cpp_source.html#l00033">NeonLogSoftmaxWorkload::NeonLogSoftmaxWorkload()</a>, <a class="el" href="_neon_softmax_workload_8cpp_source.html#l00033">NeonSoftmaxWorkload::NeonSoftmaxWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00184">SoftmaxDescriptor::operator==()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00453">StringifyLayerParameters&lt; SoftmaxDescriptor &gt;::Serialize()</a>.</p>
249
250</div>
251</div>
252<hr/>The documentation for this struct was generated from the following file:<ul>
253<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li>
254</ul>
255</div><!-- contents -->
256</div><!-- doc-content -->
257<div class="ttc" id="astructarmnn_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#l00190">Descriptors.hpp:190</a></div></div>
258<div class="ttc" id="astructarmnn_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#l00192">Descriptors.hpp:192</a></div></div>
259<!-- start footer part -->
260<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
261 <ul>
262 <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>
263 <li class="footer">Generated on Thu May 16 2024 09:31:59 for Arm NN by
264 <a href="http://www.doxygen.org/index.html">
265 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
266 </ul>
267</div>
268</body>
269</html>