aboutsummaryrefslogtreecommitdiff
path: root/latest/classsdb_1_1_sample_memory_manager_1_1_pool.html
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2023-08-22 12:00:04 +0100
committerNikhil Raj <nikhil.raj@arm.com>2023-08-22 12:00:04 +0100
commit03c7ff3f6188240baaeaeb405a357a0c58195fec (patch)
treeccfcd5b3481c1a48f2b2c588038e010c09fdfb5f /latest/classsdb_1_1_sample_memory_manager_1_1_pool.html
parent8efb48a6847c5cd166c561127ae6611150963ce3 (diff)
downloadarmnn-03c7ff3f6188240baaeaeb405a357a0c58195fec.tar.gz
IVGCVSW-7702 Update Doxygen Docu for 23.08
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I357a9f7e47614589327c1ac5d95b6224ff77103d
Diffstat (limited to 'latest/classsdb_1_1_sample_memory_manager_1_1_pool.html')
-rw-r--r--latest/classsdb_1_1_sample_memory_manager_1_1_pool.html286
1 files changed, 286 insertions, 0 deletions
diff --git a/latest/classsdb_1_1_sample_memory_manager_1_1_pool.html b/latest/classsdb_1_1_sample_memory_manager_1_1_pool.html
new file mode 100644
index 0000000000..3369422b5c
--- /dev/null
+++ b/latest/classsdb_1_1_sample_memory_manager_1_1_pool.html
@@ -0,0 +1,286 @@
+<!-- HTML header for doxygen 1.8.17-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Arm NN: SampleMemoryManager::Pool Class Reference</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>
+<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" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="customdoxygen.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: 15rem; margin-top: .5rem; margin-left 13px"/>
+ <td id="projectalign" style="padding-left: 0.9em;">
+ <div id="projectname">
+ &#160;<span id="projectnumber">23.08</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- 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(); });
+});
+/* @license-end */</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">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('classsdb_1_1_sample_memory_manager_1_1_pool.html',''); initResizable(); });
+/* @license-end */
+</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="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
+<a href="classsdb_1_1_sample_memory_manager_1_1_pool-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">SampleMemoryManager::Pool Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a>&gt;</code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a3661b84570333e6f38f9b8a1ed73b309"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#a3661b84570333e6f38f9b8a1ed73b309">Pool</a> (unsigned int numBytes)</td></tr>
+<tr class="separator:a3661b84570333e6f38f9b8a1ed73b309"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad680831415106b724bd752599cfc42c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#ad680831415106b724bd752599cfc42c3">~Pool</a> ()</td></tr>
+<tr class="separator:ad680831415106b724bd752599cfc42c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab91dc804181f48b0b445ac1299c36c05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#ab91dc804181f48b0b445ac1299c36c05">Acquire</a> ()</td></tr>
+<tr class="separator:ab91dc804181f48b0b445ac1299c36c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a94c93747c8daa99d65c2a04c6be0748c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a> ()</td></tr>
+<tr class="separator:a94c93747c8daa99d65c2a04c6be0748c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6a5db07a5f1fad654e844c52bf702384"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#a6a5db07a5f1fad654e844c52bf702384">GetPointer</a> ()</td></tr>
+<tr class="separator:a6a5db07a5f1fad654e844c52bf702384"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">Reserve</a> (unsigned int numBytes)</td></tr>
+<tr class="separator:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8hpp_source.html#l00033">33</a> of file <a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a>.</p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a3661b84570333e6f38f9b8a1ed73b309"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3661b84570333e6f38f9b8a1ed73b309">&#9670;&nbsp;</a></span>Pool()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html">Pool</a> </td>
+ <td>(</td>
+ <td class="paramtype">unsigned int&#160;</td>
+ <td class="paramname"><em>numBytes</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00061">61</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; : m_Size(numBytes),</div>
+<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; m_Pointer(<span class="keyword">nullptr</span>)</div>
+<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="ad680831415106b724bd752599cfc42c3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad680831415106b724bd752599cfc42c3">&#9670;&nbsp;</a></span>~Pool()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">~<a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html">Pool</a> </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00066">66</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;{</div>
+<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span> (m_Pointer)</div>
+<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div>
+<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="classsdb_1_1_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div>
+<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div>
+<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;}</div>
+</div><!-- fragment -->
+<p class="reference">References <a class="el" href="_sample_memory_manager_8cpp_source.html#l00053">SampleMemoryManager::Release()</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="ab91dc804181f48b0b445ac1299c36c05"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab91dc804181f48b0b445ac1299c36c05">&#9670;&nbsp;</a></span>Acquire()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Acquire </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00084">84</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;{</div>
+<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div>
+<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a6a5db07a5f1fad654e844c52bf702384"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6a5db07a5f1fad654e844c52bf702384">&#9670;&nbsp;</a></span>GetPointer()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void * GetPointer </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00074">74</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;{</div>
+<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> m_Pointer;</div>
+<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div>
+</div><!-- fragment -->
+<p class="reference">Referenced by <a class="el" href="_sample_memory_manager_8cpp_source.html#l00040">SampleMemoryManager::GetPointer()</a>.</p>
+
+</div>
+</div>
+<a id="a94c93747c8daa99d65c2a04c6be0748c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a94c93747c8daa99d65c2a04c6be0748c">&#9670;&nbsp;</a></span>Release()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Release </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00089">89</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;{</div>
+<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; ::operator <span class="keyword">delete</span>(m_Pointer);</div>
+<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; m_Pointer = <span class="keyword">nullptr</span>;</div>
+<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;}</div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">&#9670;&nbsp;</a></span>Reserve()</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Reserve </td>
+ <td>(</td>
+ <td class="paramtype">unsigned int&#160;</td>
+ <td class="paramname"><em>numBytes</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00079">79</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div>
+<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; m_Size = std::max(m_Size, numBytes);</div>
+<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div>
+</div><!-- fragment -->
+<p class="reference">Referenced by <a class="el" href="_sample_memory_manager_8cpp_source.html#l00019">SampleMemoryManager::Manage()</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>src/dynamic/sample/<a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a></li>
+<li>src/dynamic/sample/<a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<div class="ttc" id="aclasssdb_1_1_sample_memory_manager_1_1_pool_html_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classsdb_1_1_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">sdb::SampleMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_sample_memory_manager_8cpp_source.html#l00089">SampleMemoryManager.cpp:89</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="namespacesdb.html">sdb</a></li><li class="navelem"><a class="el" href="classsdb_1_1_sample_memory_manager.html">SampleMemoryManager</a></li><li class="navelem"><a class="el" href="classsdb_1_1_sample_memory_manager_1_1_pool.html">Pool</a></li>
+ <li class="footer">Generated on Tue Aug 22 2023 11:37:11 for Arm NN by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
+ </ul>
+</div>
+</body>
+</html>