diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/structarmnn_1_1_l2_normalization_descriptor.html | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/structarmnn_1_1_l2_normalization_descriptor.html')
-rw-r--r-- | Documentation/structarmnn_1_1_l2_normalization_descriptor.html | 237 |
1 files changed, 237 insertions, 0 deletions
diff --git a/Documentation/structarmnn_1_1_l2_normalization_descriptor.html b/Documentation/structarmnn_1_1_l2_normalization_descriptor.html new file mode 100644 index 0000000000..b4b4d7c4ff --- /dev/null +++ b/Documentation/structarmnn_1_1_l2_normalization_descriptor.html @@ -0,0 +1,237 @@ +<!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="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: L2NormalizationDescriptor 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> +<link href="doxygen.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;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">ArmNN +  <span id="projectnumber">NotReleased</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_l2_normalization_descriptor.html','');}); +</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_l2_normalization_descriptor-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">L2NormalizationDescriptor Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html" title="A L2NormalizationDescriptor for the L2NormalizationLayer. ">L2NormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_l2_normalization_layer.html" title="This layer represents a L2 normalization operation. ">L2NormalizationLayer</a>. + <a href="structarmnn_1_1_l2_normalization_descriptor.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>></code></p> +<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:a7c758226ee35a1387dff4fb8a5f14948"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html#a7c758226ee35a1387dff4fb8a5f14948">L2NormalizationDescriptor</a> ()</td></tr> +<tr class="separator:a7c758226ee35a1387dff4fb8a5f14948"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:affc4fe96bd046f459ae712bd811b9d28"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html#affc4fe96bd046f459ae712bd811b9d28">operator==</a> (const <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html">L2NormalizationDescriptor</a> &rhs) const</td></tr> +<tr class="separator:affc4fe96bd046f459ae712bd811b9d28"><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:a11c821c7524251004a72ed13c510853c"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a></td></tr> +<tr class="memdesc:a11c821c7524251004a72ed13c510853c"><td class="mdescLeft"> </td><td class="mdescRight">Used to avoid dividing by zero. <a href="#a11c821c7524251004a72ed13c510853c">More...</a><br /></td></tr> +<tr class="separator:a11c821c7524251004a72ed13c510853c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6089e1ca91914015777ea780a513131a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a></td></tr> +<tr class="memdesc:a6089e1ca91914015777ea780a513131a"><td class="mdescLeft"> </td><td class="mdescRight">The data layout to be used (NCHW, NHWC). <a href="#a6089e1ca91914015777ea780a513131a">More...</a><br /></td></tr> +<tr class="separator:a6089e1ca91914015777ea780a513131a"><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_l2_normalization_descriptor.html" title="A L2NormalizationDescriptor for the L2NormalizationLayer. ">L2NormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_l2_normalization_layer.html" title="This layer represents a L2 normalization operation. ">L2NormalizationLayer</a>. </p> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00591">591</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="a7c758226ee35a1387dff4fb8a5f14948"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7c758226ee35a1387dff4fb8a5f14948">◆ </a></span>L2NormalizationDescriptor()</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_l2_normalization_descriptor.html">L2NormalizationDescriptor</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#l00593">593</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  : <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a>(1e-12f)</div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  , <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a>(<a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">DataLayout::NCHW</a>)</div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  {}</div><div class="ttc" id="namespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div></div> +<div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_html_a6089e1ca91914015777ea780a513131a"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">armnn::L2NormalizationDescriptor::m_DataLayout</a></div><div class="ttdeci">DataLayout m_DataLayout</div><div class="ttdoc">The data layout to be used (NCHW, NHWC). </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00606">Descriptors.hpp:606</a></div></div> +<div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_html_a11c821c7524251004a72ed13c510853c"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">armnn::L2NormalizationDescriptor::m_Eps</a></div><div class="ttdeci">float m_Eps</div><div class="ttdoc">Used to avoid dividing by zero. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00604">Descriptors.hpp:604</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="affc4fe96bd046f459ae712bd811b9d28"></a> +<h2 class="memtitle"><span class="permalink"><a href="#affc4fe96bd046f459ae712bd811b9d28">◆ </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_l2_normalization_descriptor.html">L2NormalizationDescriptor</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#l00598">598</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_descriptors_8hpp_source.html#l00606">L2NormalizationDescriptor::m_DataLayout</a>, and <a class="el" href="_descriptors_8hpp_source.html#l00604">L2NormalizationDescriptor::m_Eps</a>.</p> +<div class="fragment"><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  {</div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">m_Eps</a> == rhs.m_Eps && <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">m_DataLayout</a> == rhs.m_DataLayout;</div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  }</div><div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_html_a6089e1ca91914015777ea780a513131a"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.html#a6089e1ca91914015777ea780a513131a">armnn::L2NormalizationDescriptor::m_DataLayout</a></div><div class="ttdeci">DataLayout m_DataLayout</div><div class="ttdoc">The data layout to be used (NCHW, NHWC). </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00606">Descriptors.hpp:606</a></div></div> +<div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_html_a11c821c7524251004a72ed13c510853c"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.html#a11c821c7524251004a72ed13c510853c">armnn::L2NormalizationDescriptor::m_Eps</a></div><div class="ttdeci">float m_Eps</div><div class="ttdoc">Used to avoid dividing by zero. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00604">Descriptors.hpp:604</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a6089e1ca91914015777ea780a513131a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6089e1ca91914015777ea780a513131a">◆ </a></span>m_DataLayout</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> m_DataLayout</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The data layout to be used (NCHW, NHWC). </p> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00606">606</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_serializer_tests_8cpp_source.html#l01316">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.html#l00597">TfLiteParser::CreateNetworkFromBinary()</a>, <a class="el" href="_ref_l2_normalization_workload_8cpp_source.html#l00028">RefL2NormalizationWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.html#l00753">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.html#l00672">L2Normalization2dShapeTest()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00598">L2NormalizationDescriptor::operator==()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00240">StringifyLayerParameters< L2NormalizationDescriptor >::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00517">SerializerVisitor::VisitL2NormalizationLayer()</a>.</p> + +</div> +</div> +<a id="a11c821c7524251004a72ed13c510853c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a11c821c7524251004a72ed13c510853c">◆ </a></span>m_Eps</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float m_Eps</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Used to avoid dividing by zero. </p> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.html#l00604">604</a> of file <a class="el" href="_descriptors_8hpp_source.html">Descriptors.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_ref_l2_normalization_workload_8cpp_source.html#l00028">RefL2NormalizationWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.html#l00753">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.html#l00672">L2Normalization2dShapeTest()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.html#l00547">L2NormalizationDefaultEpsilonTest()</a>, <a class="el" href="_descriptors_8hpp_source.html#l00598">L2NormalizationDescriptor::operator==()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.html#l00240">StringifyLayerParameters< L2NormalizationDescriptor >::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.html#l00517">SerializerVisitor::VisitL2NormalizationLayer()</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 --> +<!-- 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_l2_normalization_descriptor.html">L2NormalizationDescriptor</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:03 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> |