diff options
| author | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
|---|---|---|
| committer | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
| commit | ae050524109f1ce827962665436ef7430f2ac479 (patch) | |
| tree | a087fe0c77570971dd7979f2757426c24e91afc7 /23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml | |
| parent | 8d2ca734165a068478df7cffa46185680b05cd20 (diff) | |
| download | armnn-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_1_1_pool.xhtml')
| -rw-r--r-- | 23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml | 78 |
1 files changed, 51 insertions, 27 deletions
diff --git a/23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml b/23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml index 2048c7a8b5..b3944e51e4 100644 --- a/23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml +++ b/23.02/classarmnn_1_1_ref_memory_manager_1_1_pool.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::Pool 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&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&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_1_1_pool.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -140,7 +143,10 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00063">63</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="l00064"></a><span class="lineno"> 64</span>  : m_Size(numBytes),</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  m_Pointer(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {}</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  : m_Size(numBytes),</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  m_Pointer(<span class="keyword">nullptr</span>)</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {}</div> +</div><!-- fragment --> </div> </div> <a id="ad680831415106b724bd752599cfc42c3"></a> @@ -159,10 +165,15 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00068">68</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="_ref_memory_manager_8cpp_source.xhtml#l00094">RefMemoryManager::Pool::Release()</a>.</p> -<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (m_Pointer)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div><div class="ttc" id="classarmnn_1_1_ref_memory_manager_1_1_pool_xhtml_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#a94c93747c8daa99d65c2a04c6be0748c">armnn::RefMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_ref_memory_manager_8cpp_source.xhtml#l00094">RefMemoryManager.cpp:94</a></div></div> +<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> {</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (m_Pointer)</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div> </div><!-- fragment --> +<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00055">RefMemoryManager::Release()</a>.</p> + </div> </div> <h2 class="groupheader">Member Function Documentation</h2> @@ -182,10 +193,13 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00088">88</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#l00015">ARMNN_ASSERT_MSG</a>.</p> -<div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Acquire() called when memory already acquired"</span>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }</div><div class="ttc" id="_assert_8hpp_xhtml_a91c4dfde57907d7698c7531785690a7f"><div class="ttname"><a href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a></div><div class="ttdeci">#define ARMNN_ASSERT_MSG(COND, MSG)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00015">Assert.hpp:15</a></div></div> +<div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Acquire() called when memory already acquired"</span>);</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }</div> </div><!-- fragment --> +<p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00015">ARMNN_ASSERT_MSG</a>.</p> + </div> </div> <a id="a6a5db07a5f1fad654e844c52bf702384"></a> @@ -204,12 +218,15 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00076">76</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="l00077"></a><span class="lineno"> 77</span> {</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::GetPointer() called when memory not acquired"</span>);</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> m_Pointer;</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div> +</div><!-- fragment --> <p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00015">ARMNN_ASSERT_MSG</a>.</p> <p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00042">RefMemoryManager::GetPointer()</a>.</p> -<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::GetPointer() called when memory not acquired"</span>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> m_Pointer;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div><div class="ttc" id="_assert_8hpp_xhtml_a91c4dfde57907d7698c7531785690a7f"><div class="ttname"><a href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a></div><div class="ttdeci">#define ARMNN_ASSERT_MSG(COND, MSG)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00015">Assert.hpp:15</a></div></div> -</div><!-- fragment --> + </div> </div> <a id="a94c93747c8daa99d65c2a04c6be0748c"></a> @@ -228,12 +245,14 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00094">94</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="l00095"></a><span class="lineno"> 95</span> {</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Release() called when memory not acquired"</span>);</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ::operator <span class="keyword">delete</span>(m_Pointer);</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  m_Pointer = <span class="keyword">nullptr</span>;</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div> +</div><!-- fragment --> <p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00015">ARMNN_ASSERT_MSG</a>.</p> -<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00068">RefMemoryManager::Pool::~Pool()</a>.</p> -<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Release() called when memory not acquired"</span>);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  ::operator <span class="keyword">delete</span>(m_Pointer);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  m_Pointer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div><div class="ttc" id="_assert_8hpp_xhtml_a91c4dfde57907d7698c7531785690a7f"><div class="ttname"><a href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a></div><div class="ttdeci">#define ARMNN_ASSERT_MSG(COND, MSG)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00015">Assert.hpp:15</a></div></div> -</div><!-- fragment --> </div> </div> <a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a> @@ -253,12 +272,15 @@ Public Member Functions</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00082">82</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="l00083"></a><span class="lineno"> 83</span> {</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Reserve() cannot be called after memory acquired"</span>);</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  m_Size = std::max(m_Size, numBytes);</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div> +</div><!-- fragment --> <p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00015">ARMNN_ASSERT_MSG</a>.</p> <p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00020">RefMemoryManager::Manage()</a>.</p> -<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a>(!m_Pointer, <span class="stringliteral">"RefMemoryManager::Pool::Reserve() cannot be called after memory acquired"</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  m_Size = std::max(m_Size, numBytes);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div><div class="ttc" id="_assert_8hpp_xhtml_a91c4dfde57907d7698c7531785690a7f"><div class="ttname"><a href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a></div><div class="ttdeci">#define ARMNN_ASSERT_MSG(COND, MSG)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00015">Assert.hpp:15</a></div></div> -</div><!-- fragment --> + </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> @@ -267,13 +289,15 @@ Public Member Functions</h2></td></tr> </ul> </div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="aclassarmnn_1_1_ref_memory_manager_1_1_pool_xhtml_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#a94c93747c8daa99d65c2a04c6be0748c">armnn::RefMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_ref_memory_manager_8cpp_source.xhtml#l00094">RefMemoryManager.cpp:94</a></div></div> +<div class="ttc" id="a_assert_8hpp_xhtml_a91c4dfde57907d7698c7531785690a7f"><div class="ttname"><a href="_assert_8hpp.xhtml#a91c4dfde57907d7698c7531785690a7f">ARMNN_ASSERT_MSG</a></div><div class="ttdeci">#define ARMNN_ASSERT_MSG(COND, MSG)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00015">Assert.hpp:15</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="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml">Pool</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> |