blob: ae9f5c4cf0466eaad9cddb201c0177df61f6ef66 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- 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: ConstantMemoryStrategy Class Reference</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('classarmnn_1_1_constant_memory_strategy.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="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_constant_memory_strategy-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">ConstantMemoryStrategy Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_constant_memory_strategy_8hpp_source.html">ConstantMemoryStrategy.hpp</a>&gt;</code></p>
104<div class="dynheader">
105Inheritance diagram for ConstantMemoryStrategy:</div>
106<div class="dyncontent">
107<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_constant_memory_strategy__inherit__graph.svg" width="210" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
108</div>
109<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
110<div class="dynheader">
111Collaboration diagram for ConstantMemoryStrategy:</div>
112<div class="dyncontent">
113<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_constant_memory_strategy__coll__graph.svg" width="210" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
114</div>
115<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
116<table class="memberdecls">
117<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
118Public Member Functions</h2></td></tr>
119<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.html#a63eced178760b5076454c97510075aec">ConstantMemoryStrategy</a> ()</td></tr>
120<tr class="separator:a63eced178760b5076454c97510075aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<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.html#a84ae72d221e80b93c2246b44a50fa361">GetName</a> () const override</td></tr>
122<tr class="separator:a84ae72d221e80b93c2246b44a50fa361"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:acd35ef4810ce3b938f5454bdee0cb826"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.html#acd35ef4810ce3b938f5454bdee0cb826">GetMemBlockStrategyType</a> () const override</td></tr>
124<tr class="separator:acd35ef4810ce3b938f5454bdee0cb826"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:ada820fb9d89d2fb75bacaffe511791b7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_bin.html">MemBin</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_constant_memory_strategy.html#ada820fb9d89d2fb75bacaffe511791b7">Optimize</a> (std::vector&lt; <a class="el" href="structarmnn_1_1_mem_block.html">MemBlock</a> &gt; &amp;memBlocks) override</td></tr>
126<tr class="separator:ada820fb9d89d2fb75bacaffe511791b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<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.html">IMemoryOptimizerStrategy</a></td></tr>
128<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.html#a9b47d46d6792d6cbcd98ff4f26ac8489">~IMemoryOptimizerStrategy</a> ()</td></tr>
129<tr class="separator:a9b47d46d6792d6cbcd98ff4f26ac8489 inherit pub_methods_classarmnn_1_1_i_memory_optimizer_strategy"><td class="memSeparator" colspan="2">&#160;</td></tr>
130</table>
131<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
132<div class="textblock">
133<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8hpp_source.html#l00013">13</a> of file <a class="el" href="_constant_memory_strategy_8hpp_source.html">ConstantMemoryStrategy.hpp</a>.</p>
134</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
135<a id="a63eced178760b5076454c97510075aec"></a>
136<h2 class="memtitle"><span class="permalink"><a href="#a63eced178760b5076454c97510075aec">&#9670;&nbsp;</a></span>ConstantMemoryStrategy()</h2>
137
138<div class="memitem">
139<div class="memproto">
140<table class="mlabels">
141 <tr>
142 <td class="mlabels-left">
143 <table class="memname">
144 <tr>
145 <td class="memname"><a class="el" href="classarmnn_1_1_constant_memory_strategy.html">ConstantMemoryStrategy</a> </td>
146 <td>(</td>
147 <td class="paramname"></td><td>)</td>
148 <td></td>
149 </tr>
150 </table>
151 </td>
152 <td class="mlabels-right">
153<span class="mlabels"><span class="mlabel">inline</span></span> </td>
154 </tr>
155</table>
156</div><div class="memdoc">
157
158<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8hpp_source.html#l00016">16</a> of file <a class="el" href="_constant_memory_strategy_8hpp_source.html">ConstantMemoryStrategy.hpp</a>.</p>
159<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>
160<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; , m_MemBlockStrategyType(<a class="code" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">MemBlockStrategyType::SingleAxisPacking</a>) {}</div>
161</div><!-- fragment -->
162<p class="reference">References <a class="el" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6a568437eb3752bdf14546b5c221ba5be7">armnn::SingleAxisPacking</a>.</p>
163
164</div>
165</div>
166<h2 class="groupheader">Member Function Documentation</h2>
167<a id="acd35ef4810ce3b938f5454bdee0cb826"></a>
168<h2 class="memtitle"><span class="permalink"><a href="#acd35ef4810ce3b938f5454bdee0cb826">&#9670;&nbsp;</a></span>GetMemBlockStrategyType()</h2>
169
170<div class="memitem">
171<div class="memproto">
172<table class="mlabels">
173 <tr>
174 <td class="mlabels-left">
175 <table class="memname">
176 <tr>
177 <td class="memname"><a class="el" href="namespacearmnn.html#a7100de49939c3e393101f78d425a98c6">MemBlockStrategyType</a> GetMemBlockStrategyType </td>
178 <td>(</td>
179 <td class="paramname"></td><td>)</td>
180 <td> const</td>
181 </tr>
182 </table>
183 </td>
184 <td class="mlabels-right">
185<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
186 </tr>
187</table>
188</div><div class="memdoc">
189
190<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.html#a33c9902a46246bcf4d44855b4d866dcb">IMemoryOptimizerStrategy</a>.</p>
191
192<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.html#l00016">16</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.html">ConstantMemoryStrategy.cpp</a>.</p>
193<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
194<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">return</span> m_MemBlockStrategyType;</div>
195<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;}</div>
196</div><!-- fragment -->
197</div>
198</div>
199<a id="a84ae72d221e80b93c2246b44a50fa361"></a>
200<h2 class="memtitle"><span class="permalink"><a href="#a84ae72d221e80b93c2246b44a50fa361">&#9670;&nbsp;</a></span>GetName()</h2>
201
202<div class="memitem">
203<div class="memproto">
204<table class="mlabels">
205 <tr>
206 <td class="mlabels-left">
207 <table class="memname">
208 <tr>
209 <td class="memname">std::string GetName </td>
210 <td>(</td>
211 <td class="paramname"></td><td>)</td>
212 <td> const</td>
213 </tr>
214 </table>
215 </td>
216 <td class="mlabels-right">
217<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
218 </tr>
219</table>
220</div><div class="memdoc">
221
222<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.html#a46f9918b14061163f435d80860b02b56">IMemoryOptimizerStrategy</a>.</p>
223
224<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.html#l00011">11</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.html">ConstantMemoryStrategy.cpp</a>.</p>
225<div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div>
226<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keywordflow">return</span> m_Name;</div>
227<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;}</div>
228</div><!-- fragment -->
229</div>
230</div>
231<a id="ada820fb9d89d2fb75bacaffe511791b7"></a>
232<h2 class="memtitle"><span class="permalink"><a href="#ada820fb9d89d2fb75bacaffe511791b7">&#9670;&nbsp;</a></span>Optimize()</h2>
233
234<div class="memitem">
235<div class="memproto">
236<table class="mlabels">
237 <tr>
238 <td class="mlabels-left">
239 <table class="memname">
240 <tr>
241 <td class="memname">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_bin.html">MemBin</a> &gt; Optimize </td>
242 <td>(</td>
243 <td class="paramtype">std::vector&lt; <a class="el" href="structarmnn_1_1_mem_block.html">MemBlock</a> &gt; &amp;&#160;</td>
244 <td class="paramname"><em>memBlocks</em></td><td>)</td>
245 <td></td>
246 </tr>
247 </table>
248 </td>
249 <td class="mlabels-right">
250<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
251 </tr>
252</table>
253</div><div class="memdoc">
254
255<p>Implements <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.html#a1a9447457df9be8f8186fe73bba4cb72">IMemoryOptimizerStrategy</a>.</p>
256
257<p class="definition">Definition at line <a class="el" href="_constant_memory_strategy_8cpp_source.html#l00025">25</a> of file <a class="el" href="_constant_memory_strategy_8cpp_source.html">ConstantMemoryStrategy.cpp</a>.</p>
258<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
259<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; std::vector&lt;MemBin&gt; memBins;</div>
260<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; memBins.reserve(memBlocks.size());</div>
261<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
262<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>
263<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
264<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; MemBin memBin;</div>
265<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; memBin.m_MemSize = memBlock.m_MemSize;</div>
266<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; memBin.m_MemBlocks.reserve(1);</div>
267<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; memBlock.m_Offset = 0;</div>
268<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; memBin.m_MemBlocks.push_back(memBlock);</div>
269<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; memBins.push_back(memBin);</div>
270<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div>
271<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
272<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> memBins;</div>
273<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div>
274</div><!-- fragment -->
275<p class="reference">References <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.html#l00034">MemBin::m_MemBlocks</a>, and <a class="el" href="_i_memory_optimizer_strategy_8hpp_source.html#l00035">MemBin::m_MemSize</a>.</p>
276
277</div>
278</div>
279<hr/>The documentation for this class was generated from the following files:<ul>
280<li>src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/<a class="el" href="_constant_memory_strategy_8hpp_source.html">ConstantMemoryStrategy.hpp</a></li>
281<li>src/backends/backendsCommon/memoryOptimizerStrategyLibrary/strategies/<a class="el" href="_constant_memory_strategy_8cpp_source.html">ConstantMemoryStrategy.cpp</a></li>
282</ul>
283</div><!-- contents -->
284</div><!-- doc-content -->
285<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>
286<!-- start footer part -->
287<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
288 <ul>
289 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_constant_memory_strategy.html">ConstantMemoryStrategy</a></li>
290 <li class="footer">Generated on Thu May 16 2024 09:31:55 for Arm NN by
291 <a href="http://www.doxygen.org/index.html">
292 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
293 </ul>
294</div>
295</body>
296</html>