Update Doxygen docu for 23.05

Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe
author: Nikhil Raj <nikhil.raj@arm.com> 2023-05-19 11:14:28 +0100
committer: Nikhil Raj <nikhil.raj@arm.com> 2023-05-19 11:14:28 +0100
commit: 8efb48a6847c5cd166c561127ae6611150963ce3 (patch)
tree: f4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/structarmnn_1_1_base_descriptor.xhtml
parent: 023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff)
download: armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz
1 files changed, 248 insertions, 0 deletions
diff --git a/23.05/structarmnn_1_1_base_descriptor.xhtml b/23.05/structarmnn_1_1_base_descriptor.xhtml
new file mode 100644
index 0000000000..438fa1ed61
--- /dev/null
+++ b/23.05/structarmnn_1_1_base_descriptor.xhtml
@@ -0,0 +1,248 @@
+<!-- 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.17"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" />
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: BaseDescriptor 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="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">
+   &#160;<span id="projectnumber">23.05</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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('structarmnn_1_1_base_descriptor.xhtml',''); 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> &#124;
+<a href="structarmnn_1_1_base_descriptor-members.xhtml">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">BaseDescriptor Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Base class for all descriptors.  
+ <a href="structarmnn_1_1_base_descriptor.xhtml#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for BaseDescriptor:</div>
+<div class="dyncontent">
+ <div class="center">
+  <img src="structarmnn_1_1_base_descriptor.png" usemap="#BaseDescriptor_map" alt=""/>
+  <map id="BaseDescriptor_map" name="BaseDescriptor_map">
+<area href="structarmnn_1_1_activation_descriptor.xhtml" title="An ActivationDescriptor for the ActivationLayer." alt="ActivationDescriptor" shape="rect" coords="221,56,432,80"/>
+<area href="structarmnn_1_1_arg_min_max_descriptor.xhtml" title="An ArgMinMaxDescriptor for ArgMinMaxLayer." alt="ArgMinMaxDescriptor" shape="rect" coords="221,112,432,136"/>
+<area href="structarmnn_1_1_batch_mat_mul_descriptor.xhtml" title="A BatchMatMulDescriptor for the BatchMatMul operator." alt="BatchMatMulDescriptor" shape="rect" coords="221,168,432,192"/>
+<area href="structarmnn_1_1_batch_normalization_descriptor.xhtml" title="A BatchNormalizationDescriptor for the BatchNormalizationLayer." alt="BatchNormalizationDescriptor" shape="rect" coords="221,224,432,248"/>
+<area href="structarmnn_1_1_batch_to_space_nd_descriptor.xhtml" title="A BatchToSpaceNdDescriptor for the BatchToSpaceNdLayer." alt="BatchToSpaceNdDescriptor" shape="rect" coords="221,280,432,304"/>
+<area href="structarmnn_1_1_channel_shuffle_descriptor.xhtml" title="A ChannelShuffleDescriptor for the ChannelShuffle operator." alt="ChannelShuffleDescriptor" shape="rect" coords="221,336,432,360"/>
+<area href="structarmnn_1_1_comparison_descriptor.xhtml" title="A ComparisonDescriptor for the ComparisonLayer." alt="ComparisonDescriptor" shape="rect" coords="221,392,432,416"/>
+<area href="structarmnn_1_1_convolution2d_descriptor.xhtml" title="A Convolution2dDescriptor for the Convolution2dLayer." alt="Convolution2dDescriptor" shape="rect" coords="221,448,432,472"/>
+<area href="structarmnn_1_1_convolution3d_descriptor.xhtml" title="A Convolution3dDescriptor for the Convolution3dLayer." alt="Convolution3dDescriptor" shape="rect" coords="221,504,432,528"/>
+<area href="structarmnn_1_1_depthwise_convolution2d_descriptor.xhtml" title="A DepthwiseConvolution2dDescriptor for the DepthwiseConvolution2dLayer." alt="DepthwiseConvolution2dDescriptor" shape="rect" coords="221,560,432,584"/>
+<area href="structarmnn_1_1_detection_post_process_descriptor.xhtml" alt="DetectionPostProcessDescriptor" shape="rect" coords="221,616,432,640"/>
+<area href="structarmnn_1_1_elementwise_binary_descriptor.xhtml" title="A ElementwiseBinaryDescriptor for the ElementwiseBinaryLayer." alt="ElementwiseBinaryDescriptor" shape="rect" coords="221,672,432,696"/>
+<area href="structarmnn_1_1_elementwise_unary_descriptor.xhtml" title="A ElementwiseUnaryDescriptor for the ElementwiseUnaryLayer." alt="ElementwiseUnaryDescriptor" shape="rect" coords="221,728,432,752"/>
+<area href="structarmnn_1_1_fake_quantization_descriptor.xhtml" title="A FakeQuantizationDescriptor for the FakeQuantizationLayer." alt="FakeQuantizationDescriptor" shape="rect" coords="221,784,432,808"/>
+<area href="structarmnn_1_1_fill_descriptor.xhtml" title="A FillDescriptor for the FillLayer." alt="FillDescriptor" shape="rect" coords="221,840,432,864"/>
+<area href="structarmnn_1_1_fully_connected_descriptor.xhtml" title="A FullyConnectedDescriptor for the FullyConnectedLayer." alt="FullyConnectedDescriptor" shape="rect" coords="221,896,432,920"/>
+<area href="structarmnn_1_1_gather_descriptor.xhtml" title="A GatherDescriptor for the GatherLayer." alt="GatherDescriptor" shape="rect" coords="221,952,432,976"/>
+<area href="structarmnn_1_1_instance_normalization_descriptor.xhtml" title="An InstanceNormalizationDescriptor for InstanceNormalizationLayer." alt="InstanceNormalizationDescriptor" shape="rect" coords="221,1008,432,1032"/>
+<area href="structarmnn_1_1_l2_normalization_descriptor.xhtml" title="A L2NormalizationDescriptor for the L2NormalizationLayer." alt="L2NormalizationDescriptor" shape="rect" coords="221,1064,432,1088"/>
+<area href="structarmnn_1_1_logical_binary_descriptor.xhtml" title="A LogicalBinaryDescriptor for the LogicalBinaryLayer." alt="LogicalBinaryDescriptor" shape="rect" coords="221,1120,432,1144"/>
+<area href="structarmnn_1_1_lstm_descriptor.xhtml" title="An LstmDescriptor for the LstmLayer." alt="LstmDescriptor" shape="rect" coords="221,1176,432,1200"/>
+<area href="structarmnn_1_1_mean_descriptor.xhtml" title="A MeanDescriptor for the MeanLayer." alt="MeanDescriptor" shape="rect" coords="221,1232,432,1256"/>
+<area href="structarmnn_1_1_normalization_descriptor.xhtml" title="A NormalizationDescriptor for the NormalizationLayer." alt="NormalizationDescriptor" shape="rect" coords="221,1288,432,1312"/>
+<area href="structarmnn_1_1_null_descriptor.xhtml" title="Null Descriptor used as a return value from the IConnectableLayer GetParameters method by layers whic..." alt="NullDescriptor" shape="rect" coords="221,1344,432,1368"/>
+<area href="structarmnn_1_1_origins_descriptor.xhtml" title="An OriginsDescriptor for the ConcatLayer." alt="OriginsDescriptor" shape="rect" coords="221,1400,432,1424"/>
+<area href="structarmnn_1_1_pad_descriptor.xhtml" title="A PadDescriptor for the PadLayer." alt="PadDescriptor" shape="rect" coords="221,1456,432,1480"/>
+<area href="structarmnn_1_1_permute_descriptor.xhtml" title="A PermuteDescriptor for the PermuteLayer." alt="PermuteDescriptor" shape="rect" coords="221,1512,432,1536"/>
+<area href="structarmnn_1_1_pooling2d_descriptor.xhtml" title="A Pooling2dDescriptor for the Pooling2dLayer." alt="Pooling2dDescriptor" shape="rect" coords="221,1568,432,1592"/>
+<area href="structarmnn_1_1_pooling3d_descriptor.xhtml" title="A Pooling3dDescriptor for the Pooling3dLayer." alt="Pooling3dDescriptor" shape="rect" coords="221,1624,432,1648"/>
+<area href="structarmnn_1_1_pre_compiled_descriptor.xhtml" title="A PreCompiledDescriptor for the PreCompiledLayer." alt="PreCompiledDescriptor" shape="rect" coords="221,1680,432,1704"/>
+<area href="structarmnn_1_1_q_lstm_descriptor.xhtml" title="A QLstmDescriptor for the QLstmLayer." alt="QLstmDescriptor" shape="rect" coords="221,1736,432,1760"/>
+<area href="structarmnn_1_1_reduce_descriptor.xhtml" title="A ReduceDescriptor for the REDUCE operators." alt="ReduceDescriptor" shape="rect" coords="221,1792,432,1816"/>
+<area href="structarmnn_1_1_reshape_descriptor.xhtml" title="A ReshapeDescriptor for the ReshapeLayer." alt="ReshapeDescriptor" shape="rect" coords="221,1848,432,1872"/>
+<area href="structarmnn_1_1_resize_descriptor.xhtml" title="A ResizeDescriptor for the ResizeLayer." alt="ResizeDescriptor" shape="rect" coords="221,1904,432,1928"/>
+<area href="structarmnn_1_1_slice_descriptor.xhtml" title="A SliceDescriptor for the SliceLayer." alt="SliceDescriptor" shape="rect" coords="221,1960,432,1984"/>
+<area href="structarmnn_1_1_softmax_descriptor.xhtml" title="A SoftmaxDescriptor for the SoftmaxLayer." alt="SoftmaxDescriptor" shape="rect" coords="221,2016,432,2040"/>
+<area href="structarmnn_1_1_space_to_batch_nd_descriptor.xhtml" title="A SpaceToBatchNdDescriptor for the SpaceToBatchNdLayer." alt="SpaceToBatchNdDescriptor" shape="rect" coords="221,2072,432,2096"/>
+<area href="structarmnn_1_1_space_to_depth_descriptor.xhtml" title="A SpaceToDepthDescriptor for the SpaceToDepthLayer." alt="SpaceToDepthDescriptor" shape="rect" coords="221,2128,432,2152"/>
+<area href="structarmnn_1_1_stack_descriptor.xhtml" title="A StackDescriptor for the StackLayer." alt="StackDescriptor" shape="rect" coords="221,2184,432,2208"/>
+<area href="structarmnn_1_1_stand_in_descriptor.xhtml" title="A StandInDescriptor for the StandIn layer." alt="StandInDescriptor" shape="rect" coords="221,2240,432,2264"/>
+<area href="structarmnn_1_1_strided_slice_descriptor.xhtml" title="A StridedSliceDescriptor for the StridedSliceLayer." alt="StridedSliceDescriptor" shape="rect" coords="221,2296,432,2320"/>
+<area href="structarmnn_1_1_transpose_convolution2d_descriptor.xhtml" title="A TransposeConvolution2dDescriptor for the TransposeConvolution2dLayer." alt="TransposeConvolution2dDescriptor" shape="rect" coords="221,2352,432,2376"/>
+<area href="structarmnn_1_1_transpose_descriptor.xhtml" title="A TransposeDescriptor for the TransposeLayer." alt="TransposeDescriptor" shape="rect" coords="221,2408,432,2432"/>
+<area href="structarmnn_1_1_views_descriptor.xhtml" title="A ViewsDescriptor for the SplitterLayer." alt="ViewsDescriptor" shape="rect" coords="221,2464,432,2488"/>
+  </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:ac618666b3c6d65d2c88bcbb7abeed343"><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.xhtml#ac618666b3c6d65d2c88bcbb7abeed343">IsNull</a> () const</td></tr>
+<tr class="separator:ac618666b3c6d65d2c88bcbb7abeed343"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5e0f82ef2f18eb897e6d6f1845e74033"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_base_descriptor.xhtml#a5e0f82ef2f18eb897e6d6f1845e74033">~BaseDescriptor</a> ()=default</td></tr>
+<tr class="separator:a5e0f82ef2f18eb897e6d6f1845e74033"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Base class for all descriptors. </p>
+
+<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00022">22</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a5e0f82ef2f18eb897e6d6f1845e74033"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5e0f82ef2f18eb897e6d6f1845e74033">&#9670;&nbsp;</a></span>~BaseDescriptor()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual ~<a class="el" href="structarmnn_1_1_base_descriptor.xhtml">BaseDescriptor</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">virtual</span><span class="mlabel">default</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="ac618666b3c6d65d2c88bcbb7abeed343"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac618666b3c6d65d2c88bcbb7abeed343">&#9670;&nbsp;</a></span>IsNull()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual bool IsNull </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Reimplemented in <a class="el" href="structarmnn_1_1_null_descriptor.xhtml#ad7c0bdb2b6e538d8f75596d8cdb633c6">NullDescriptor</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
+</div><!-- fragment -->
+</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_base_descriptor.xhtml">BaseDescriptor</a></li>
+    <li class="footer">Generated on Thu May 18 2023 10:35:45 for ArmNN 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>
author	Nikhil Raj <nikhil.raj@arm.com>	2023-05-19 11:14:28 +0100
committer	Nikhil Raj <nikhil.raj@arm.com>	2023-05-19 11:14:28 +0100
commit	8efb48a6847c5cd166c561127ae6611150963ce3 (patch)
tree	f4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/structarmnn_1_1_base_descriptor.xhtml
parent	023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff)
download	armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz