diff options
| author | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 17:44:00 +0000 |
|---|---|---|
| committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 18:27:49 +0000 |
| commit | fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf (patch) | |
| tree | eb4bc8f9b411f30c7655616142b5a4bdd3a1acd0 /21.02/structarmnn_1_1_softmax_descriptor.xhtml | |
| parent | fb14ebbd68e04876809145296af96f6f41857418 (diff) | |
| download | armnn-fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf.tar.gz | |
IVGCVSW-5687 Update Doxygen Docu
* Update Doxygen Documentation for 21.02 release
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5
Diffstat (limited to '21.02/structarmnn_1_1_softmax_descriptor.xhtml')
| -rw-r--r-- | 21.02/structarmnn_1_1_softmax_descriptor.xhtml | 259 |
1 files changed, 259 insertions, 0 deletions
diff --git a/21.02/structarmnn_1_1_softmax_descriptor.xhtml b/21.02/structarmnn_1_1_softmax_descriptor.xhtml new file mode 100644 index 0000000000..2c3bebfc8b --- /dev/null +++ b/21.02/structarmnn_1_1_softmax_descriptor.xhtml @@ -0,0 +1,259 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: 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> +<script type="text/javascript"> + $(document).ready(initResizable); +</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" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">21.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"> +$(document).ready(function(){initNavTree('structarmnn_1_1_softmax_descriptor.xhtml','');}); +</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.xhtml">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.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>. + <a href="structarmnn_1_1_softmax_descriptor.xhtml#details">More...</a></p> + +<p><code>#include <<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for SoftmaxDescriptor:</div> +<div class="dyncontent"> + <div class="center"> + <img src="structarmnn_1_1_softmax_descriptor.png" usemap="#SoftmaxDescriptor_map" alt=""/> + <map id="SoftmaxDescriptor_map" name="SoftmaxDescriptor_map"> +<area href="structarmnn_1_1_base_descriptor.xhtml" title="Base class for all descriptors. " alt="BaseDescriptor" shape="rect" coords="0,0,115,24"/> +</map> + </div></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.xhtml#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.xhtml#a3b7fdc72f23079437110c764f0533af5">operator==</a> (const <a class="el" href="structarmnn_1_1_softmax_descriptor.xhtml">SoftmaxDescriptor</a> &rhs) const</td></tr> +<tr class="separator:a3b7fdc72f23079437110c764f0533af5"><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.xhtml#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a></td></tr> +<tr class="memdesc:a8275d51ef9a584feb95726ea0522f6e5"><td class="mdescLeft"> </td><td class="mdescRight">Exponentiation value. <a href="#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.xhtml#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="#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.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> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00139">139</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">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.xhtml">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.xhtml#l00141">141</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  : <a class="code" href="structarmnn_1_1_softmax_descriptor.xhtml#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a>(1.0f)</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  , <a class="code" href="structarmnn_1_1_softmax_descriptor.xhtml#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a>(-1)</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  {}</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#l00154">Descriptors.hpp:154</a></div></div> +<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#l00152">Descriptors.hpp:152</a></div></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.xhtml">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.xhtml#l00146">146</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_descriptors_8hpp_source.xhtml#l00154">SoftmaxDescriptor::m_Axis</a>, and <a class="el" href="_descriptors_8hpp_source.xhtml#l00152">SoftmaxDescriptor::m_Beta</a>.</p> +<div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  {</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_softmax_descriptor.xhtml#a8275d51ef9a584feb95726ea0522f6e5">m_Beta</a> == rhs.m_Beta && <a class="code" href="structarmnn_1_1_softmax_descriptor.xhtml#a214c3636fdf0ea5bac8edb42d0e6c7f0">m_Axis</a> == rhs.m_Axis;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  }</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#l00154">Descriptors.hpp:154</a></div></div> +<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#l00152">Descriptors.hpp:152</a></div></div> +</div><!-- fragment --> +</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.xhtml#l00154">154</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_cl_log_softmax_workload_8cpp_source.xhtml#l00028">ClLogSoftmaxWorkload::ClLogSoftmaxWorkload()</a>, <a class="el" href="_cl_softmax_workload_8cpp_source.xhtml#l00028">ClSoftmaxWorkload::ClSoftmaxWorkload()</a>, <a class="el" href="_arm_compute_utils_8hpp_source.xhtml#l00191">armnn::ComputeSoftmaxAclAxis()</a>, <a class="el" href="_ref_softmax_workload_8cpp_source.xhtml#l00020">RefSoftmaxWorkload::Execute()</a>, <a class="el" href="_serializer_8cpp_source.xhtml#l00087">armnnSerializer::GetFlatBufferArgMinMaxFunction()</a>, <a class="el" href="_json_printer_test_impl_8cpp_source.xhtml#l00119">GetSoftmaxProfilerJson()</a>, <a class="el" href="_log_softmax_8cpp_source.xhtml#l00029">armnn::LogSoftmax()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00071">LogSoftmaxTest1()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00109">LogSoftmaxTest2()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00147">LogSoftmaxTest3()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00185">LogSoftmaxTest4()</a>, <a class="el" href="_neon_log_softmax_workload_8cpp_source.xhtml#l00033">NeonLogSoftmaxWorkload::NeonLogSoftmaxWorkload()</a>, <a class="el" href="_neon_softmax_workload_8cpp_source.xhtml#l00033">NeonSoftmaxWorkload::NeonSoftmaxWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00146">SoftmaxDescriptor::operator==()</a>, <a class="el" href="_caffe_parser_8cpp_source.xhtml#l01641">ICaffeParser::CaffeParserImpl::ParseSoftmaxLayer()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00138">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.xhtml#l00152">152</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_serializer_tests_8cpp_source.xhtml#l01065">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_quantizer_test_8cpp_source.xhtml#l01187">armnn::BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_cl_log_softmax_workload_8cpp_source.xhtml#l00028">ClLogSoftmaxWorkload::ClLogSoftmaxWorkload()</a>, <a class="el" href="_cl_softmax_workload_8cpp_source.xhtml#l00028">ClSoftmaxWorkload::ClSoftmaxWorkload()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.xhtml#l00672">TfLiteParserImpl::CreateNetworkFromBinary()</a>, <a class="el" href="_ref_softmax_workload_8cpp_source.xhtml#l00020">RefSoftmaxWorkload::Execute()</a>, <a class="el" href="_serializer_8cpp_source.xhtml#l00087">armnnSerializer::GetFlatBufferArgMinMaxFunction()</a>, <a class="el" href="_deserializer_8cpp_source.xhtml#l00854">IDeserializer::DeserializerImpl::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_log_softmax_8cpp_source.xhtml#l00029">armnn::LogSoftmax()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00071">LogSoftmaxTest1()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00109">LogSoftmaxTest2()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00147">LogSoftmaxTest3()</a>, <a class="el" href="_log_softmax_test_impl_8cpp_source.xhtml#l00185">LogSoftmaxTest4()</a>, <a class="el" href="_neon_log_softmax_workload_8cpp_source.xhtml#l00033">NeonLogSoftmaxWorkload::NeonLogSoftmaxWorkload()</a>, <a class="el" href="_neon_softmax_workload_8cpp_source.xhtml#l00033">NeonSoftmaxWorkload::NeonSoftmaxWorkload()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00146">SoftmaxDescriptor::operator==()</a>, <a class="el" href="_deserializer_8cpp_source.xhtml#l02073">IDeserializer::DeserializerImpl::OutputShapeOfReshape()</a>, and <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00138">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.xhtml">Descriptors.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> + <li class="footer">Generated on Thu Feb 25 2021 17:28:01 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |