diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
commit | 8d2ca734165a068478df7cffa46185680b05cd20 (patch) | |
tree | 0433a7e6b007fe4639334c4438e58e9872a34b20 /23.02/_single_axis_priority_list_8hpp_source.xhtml | |
parent | cb0630959aeae05bc2ae9f6d80cf5f5983a8fb77 (diff) | |
download | armnn-8d2ca734165a068478df7cffa46185680b05cd20.tar.gz |
Update Doxygen docu for 23.02
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: Ie6c19a27d50fefab2796b2b5875374e81f5bf971
Diffstat (limited to '23.02/_single_axis_priority_list_8hpp_source.xhtml')
-rw-r--r-- | 23.02/_single_axis_priority_list_8hpp_source.xhtml | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/23.02/_single_axis_priority_list_8hpp_source.xhtml b/23.02/_single_axis_priority_list_8hpp_source.xhtml new file mode 100644 index 0000000000..f55296dd41 --- /dev/null +++ b/23.02/_single_axis_priority_list_8hpp_source.xhtml @@ -0,0 +1,125 @@ +<!-- 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.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/SingleAxisPriorityList.hpp Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" 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"> +  <span id="projectnumber">23.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_single_axis_priority_list_8hpp_source.xhtml','');}); +</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="headertitle"> +<div class="title">SingleAxisPriorityList.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_single_axis_priority_list_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> <span class="preprocessor">#include <<a class="code" href="_i_memory_optimizer_strategy_8hpp.xhtml">armnn/backends/IMemoryOptimizerStrategy.hpp</a>></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <tuple></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <algorithm></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <list></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> /// SingleAxisPriorityList sorts the MemBlocks according to some priority,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /// then trys to place them into as few bins as possible</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_single_axis_priority_list.xhtml"> 20</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_single_axis_priority_list.xhtml">SingleAxisPriorityList</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_single_axis_priority_list.xhtml#a75d3600935ceb7ba8ca18219f6dff75c"> 23</a></span>  <a class="code" href="classarmnn_1_1_single_axis_priority_list.xhtml#a75d3600935ceb7ba8ca18219f6dff75c">SingleAxisPriorityList</a>()</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  : m_Name(<a class="code" href="namespacestd.xhtml">std</a>::string(<span class="stringliteral">"SingleAxisPriorityList"</span>))</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  , m_MemBlockStrategyType(<a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a>::<a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">SingleAxisPacking</a>) {}</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  std::string <a class="code" href="classarmnn_1_1_single_axis_priority_list.xhtml#a84ae72d221e80b93c2246b44a50fa361">GetName</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> <a class="code" href="classarmnn_1_1_single_axis_priority_list.xhtml#acd35ef4810ce3b938f5454bdee0cb826">GetMemBlockStrategyType</a>() <span class="keyword">const override</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>  std::vector<MemBin> <a class="code" href="classarmnn_1_1_single_axis_priority_list.xhtml#ada820fb9d89d2fb75bacaffe511791b7">Optimize</a>(std::vector<MemBlock>& memBlocks) <span class="keyword">override</span>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Tracks all memBlocks and their positions in a bin as well as their maximum memSize</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">struct </span>BinTracker;</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">// PlaceBlocks takes a list of MemBlock* and fits them into n bins.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// A block can only fit into an existing bin if it's lifetime does not overlap with the lifetime of the</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// blocks already in a bin.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// If no appropriate bin is available a new one is created.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> PlaceBlocks(<span class="keyword">const</span> std::list<MemBlock*>& priorityList,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::vector<BinTracker>& placedBlocks,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxLifetime);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  std::string m_Name;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> m_MemBlockStrategyType;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  };</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="comment">// namespace armnn</span></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="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="classarmnn_1_1_single_axis_priority_list_xhtml_a75d3600935ceb7ba8ca18219f6dff75c"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.xhtml#a75d3600935ceb7ba8ca18219f6dff75c">armnn::SingleAxisPriorityList::SingleAxisPriorityList</a></div><div class="ttdeci">SingleAxisPriorityList()</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8hpp_source.xhtml#l00023">SingleAxisPriorityList.hpp:23</a></div></div> +<div class="ttc" id="namespacestd_xhtml"><div class="ttname"><a href="namespacestd.xhtml">std</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_id_8hpp_source.xhtml#l00149">BackendId.hpp:149</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="namespacearmnn_xhtml_a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7"><div class="ttname"><a href="namespacearmnn.xhtml#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">armnn::MemBlockStrategyType::SingleAxisPacking</a></div></div> +<div class="ttc" id="_i_memory_optimizer_strategy_8hpp_xhtml"><div class="ttname"><a href="_i_memory_optimizer_strategy_8hpp.xhtml">IMemoryOptimizerStrategy.hpp</a></div></div> +<div class="ttc" id="classarmnn_1_1_single_axis_priority_list_xhtml_ada820fb9d89d2fb75bacaffe511791b7"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.xhtml#ada820fb9d89d2fb75bacaffe511791b7">armnn::SingleAxisPriorityList::Optimize</a></div><div class="ttdeci">std::vector< MemBin > Optimize(std::vector< MemBlock > &memBlocks) override</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8cpp_source.xhtml#l00214">SingleAxisPriorityList.cpp:214</a></div></div> +<div class="ttc" id="classarmnn_1_1_single_axis_priority_list_xhtml_acd35ef4810ce3b938f5454bdee0cb826"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.xhtml#acd35ef4810ce3b938f5454bdee0cb826">armnn::SingleAxisPriorityList::GetMemBlockStrategyType</a></div><div class="ttdeci">MemBlockStrategyType GetMemBlockStrategyType() const override</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8cpp_source.xhtml#l00028">SingleAxisPriorityList.cpp:28</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="classarmnn_1_1_single_axis_priority_list_xhtml_a84ae72d221e80b93c2246b44a50fa361"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.xhtml#a84ae72d221e80b93c2246b44a50fa361">armnn::SingleAxisPriorityList::GetName</a></div><div class="ttdeci">std::string GetName() const override</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8cpp_source.xhtml#l00024">SingleAxisPriorityList.cpp:24</a></div></div> +<div class="ttc" id="classarmnn_1_1_single_axis_priority_list_xhtml"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.xhtml">armnn::SingleAxisPriorityList</a></div><div class="ttdoc">SingleAxisPriorityList sorts the MemBlocks according to some priority, then trys to place them into a...</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8hpp_source.xhtml#l00020">SingleAxisPriorityList.hpp:20</a></div></div> +</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_797a213d7d01b98ef12d53b0820ea64e.xhtml">backendsCommon</a></li><li class="navelem"><a class="el" href="dir_222b9efbf86b09050d83daeffd81e1d1.xhtml">memoryOptimizerStrategyLibrary</a></li><li class="navelem"><a class="el" href="dir_d49dbf30bb5f789805533dd1aa43d8d9.xhtml">strategies</a></li><li class="navelem"><a class="el" href="_single_axis_priority_list_8hpp.xhtml">SingleAxisPriorityList.hpp</a></li> + <li class="footer">Generated on Fri Feb 24 2023 10:24:25 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |