diff options
| author | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
|---|---|---|
| committer | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
| commit | ae050524109f1ce827962665436ef7430f2ac479 (patch) | |
| tree | a087fe0c77570971dd7979f2757426c24e91afc7 /23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml | |
| parent | 8d2ca734165a068478df7cffa46185680b05cd20 (diff) | |
| download | armnn-ae050524109f1ce827962665436ef7430f2ac479.tar.gz | |
IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub.
* Updating Doxygen documentation for 23.02 release.
Signed-off-by: David Monahan <david.monahan@arm.com>
Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82
Diffstat (limited to '23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml')
| -rw-r--r-- | 23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml | 114 |
1 files changed, 88 insertions, 26 deletions
diff --git a/23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml b/23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml index 14ff8f952d..ac611693e7 100644 --- a/23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml +++ b/23.02/_i_memory_optimizer_strategy_8hpp_source.xhtml @@ -8,7 +8,7 @@ <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="generator" content="Doxygen 1.8.17"/> <meta name="robots" content="NOINDEX, NOFOLLOW" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ArmNN: include/armnn/backends/IMemoryOptimizerStrategy.hpp Source File</title> @@ -19,9 +19,6 @@ <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> @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); -</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +</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> @@ -51,18 +49,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -76,7 +77,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('_i_memory_optimizer_strategy_8hpp_source.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('_i_memory_optimizer_strategy_8hpp_source.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -98,31 +101,90 @@ $(document).ready(function(){initNavTree('_i_memory_optimizer_strategy_8hpp_sour <div class="title">IMemoryOptimizerStrategy.hpp</div> </div> </div><!--header--> <div class="contents"> -<a href="_i_memory_optimizer_strategy_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <<a class="code" href="_types_8hpp.xhtml">armnn/Types.hpp</a>></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// A MemBlock represents a memory usage requirement in time and space and can be seen as essentially a rectangle</span></div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml"> 13</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_mem_block.xhtml">MemBlock</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8"> 15</a></span>  <a class="code" href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8">MemBlock</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> startOfLife,</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endOfLife,</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> memSize,</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">size_t</span> offset,</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  : <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 class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3"> 22</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3">m_StartOfLife</a>; <span class="comment">// Y start inclusive</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11"> 23</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11">m_EndOfLife</a>; <span class="comment">// Y end inclusive</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53"> 25</a></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53">m_MemSize</a>; <span class="comment">// Offset + Memsize = X end</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d"> 26</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d">m_Offset</a>; <span class="comment">// X start</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b"> 28</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b">m_Index</a>; <span class="comment">// Index to keep order</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// A MemBin represents a single contiguous area of memory that can store 1-n number of MemBlocks</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml"> 32</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_mem_bin.xhtml">MemBin</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb"> 34</a></span>  std::vector<MemBlock> <a class="code" href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb">m_MemBlocks</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270"> 35</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270">m_MemSize</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> };</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// IMemoryOptimizerStrategy will set m_Offset of the MemBlocks,</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// sort them into 1-n bins, then pair each bin of MemBlocks with an int specifying it's total size</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// A IMemoryOptimizerStrategy must ensure that</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// 1: All MemBlocks have been assigned to a MemBin</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// 2: No MemBlock is assigned to multiple MemBins</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// 3: No two Memblocks in a MemBin overlap in both the X and Y axis</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// (a strategy cannot change the y axis or length of a MemBlock)</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml"> 45</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489"> 48</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489">~IMemoryOptimizerStrategy</a>() {}</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> std::string GetName() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> GetMemBlockStrategyType() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> std::vector<MemBin> <a class="code" href="namespacearmnn.xhtml#a82e98ef05fd67036d1195ba17174d685">Optimize</a>(std::vector<MemBlock>& memBlocks) = 0;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_i_memory_optimizer_strategy_xhtml_a9b47d46d6792d6cbcd98ff4f26ac8489"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489">armnn::IMemoryOptimizerStrategy::~IMemoryOptimizerStrategy</a></div><div class="ttdeci">virtual ~IMemoryOptimizerStrategy()</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00048">IMemoryOptimizerStrategy.hpp:48</a></div></div> -<div class="ttc" id="classarmnn_1_1_i_memory_optimizer_strategy_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">armnn::IMemoryOptimizerStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00045">IMemoryOptimizerStrategy.hpp:45</a></div></div> -<div class="ttc" id="structarmnn_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="structarmnn_1_1_mem_bin_xhtml_aeb1783f0f3f528e11f9ce70f0214f8bb"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb">armnn::MemBin::m_MemBlocks</a></div><div class="ttdeci">std::vector< MemBlock > m_MemBlocks</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00034">IMemoryOptimizerStrategy.hpp:34</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors. </div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml_a82e98ef05fd67036d1195ba17174d685"><div class="ttname"><a href="namespacearmnn.xhtml#a82e98ef05fd67036d1195ba17174d685">armnn::Optimize</a></div><div class="ttdeci">IOptimizedNetworkPtr Optimize(const INetwork &network, const std::vector< BackendId > &backendPreferences, const IDeviceSpec &deviceSpec, const OptimizerOptions &options=OptimizerOptions(), Optional< std::vector< std::string > &> messages=EmptyOptional())</div><div class="ttdoc">Create an optimized version of the network. </div><div class="ttdef"><b>Definition:</b> <a href="_network_8cpp_source.xhtml#l01773">Network.cpp:1773</a></div></div> -<div class="ttc" id="structarmnn_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="_types_8hpp_xhtml"><div class="ttname"><a href="_types_8hpp.xhtml">Types.hpp</a></div></div> -<div class="ttc" id="structarmnn_1_1_mem_block_xhtml"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml">armnn::MemBlock</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00013">IMemoryOptimizerStrategy.hpp:13</a></div></div> -<div class="ttc" id="structarmnn_1_1_mem_bin_xhtml"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml">armnn::MemBin</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00032">IMemoryOptimizerStrategy.hpp:32</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml_a7100de49939c3e393101f78d425a98c6"><div class="ttname"><a href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">armnn::MemBlockStrategyType</a></div><div class="ttdeci">MemBlockStrategyType</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.xhtml#l00239">Types.hpp:239</a></div></div> -<div class="ttc" id="structarmnn_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="structarmnn_1_1_mem_bin_xhtml_a08e50de8fcc7560644bdabc7356bb270"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270">armnn::MemBin::m_MemSize</a></div><div class="ttdeci">size_t m_MemSize</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00035">IMemoryOptimizerStrategy.hpp:35</a></div></div> -<div class="ttc" id="structarmnn_1_1_mem_block_xhtml_aaa6babfc701410e0df93d41ccc2deff8"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8">armnn::MemBlock::MemBlock</a></div><div class="ttdeci">MemBlock(const unsigned int startOfLife, const unsigned int endOfLife, const size_t memSize, size_t offset, const unsigned int index)</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00015">IMemoryOptimizerStrategy.hpp:15</a></div></div> -<div class="ttc" id="structarmnn_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="structarmnn_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> +<a href="_i_memory_optimizer_strategy_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <<a class="code" href="_types_8hpp.xhtml">armnn/Types.hpp</a>></span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// A MemBlock represents a memory usage requirement in time and space and can be seen as essentially a rectangle</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml"> 13</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_mem_block.xhtml">MemBlock</a></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div> +<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8"> 15</a></span>  <a class="code" href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8">MemBlock</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> startOfLife,</div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> endOfLife,</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> memSize,</div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">size_t</span> offset,</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index)</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  : <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 class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> +<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3"> 22</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a709b862a06a33e0f77e0d5cfb95daaf3">m_StartOfLife</a>; <span class="comment">// Y start inclusive</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11"> 23</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#afb654a0f03aca4f7f73a9008fab83b11">m_EndOfLife</a>; <span class="comment">// Y end inclusive</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> +<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53"> 25</a></span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#ac972eed0c811e23b9e1060cee4ac5a53">m_MemSize</a>; <span class="comment">// Offset + Memsize = X end</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d"> 26</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a7fa2df31ffac52484e0612a31fd4256d">m_Offset</a>; <span class="comment">// X start</span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> +<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b"> 28</a></span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structarmnn_1_1_mem_block.xhtml#a33204e9c0c3d6dc19cec97536ce9527b">m_Index</a>; <span class="comment">// Index to keep order</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// A MemBin represents a single contiguous area of memory that can store 1-n number of MemBlocks</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml"> 32</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_mem_bin.xhtml">MemBin</a></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div> +<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb"> 34</a></span>  std::vector<MemBlock> <a class="code" href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb">m_MemBlocks</a>;</div> +<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270"> 35</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270">m_MemSize</a>;</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> };</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// IMemoryOptimizerStrategy will set m_Offset of the MemBlocks,</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// sort them into 1-n bins, then pair each bin of MemBlocks with an int specifying it's total size</span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// A IMemoryOptimizerStrategy must ensure that</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// 1: All MemBlocks have been assigned to a MemBin</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// 2: No MemBlock is assigned to multiple MemBins</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// 3: No two Memblocks in a MemBin overlap in both the X and Y axis</span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// (a strategy cannot change the y axis or length of a MemBlock)</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml"> 45</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489"> 48</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489">~IMemoryOptimizerStrategy</a>() {}</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> std::string <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a46f9918b14061163f435d80860b02b56">GetName</a>() <span class="keyword">const</span> = 0;</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a33c9902a46246bcf4d44855b4d866dcb">GetMemBlockStrategyType</a>() <span class="keyword">const</span> = 0;</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> std::vector<MemBin> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a1a9447457df9be8f8186fe73bba4cb72">Optimize</a>(std::vector<MemBlock>& memBlocks) = 0;</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> } <span class="comment">// namespace armnn</span></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_xhtml_a46f9918b14061163f435d80860b02b56"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a46f9918b14061163f435d80860b02b56">armnn::IMemoryOptimizerStrategy::GetName</a></div><div class="ttdeci">virtual std::string GetName() const =0</div></div> +<div class="ttc" id="astructarmnn_1_1_mem_bin_xhtml_a08e50de8fcc7560644bdabc7356bb270"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml#a08e50de8fcc7560644bdabc7356bb270">armnn::MemBin::m_MemSize</a></div><div class="ttdeci">size_t m_MemSize</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00035">IMemoryOptimizerStrategy.hpp:35</a></div></div> +<div class="ttc" id="astructarmnn_1_1_mem_block_xhtml_aaa6babfc701410e0df93d41ccc2deff8"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml#aaa6babfc701410e0df93d41ccc2deff8">armnn::MemBlock::MemBlock</a></div><div class="ttdeci">MemBlock(const unsigned int startOfLife, const unsigned int endOfLife, const size_t memSize, size_t offset, const unsigned int index)</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00015">IMemoryOptimizerStrategy.hpp:15</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_xhtml_a33c9902a46246bcf4d44855b4d866dcb"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a33c9902a46246bcf4d44855b4d866dcb">armnn::IMemoryOptimizerStrategy::GetMemBlockStrategyType</a></div><div class="ttdeci">virtual MemBlockStrategyType GetMemBlockStrategyType() const =0</div></div> +<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_xhtml_a1a9447457df9be8f8186fe73bba4cb72"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a1a9447457df9be8f8186fe73bba4cb72">armnn::IMemoryOptimizerStrategy::Optimize</a></div><div class="ttdeci">virtual std::vector< MemBin > Optimize(std::vector< MemBlock > &memBlocks)=0</div></div> +<div class="ttc" id="anamespacearmnn_xhtml_a7100de49939c3e393101f78d425a98c6"><div class="ttname"><a href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">armnn::MemBlockStrategyType</a></div><div class="ttdeci">MemBlockStrategyType</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.xhtml#l00239">Types.hpp:239</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_xhtml_a9b47d46d6792d6cbcd98ff4f26ac8489"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml#a9b47d46d6792d6cbcd98ff4f26ac8489">armnn::IMemoryOptimizerStrategy::~IMemoryOptimizerStrategy</a></div><div class="ttdeci">virtual ~IMemoryOptimizerStrategy()</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00048">IMemoryOptimizerStrategy.hpp:48</a></div></div> +<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> +<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"><div class="ttname"><a href="structarmnn_1_1_mem_block.xhtml">armnn::MemBlock</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00013">IMemoryOptimizerStrategy.hpp:13</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_bin_xhtml_aeb1783f0f3f528e11f9ce70f0214f8bb"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml#aeb1783f0f3f528e11f9ce70f0214f8bb">armnn::MemBin::m_MemBlocks</a></div><div class="ttdeci">std::vector< MemBlock > m_MemBlocks</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00034">IMemoryOptimizerStrategy.hpp:34</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> +<div class="ttc" id="astructarmnn_1_1_mem_bin_xhtml"><div class="ttname"><a href="structarmnn_1_1_mem_bin.xhtml">armnn::MemBin</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00032">IMemoryOptimizerStrategy.hpp:32</a></div></div> +<div class="ttc" id="a_types_8hpp_xhtml"><div class="ttname"><a href="_types_8hpp.xhtml">Types.hpp</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">armnn::IMemoryOptimizerStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.xhtml#l00045">IMemoryOptimizerStrategy.hpp:45</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="dir_d44c64559bbebec7f509842c48db8b23.xhtml">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.xhtml">armnn</a></li><li class="navelem"><a class="el" href="dir_8946eb9d8f826e973720979438627a91.xhtml">backends</a></li><li class="navelem"><a class="el" href="_i_memory_optimizer_strategy_8hpp.xhtml">IMemoryOptimizerStrategy.hpp</a></li> - <li class="footer">Generated on Fri Feb 24 2023 10:24:24 for ArmNN by + <li class="footer">Generated on Wed Mar 22 2023 15:52:59 for ArmNN by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |