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_mem_block.xhtml
parent: 023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff)
download: armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz
1 files changed, 295 insertions, 0 deletions
diff --git a/23.05/structarmnn_1_1_mem_block.xhtml b/23.05/structarmnn_1_1_mem_block.xhtml
new file mode 100644
index 0000000000..333f9927f4
--- /dev/null
+++ b/23.05/structarmnn_1_1_mem_block.xhtml
@@ -0,0 +1,295 @@
+<!-- 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: MemBlock 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_mem_block.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="#pub-attribs">Public Attributes</a> &#124;
+<a href="structarmnn_1_1_mem_block-members.xhtml">List of all members</a>  </div>
+  <div class="headertitle">
+<div class="title">MemBlock Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>&gt;</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:aaa6babfc701410e0df93d41ccc2deff8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8">MemBlock</a> (const unsigned int startOfLife, const unsigned int endOfLife, const size_t memSize, size_t offset, const unsigned int index)</td></tr>
+<tr class="separator:aaa6babfc701410e0df93d41ccc2deff8"><td class="memSeparator" colspan="2">&#160;</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:a709b862a06a33e0f77e0d5cfb95daaf3"><td class="memItemLeft" align="right" valign="top">const unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3">m_StartOfLife</a></td></tr>
+<tr class="separator:a709b862a06a33e0f77e0d5cfb95daaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afb654a0f03aca4f7f73a9008fab83b11"><td class="memItemLeft" align="right" valign="top">const unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11">m_EndOfLife</a></td></tr>
+<tr class="separator:afb654a0f03aca4f7f73a9008fab83b11"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac972eed0c811e23b9e1060cee4ac5a53"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53">m_MemSize</a></td></tr>
+<tr class="separator:ac972eed0c811e23b9e1060cee4ac5a53"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7fa2df31ffac52484e0612a31fd4256d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d">m_Offset</a></td></tr>
+<tr class="separator:a7fa2df31ffac52484e0612a31fd4256d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a33204e9c0c3d6dc19cec97536ce9527b"><td class="memItemLeft" align="right" valign="top">const unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b">m_Index</a></td></tr>
+<tr class="separator:a33204e9c0c3d6dc19cec97536ce9527b"><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 class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00013">13</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aaa6babfc701410e0df93d41ccc2deff8"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaa6babfc701410e0df93d41ccc2deff8">&#9670;&nbsp;</a></span>MemBlock()</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_mem_block.xhtml">MemBlock</a> </td>
+          <td>(</td>
+          <td class="paramtype">const unsigned int&#160;</td>
+          <td class="paramname"><em>startOfLife</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const unsigned int&#160;</td>
+          <td class="paramname"><em>endOfLife</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const size_t&#160;</td>
+          <td class="paramname"><em>memSize</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>offset</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const unsigned int&#160;</td>
+          <td class="paramname"><em>index</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</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="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00015">15</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    : <a class="code" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3">m_StartOfLife</a>(startOfLife), <a class="code" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11">m_EndOfLife</a>(endOfLife), <a class="code" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53">m_MemSize</a>(memSize), <a class="code" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d">m_Offset</a>(offset), <a class="code" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b">m_Index</a>(index) {}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<h2 class="groupheader">Member Data Documentation</h2>
+<a id="afb654a0f03aca4f7f73a9008fab83b11"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afb654a0f03aca4f7f73a9008fab83b11">&#9670;&nbsp;</a></span>m_EndOfLife</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const unsigned int m_EndOfLife</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00023">23</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a33204e9c0c3d6dc19cec97536ce9527b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a33204e9c0c3d6dc19cec97536ce9527b">&#9670;&nbsp;</a></span>m_Index</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const unsigned int m_Index</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00028">28</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ac972eed0c811e23b9e1060cee4ac5a53"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac972eed0c811e23b9e1060cee4ac5a53">&#9670;&nbsp;</a></span>m_MemSize</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const size_t m_MemSize</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00025">25</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_single_axis_priority_list_8cpp_source.xhtml#l00214">SingleAxisPriorityList::Optimize()</a>.</p>
+
+</div>
+</div>
+<a id="a7fa2df31ffac52484e0612a31fd4256d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7fa2df31ffac52484e0612a31fd4256d">&#9670;&nbsp;</a></span>m_Offset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">size_t m_Offset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00026">26</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+
+</div>
+</div>
+<a id="a709b862a06a33e0f77e0d5cfb95daaf3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a709b862a06a33e0f77e0d5cfb95daaf3">&#9670;&nbsp;</a></span>m_StartOfLife</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const unsigned int m_StartOfLife</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00022">22</a> of file <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_single_axis_priority_list_8cpp_source.xhtml#l00214">SingleAxisPriorityList::Optimize()</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li>include/armnn/backends/<a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml">IMemoryOptimizerStrategy.hpp</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_ac972eed0c811e23b9e1060cee4ac5a53"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53">armnn::MemBlock::m_MemSize</a></div><div class="ttdeci">const size_t m_MemSize</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00025">IMemoryOptimizerStrategy.hpp:25</a></div></div>
+<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_a709b862a06a33e0f77e0d5cfb95daaf3"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3">armnn::MemBlock::m_StartOfLife</a></div><div class="ttdeci">const unsigned int m_StartOfLife</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00022">IMemoryOptimizerStrategy.hpp:22</a></div></div>
+<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_afb654a0f03aca4f7f73a9008fab83b11"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11">armnn::MemBlock::m_EndOfLife</a></div><div class="ttdeci">const unsigned int m_EndOfLife</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00023">IMemoryOptimizerStrategy.hpp:23</a></div></div>
+<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_a7fa2df31ffac52484e0612a31fd4256d"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d">armnn::MemBlock::m_Offset</a></div><div class="ttdeci">size_t m_Offset</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00026">IMemoryOptimizerStrategy.hpp:26</a></div></div>
+<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_a33204e9c0c3d6dc19cec97536ce9527b"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b">armnn::MemBlock::m_Index</a></div><div class="ttdeci">const unsigned int m_Index</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00028">IMemoryOptimizerStrategy.hpp:28</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.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_mem_block.xhtml">MemBlock</a></li>
+    <li class="footer">Generated on Thu May 18 2023 10:35:48 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_mem_block.xhtml
parent	023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff)
download	armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz