aboutsummaryrefslogtreecommitdiff
path: root/23.05/classarmnn_1_1_constant_memory_strategy.xhtml
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2023-05-19 11:14:28 +0100
committerNikhil Raj <nikhil.raj@arm.com>2023-05-19 11:14:28 +0100
commit8efb48a6847c5cd166c561127ae6611150963ce3 (patch)
treef4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/classarmnn_1_1_constant_memory_strategy.xhtml
parent023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff)
downloadarmnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz
Update Doxygen docu for 23.05
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe
Diffstat (limited to '23.05/classarmnn_1_1_constant_memory_strategy.xhtml')
-rw-r--r--23.05/classarmnn_1_1_constant_memory_strategy.xhtml298
1 files changed, 298 insertions, 0 deletions
diff --git a/23.05/classarmnn_1_1_constant_memory_strategy.xhtml b/23.05/classarmnn_1_1_constant_memory_strategy.xhtml
new file mode 100644
index 0000000000..72e397c230
--- /dev/null
+++ b/23.05/classarmnn_1_1_constant_memory_strategy.xhtml
@@ -0,0 +1,298 @@
+<!-- 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: ConstantMemoryStrategy Class 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('classarmnn_1_1_constant_memory_strategy.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="classarmnn_1_1_constant_memory_strategy-members.xhtml">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">ConstantMemoryStrategy Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="_constant_memory_strategy_8hpp_source.xhtml">ConstantMemoryStrategy.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for ConstantMemoryStrategy:</div>
+<div class="dyncontent">
+ <div class="center">
+ <img src="classarmnn_1_1_constant_memory_strategy.png" usemap="#ConstantMemoryStrategy_map" alt=""/>
+ <map id="ConstantMemoryStrategy_map" name="ConstantMemoryStrategy_map">
+<area href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml" alt="IMemoryOptimizerStrategy" shape="rect" coords="0,0,161,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:a63eced178760b5076454c97510075aec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.xhtml#a63eced178760b5076454c97510075aec">ConstantMemoryStrategy</a> ()</td></tr>
+<tr class="separator:a63eced178760b5076454c97510075aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a84ae72d221e80b93c2246b44a50fa361"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.xhtml#a84ae72d221e80b93c2246b44a50fa361">GetName</a> () const override</td></tr>
+<tr class="separator:a84ae72d221e80b93c2246b44a50fa361"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acd35ef4810ce3b938f5454bdee0cb826"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.xhtml#acd35ef4810ce3b938f5454bdee0cb826">GetMemBlockStrategyType</a> () const override</td></tr>
+<tr class="separator:acd35ef4810ce3b938f5454bdee0cb826"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ada820fb9d89d2fb75bacaffe511791b7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_bin.xhtml">MemBin</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.xhtml#ada820fb9d89d2fb75bacaffe511791b7">Optimize</a> (std::vector&lt; <a class="el" href="structarmnn_1_1_mem_block.xhtml">MemBlock</a> &gt; &amp;memBlocks) override</td></tr>
+<tr class="separator:ada820fb9d89d2fb75bacaffe511791b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="inherit_header pub_methods_classarmnn_1_1_i_memory_optimizer_strategy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_i_memory_optimizer_strategy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a></td></tr>
+<tr class="memitem:a9b47d46d6792d6cbcd98ff4f26ac8489 inherit pub_methods_classarmnn_1_1_i_memory_optimizer_strategy"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489">~IMemoryOptimizerStrategy</a> ()</td></tr>
+<tr class="separator:a9b47d46d6792d6cbcd98ff4f26ac8489 inherit pub_methods_classarmnn_1_1_i_memory_optimizer_strategy"><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="_constant_memory_strategy_8hpp_source.xhtml#l00013">13</a> of file <a class="el" href="_constant_memory_strategy_8hpp_source.xhtml">ConstantMemoryStrategy.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a63eced178760b5076454c97510075aec"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a63eced178760b5076454c97510075aec">&#9670;&nbsp;</a></span>ConstantMemoryStrategy()</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="classarmnn_1_1_constant_memory_strategy.xhtml">ConstantMemoryStrategy</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="_constant_memory_strategy_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_constant_memory_strategy_8hpp_source.xhtml">ConstantMemoryStrategy.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; : m_Name(std::string(<span class="stringliteral">&quot;ConstantMemoryStrategy&quot;</span>))</div>
+<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; , m_MemBlockStrategyType(<a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">MemBlockStrategyType::SingleAxisPacking</a>) {}</div>
+</div><!-- fragment -->
+<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">armnn::SingleAxisPacking</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="acd35ef4810ce3b938f5454bdee0cb826"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acd35ef4810ce3b938f5454bdee0cb826">&#9670;&nbsp;</a></span>GetMemBlockStrategyType()</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="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> GetMemBlockStrategyType </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">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a33c9902a46246bcf4d44855b4d866dcb">IMemoryOptimizerStrategy</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml#l00016">16</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml">ConstantMemoryStrategy.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
+<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">return</span> m_MemBlockStrategyType;</div>
+<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a84ae72d221e80b93c2246b44a50fa361"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a84ae72d221e80b93c2246b44a50fa361">&#9670;&nbsp;</a></span>GetName()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">std::string GetName </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">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a46f9918b14061163f435d80860b02b56">IMemoryOptimizerStrategy</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml#l00011">11</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml">ConstantMemoryStrategy.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div>
+<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keywordflow">return</span> m_Name;</div>
+<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="ada820fb9d89d2fb75bacaffe511791b7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ada820fb9d89d2fb75bacaffe511791b7">&#9670;&nbsp;</a></span>Optimize()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_bin.xhtml">MemBin</a> &gt; Optimize </td>
+ <td>(</td>
+ <td class="paramtype">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_block.xhtml">MemBlock</a> &gt; &amp;&#160;</td>
+ <td class="paramname"><em>memBlocks</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a1a9447457df9be8f8186fe73bba4cb72">IMemoryOptimizerStrategy</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml#l00025">25</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.xhtml">ConstantMemoryStrategy.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
+<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; std::vector&lt;MemBin&gt; memBins;</div>
+<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; memBins.reserve(memBlocks.size());</div>
+<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
+<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; memBlock : memBlocks)</div>
+<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
+<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; MemBin memBin;</div>
+<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; memBin.m_MemSize = memBlock.m_MemSize;</div>
+<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; memBin.m_MemBlocks.reserve(1);</div>
+<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; memBlock.m_Offset = 0;</div>
+<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; memBin.m_MemBlocks.push_back(memBlock);</div>
+<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; memBins.push_back(memBin);</div>
+<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div>
+<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
+<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> memBins;</div>
+<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div>
+</div><!-- fragment -->
+<p class="reference">References <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00034">MemBin::m_MemBlocks</a>, and <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00035">MemBin::m_MemSize</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/<a class="el" href="_constant_memory_strategy_8hpp_source.xhtml">ConstantMemoryStrategy.hpp</a></li>
+<li>src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/<a class="el" href="_constant_memory_strategy_8cpp_source.xhtml">ConstantMemoryStrategy.cpp</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div class="ttc" id="anamespacearmnn_xhtml_a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7"><div class="ttname"><a href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">armnn::MemBlockStrategyType::SingleAxisPacking</a></div><div class="ttdeci">@ SingleAxisPacking</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="classarmnn_1_1_constant_memory_strategy.xhtml">ConstantMemoryStrategy</a></li>
+ <li class="footer">Generated on Thu May 18 2023 10:35:46 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>