diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2023-08-22 12:00:04 +0100 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-08-22 12:00:04 +0100 |
| commit | 03c7ff3f6188240baaeaeb405a357a0c58195fec (patch) | |
| tree | ccfcd5b3481c1a48f2b2c588038e010c09fdfb5f /latest/structarmnn_1_1_softmax_descriptor.html | |
| parent | 8efb48a6847c5cd166c561127ae6611150963ce3 (diff) | |
| download | armnn-03c7ff3f6188240baaeaeb405a357a0c58195fec.tar.gz | |
IVGCVSW-7702 Update Doxygen Docu for 23.08
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I357a9f7e47614589327c1ac5d95b6224ff77103d
Diffstat (limited to 'latest/structarmnn_1_1_softmax_descriptor.html')
| -rw-r--r-- | latest/structarmnn_1_1_softmax_descriptor.html | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/latest/structarmnn_1_1_softmax_descriptor.html b/latest/structarmnn_1_1_softmax_descriptor.html new file mode 100644 index 0000000000..366f0baef5 --- /dev/null +++ b/latest/structarmnn_1_1_softmax_descriptor.html @@ -0,0 +1,269 @@ +<!-- HTML header for doxygen 1.8.17--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.17"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Arm NN: SoftmaxDescriptor Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script> +<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="customdoxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/> + <td id="projectalign" style="padding-left: 0.9em;"> + <div id="projectname"> +  <span id="projectnumber">23.08</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.17 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('structarmnn_1_1_softmax_descriptor.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="structarmnn_1_1_softmax_descriptor-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">SoftmaxDescriptor Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<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>. + <a href="structarmnn_1_1_softmax_descriptor.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for SoftmaxDescriptor:</div> +<div class="dyncontent"> +<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> +</div> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for SoftmaxDescriptor:</div> +<div class="dyncontent"> +<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> +</div> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ab284d1743a879c8762273540c363174e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#ab284d1743a879c8762273540c363174e">SoftmaxDescriptor</a> ()</td></tr> +<tr class="separator:ab284d1743a879c8762273540c363174e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3b7fdc72f23079437110c764f0533af5"><td class="memItemLeft" align="right" valign="top">bool </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> &rhs) const</td></tr> +<tr class="separator:a3b7fdc72f23079437110c764f0533af5"><td class="memSeparator" colspan="2"> </td></tr> +<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="-"/> Public Member Functions inherited from <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a></td></tr> +<tr class="memitem:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#ac618666b3c6d65d2c88bcbb7abeed343">IsNull</a> () const</td></tr> +<tr class="separator:ac618666b3c6d65d2c88bcbb7abeed343 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.html#a5e0f82ef2f18eb897e6d6f1845e74033">~BaseDescriptor</a> ()=default</td></tr> +<tr class="separator:a5e0f82ef2f18eb897e6d6f1845e74033 inherit pub_methods_structarmnn_1_1_base_descriptor"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a8275d51ef9a584feb95726ea0522f6e5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a></td></tr> +<tr class="memdesc:a8275d51ef9a584feb95726ea0522f6e5"><td class="mdescLeft"> </td><td class="mdescRight">Exponentiation value. <a href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">More...</a><br /></td></tr> +<tr class="separator:a8275d51ef9a584feb95726ea0522f6e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a></td></tr> +<tr class="memdesc:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="mdescLeft"> </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> +<tr class="separator:a214c3636fdf0ea5bac8edb42d0e6c7f0"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<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> + +<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> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ab284d1743a879c8762273540c363174e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab284d1743a879c8762273540c363174e">◆ </a></span>SoftmaxDescriptor()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  : <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a>(1.0f)</div> +<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  , <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a>(-1)</div> +<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  {}</div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a3b7fdc72f23079437110c764f0533af5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3b7fdc72f23079437110c764f0533af5">◆ </a></span>operator==()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool operator== </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_softmax_descriptor.html">SoftmaxDescriptor</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  {</div> +<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a> == rhs.m_Beta && <a class="code" href="structarmnn_1_1_softmax_descriptor.html#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a> == rhs.m_Axis;</div> +<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  }</div> +</div><!-- fragment --> +<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> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a214c3636fdf0ea5bac8edb42d0e6c7f0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a214c3636fdf0ea5bac8edb42d0e6c7f0">◆ </a></span>m_Axis</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int m_Axis</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Scalar, defaulted to the last index (-1), specifying the dimension the activation will be performed on. </p> + +<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> + +<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#l00225">armnn::ComputeSoftmaxAclAxis()</a>, <a class="el" href="_log_softmax_8cpp_source.html#l00029">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#l00444">StringifyLayerParameters< SoftmaxDescriptor >::Serialize()</a>.</p> + +</div> +</div> +<a id="a8275d51ef9a584feb95726ea0522f6e5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8275d51ef9a584feb95726ea0522f6e5">◆ </a></span>m_Beta</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float m_Beta</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Exponentiation value. </p> + +<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> + +<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#l00029">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#l00444">StringifyLayerParameters< SoftmaxDescriptor >::Serialize()</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<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> +<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> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> + <li class="footer">Generated on Tue Aug 22 2023 11:37:09 for Arm NN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> + </ul> +</div> +</body> +</html> |