Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / _single_axis_priority_list_8hpp_source.html
blob: bf9a11d603af4d45406ce642341109961c884233 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/SingleAxisPriorityList.hpp Source File</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('_single_axis_priority_list_8hpp_source.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="headertitle">
96<div class="title">SingleAxisPriorityList.hpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_single_axis_priority_list_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
100<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.</span></div>
101<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_types_8hpp.html">armnn/Types.hpp</a>&gt;</span></div>
106<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_i_memory_optimizer_strategy_8hpp.html">armnn/backends/IMemoryOptimizerStrategy.hpp</a>&gt;</span></div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
111<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;list&gt;</span></div>
112<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
114<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div>
115<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"></span> </div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> /// SingleAxisPriorityList sorts the MemBlocks according to some priority,</span></div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> /// then trys to place them into as few bins as possible</span></div>
118<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_single_axis_priority_list.html"> 20</a></span>&#160;<span class="comment"></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_single_axis_priority_list.html">SingleAxisPriorityList</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_memory_optimizer_strategy.html">IMemoryOptimizerStrategy</a></div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; {</div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">public</span>:</div>
121<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_single_axis_priority_list.html#a75d3600935ceb7ba8ca18219f6dff75c"> 23</a></span>&#160; <a class="code" href="classarmnn_1_1_single_axis_priority_list.html#a75d3600935ceb7ba8ca18219f6dff75c">SingleAxisPriorityList</a>()</div>
122<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; : m_Name(<a class="code" href="namespacestd.html">std</a>::string(<span class="stringliteral">&quot;SingleAxisPriorityList&quot;</span>))</div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; , m_MemBlockStrategyType(<a class="code" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a>::<a class="code" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">SingleAxisPacking</a>) {}</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
125<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; std::string <a class="code" href="classarmnn_1_1_single_axis_priority_list.html#a84ae72d221e80b93c2246b44a50fa361">GetName</a>() <span class="keyword">const override</span>;</div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> <a class="code" href="classarmnn_1_1_single_axis_priority_list.html#acd35ef4810ce3b938f5454bdee0cb826">GetMemBlockStrategyType</a>() <span class="keyword">const override</span>;</div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; std::vector&lt;MemBin&gt; <a class="code" href="classarmnn_1_1_single_axis_priority_list.html#ada820fb9d89d2fb75bacaffe511791b7">Optimize</a>(std::vector&lt;MemBlock&gt;&amp; memBlocks) <span class="keyword">override</span>;</div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">private</span>:</div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
133<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// Tracks all memBlocks and their positions in a bin as well as their maximum memSize</span></div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">struct </span>BinTracker;</div>
135<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// PlaceBlocks takes a list of MemBlock* and fits them into n bins.</span></div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// A block can only fit into an existing bin if it&#39;s lifetime does not overlap with the lifetime of the</span></div>
138<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// blocks already in a bin.</span></div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// If no appropriate bin is available a new one is created.</span></div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> PlaceBlocks(<span class="keyword">const</span> std::list&lt;MemBlock*&gt;&amp; priorityList,</div>
141<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; std::vector&lt;BinTracker&gt;&amp; placedBlocks,</div>
142<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxLifetime);</div>
143<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
144<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; std::string m_Name;</div>
145<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> m_MemBlockStrategyType;</div>
146<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; };</div>
147<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
148<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} <span class="comment">// namespace armnn</span></div>
149</div><!-- fragment --></div><!-- contents -->
150</div><!-- doc-content -->
151<div class="ttc" id="a_i_memory_optimizer_strategy_8hpp_html"><div class="ttname"><a href="_i_memory_optimizer_strategy_8hpp.html">IMemoryOptimizerStrategy.hpp</a></div></div>
152<div class="ttc" id="aclassarmnn_1_1_single_axis_priority_list_html_acd35ef4810ce3b938f5454bdee0cb826"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.html#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.html#l00028">SingleAxisPriorityList.cpp:28</a></div></div>
153<div class="ttc" id="aclassarmnn_1_1_single_axis_priority_list_html_a75d3600935ceb7ba8ca18219f6dff75c"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.html#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.html#l00023">SingleAxisPriorityList.hpp:23</a></div></div>
154<div class="ttc" id="aclassarmnn_1_1_single_axis_priority_list_html_ada820fb9d89d2fb75bacaffe511791b7"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.html#ada820fb9d89d2fb75bacaffe511791b7">armnn::SingleAxisPriorityList::Optimize</a></div><div class="ttdeci">std::vector&lt; MemBin &gt; Optimize(std::vector&lt; MemBlock &gt; &amp;memBlocks) override</div><div class="ttdef"><b>Definition:</b> <a href="_single_axis_priority_list_8cpp_source.html#l00214">SingleAxisPriorityList.cpp:214</a></div></div>
155<div class="ttc" id="aclassarmnn_1_1_i_memory_optimizer_strategy_html"><div class="ttname"><a href="classarmnn_1_1_i_memory_optimizer_strategy.html">armnn::IMemoryOptimizerStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_optimizer_strategy_8hpp_source.html#l00045">IMemoryOptimizerStrategy.hpp:45</a></div></div>
156<div class="ttc" id="anamespacearmnn_html_a7100de49939c3e393101f78d425a98c6"><div class="ttname"><a href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">armnn::MemBlockStrategyType</a></div><div class="ttdeci">MemBlockStrategyType</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00253">Types.hpp:253</a></div></div>
157<div class="ttc" id="aclassarmnn_1_1_single_axis_priority_list_html"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.html">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.html#l00020">SingleAxisPriorityList.hpp:20</a></div></div>
158<div class="ttc" id="anamespacearmnn_html_a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7"><div class="ttname"><a href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">armnn::MemBlockStrategyType::SingleAxisPacking</a></div><div class="ttdeci">@ SingleAxisPacking</div></div>
159<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_id_8hpp_source.html#l00149">BackendId.hpp:149</a></div></div>
160<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">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.html#l00006">01_00_quick_start.dox:6</a></div></div>
161<div class="ttc" id="a_types_8hpp_html"><div class="ttname"><a href="_types_8hpp.html">Types.hpp</a></div></div>
162<div class="ttc" id="aclassarmnn_1_1_single_axis_priority_list_html_a84ae72d221e80b93c2246b44a50fa361"><div class="ttname"><a href="classarmnn_1_1_single_axis_priority_list.html#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.html#l00024">SingleAxisPriorityList.cpp:24</a></div></div>
163<!-- start footer part -->
164<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
165 <ul>
166 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.html">backends</a></li><li class="navelem"><a class="el" href="dir_797a213d7d01b98ef12d53b0820ea64e.html">backendsCommon</a></li><li class="navelem"><a class="el" href="dir_222b9efbf86b09050d83daeffd81e1d1.html">memoryOptimizerStrategyLibrary</a></li><li class="navelem"><a class="el" href="dir_d49dbf30bb5f789805533dd1aa43d8d9.html">strategies</a></li><li class="navelem"><a class="el" href="_single_axis_priority_list_8hpp.html">SingleAxisPriorityList.hpp</a></li>
167 <li class="footer">Generated on Thu May 16 2024 09:31:46 for Arm NN by
168 <a href="http://www.doxygen.org/index.html">
169 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
170 </ul>
171</div>
172</body>
173</html>