aboutsummaryrefslogtreecommitdiff
path: root/23.02/classarmnn_1_1_ref_memory_manager.xhtml
diff options
context:
space:
mode:
authorDavid Monahan <david.monahan@arm.com>2023-03-22 16:48:58 +0000
committerDavid Monahan <david.monahan@arm.com>2023-03-22 16:48:58 +0000
commitae050524109f1ce827962665436ef7430f2ac479 (patch)
treea087fe0c77570971dd7979f2757426c24e91afc7 /23.02/classarmnn_1_1_ref_memory_manager.xhtml
parent8d2ca734165a068478df7cffa46185680b05cd20 (diff)
downloadarmnn-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/classarmnn_1_1_ref_memory_manager.xhtml')
-rw-r--r--23.02/classarmnn_1_1_ref_memory_manager.xhtml86
1 files changed, 63 insertions, 23 deletions
diff --git a/23.02/classarmnn_1_1_ref_memory_manager.xhtml b/23.02/classarmnn_1_1_ref_memory_manager.xhtml
index f035c8c9cb..44ae4c3404 100644
--- a/23.02/classarmnn_1_1_ref_memory_manager.xhtml
+++ b/23.02/classarmnn_1_1_ref_memory_manager.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: RefMemoryManager Class Reference</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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
-</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('classarmnn_1_1_ref_memory_manager.xhtml','');});
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('classarmnn_1_1_ref_memory_manager.xhtml',''); initResizable(); });
+/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
@@ -111,8 +114,8 @@ Inheritance diagram for RefMemoryManager:</div>
<img src="classarmnn_1_1_ref_memory_manager.png" usemap="#RefMemoryManager_map" alt=""/>
<map id="RefMemoryManager_map" name="RefMemoryManager_map">
<area href="classarmnn_1_1_i_memory_manager.xhtml" alt="IMemoryManager" shape="rect" coords="0,0,128,24"/>
-</map>
- </div></div>
+ </map>
+</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
@@ -165,7 +168,8 @@ Additional Inherited Members</h2></td></tr>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00014">14</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{}</div></div><!-- fragment -->
+<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{}</div>
+</div><!-- fragment -->
</div>
</div>
<a id="a86fd306e3e39385baae17ddbca6af7e8"></a>
@@ -192,7 +196,8 @@ Additional Inherited Members</h2></td></tr>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00017">17</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-<div class="fragment"><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{}</div></div><!-- fragment -->
+<div class="fragment"><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{}</div>
+</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -222,7 +227,13 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a72e29e3a91bbf0ab80b0b19bc7975a39">IMemoryManager</a>.</p>
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00047">47</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">for</span> (Pool &amp;pool: m_Pools)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; pool.Acquire();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div></div><!-- fragment -->
+<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div>
+<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">for</span> (Pool &amp;pool: m_Pools)</div>
+<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
+<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; pool.Acquire();</div>
+<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
+<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
+</div><!-- fragment -->
</div>
</div>
<a id="aeb4cf58433513e48fdd067cde9a8f7d6"></a>
@@ -242,10 +253,13 @@ Additional Inherited Members</h2></td></tr>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00036">36</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-
-<p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00014">ARMNN_ASSERT</a>.</p>
-<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(pool);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; m_FreePools.push_back(pool);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div><div class="ttc" id="_assert_8hpp_xhtml_a5698be69cbd5dfe6c28fcd9867e8cbed"><div class="ttname"><a href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a></div><div class="ttdeci">#define ARMNN_ASSERT(COND)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00014">Assert.hpp:14</a></div></div>
+<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
+<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(pool);</div>
+<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; m_FreePools.push_back(pool);</div>
+<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div>
</div><!-- fragment -->
+<p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00014">ARMNN_ASSERT</a>.</p>
+
</div>
</div>
<a id="ab236ab01a8959f4b273b388c09548238"></a>
@@ -265,9 +279,12 @@ Additional Inherited Members</h2></td></tr>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00042">42</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-
+<div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div>
+<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> pool-&gt;GetPointer();</div>
+<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
+</div><!-- fragment -->
<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00076">RefMemoryManager::Pool::GetPointer()</a>.</p>
-<div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> pool-&gt;GetPointer();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div></div><!-- fragment -->
+
</div>
</div>
<a id="a58ec3071d0aa2d9a41d63ecd7eb27fa7"></a>
@@ -287,9 +304,23 @@ Additional Inherited Members</h2></td></tr>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00020">20</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-
+<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div>
+<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">if</span> (!m_FreePools.empty())</div>
+<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; {</div>
+<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; Pool* res = m_FreePools.back();</div>
+<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_FreePools.pop_back();</div>
+<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; res-&gt;Reserve(numBytes);</div>
+<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">return</span> res;</div>
+<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div>
+<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">else</span></div>
+<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
+<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; m_Pools.push_front(Pool(numBytes));</div>
+<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> &amp;m_Pools.front();</div>
+<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div>
+<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div>
+</div><!-- fragment -->
<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00082">RefMemoryManager::Pool::Reserve()</a>.</p>
-<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">if</span> (!m_FreePools.empty())</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; Pool* res = m_FreePools.back();</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_FreePools.pop_back();</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; res-&gt;Reserve(numBytes);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">return</span> res;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; }</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; m_Pools.push_front(Pool(numBytes));</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> &amp;m_Pools.front();</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div></div><!-- fragment -->
+
</div>
</div>
<a id="a1a5dddc8911f6189f9ca01394c59faaf"></a>
@@ -318,7 +349,15 @@ Additional Inherited Members</h2></td></tr>
<p>Implements <a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a4dc7ecb0d192d6cccc9287daaf0eca0f">IMemoryManager</a>.</p>
<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00055">55</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
-<div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">for</span> (Pool &amp;pool: m_Pools)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; pool.Release();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div></div><!-- fragment -->
+<div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
+<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">for</span> (Pool &amp;pool: m_Pools)</div>
+<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div>
+<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; pool.Release();</div>
+<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
+<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
+</div><!-- fragment -->
+<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00068">RefMemoryManager::Pool::~Pool()</a>.</p>
+
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
@@ -327,13 +366,14 @@ Additional Inherited Members</h2></td></tr>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
+<div class="ttc" id="a_assert_8hpp_xhtml_a5698be69cbd5dfe6c28fcd9867e8cbed"><div class="ttname"><a href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a></div><div class="ttdeci">#define ARMNN_ASSERT(COND)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00014">Assert.hpp:14</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager.xhtml">RefMemoryManager</a></li>
- <li class="footer">Generated on Fri Feb 24 2023 10:24:32 for ArmNN by
+ <li class="footer">Generated on Wed Mar 22 2023 15:53:08 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>