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_memory_manager.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_memory_manager.xhtml')
| -rw-r--r-- | 23.02/classarmnn_1_1_memory_manager.xhtml | 75 |
1 files changed, 55 insertions, 20 deletions
diff --git a/23.02/classarmnn_1_1_memory_manager.xhtml b/23.02/classarmnn_1_1_memory_manager.xhtml index d48330c5df..73990dd682 100644 --- a/23.02/classarmnn_1_1_memory_manager.xhtml +++ b/23.02/classarmnn_1_1_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: MemoryManager 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_memory_manager.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classarmnn_1_1_memory_manager.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,13 +110,13 @@ $(document).ready(function(){initNavTree('classarmnn_1_1_memory_manager.xhtml',' <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a07bc28679b487cc58281a168c3a1c18b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.xhtml#a07bc28679b487cc58281a168c3a1c18b">StoreMemToAllocate</a> (std::vector< <a class="el" href="structarmnn_1_1_buffer_storage.xhtml">BufferStorage</a> > bufferStorageVector, std::shared_ptr< <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> > customAllocator, size_t typeAlignment=0)</td></tr> -<tr class="memdesc:a07bc28679b487cc58281a168c3a1c18b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method to store in m_AllocatorBufferStoragePairVector all information needed. <a href="#a07bc28679b487cc58281a168c3a1c18b">More...</a><br /></td></tr> +<tr class="memdesc:a07bc28679b487cc58281a168c3a1c18b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method to store in m_AllocatorBufferStoragePairVector all information needed. <a href="classarmnn_1_1_memory_manager.xhtml#a07bc28679b487cc58281a168c3a1c18b">More...</a><br /></td></tr> <tr class="separator:a07bc28679b487cc58281a168c3a1c18b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36571ba095c5f84e8dbaee44d9068af8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.xhtml#a36571ba095c5f84e8dbaee44d9068af8">Allocate</a> ()</td></tr> -<tr class="memdesc:a36571ba095c5f84e8dbaee44d9068af8"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.xhtml" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store. ">Tensor</a> so that they are m_Offset bytes separated. <a href="#a36571ba095c5f84e8dbaee44d9068af8">More...</a><br /></td></tr> +<tr class="memdesc:a36571ba095c5f84e8dbaee44d9068af8"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.xhtml" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store.">Tensor</a> so that they are m_Offset bytes separated. <a href="classarmnn_1_1_memory_manager.xhtml#a36571ba095c5f84e8dbaee44d9068af8">More...</a><br /></td></tr> <tr class="separator:a36571ba095c5f84e8dbaee44d9068af8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afaf63777ab6c7323a7b4eceecdfee3df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.xhtml#afaf63777ab6c7323a7b4eceecdfee3df">Deallocate</a> ()</td></tr> -<tr class="memdesc:afaf63777ab6c7323a7b4eceecdfee3df"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate memory. <a href="#afaf63777ab6c7323a7b4eceecdfee3df">More...</a><br /></td></tr> +<tr class="memdesc:afaf63777ab6c7323a7b4eceecdfee3df"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate memory. <a href="classarmnn_1_1_memory_manager.xhtml#afaf63777ab6c7323a7b4eceecdfee3df">More...</a><br /></td></tr> <tr class="separator:afaf63777ab6c7323a7b4eceecdfee3df"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> @@ -135,10 +138,26 @@ Public Member Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.xhtml" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store. ">Tensor</a> so that they are m_Offset bytes separated. </p> +<p>Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.xhtml" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store.">Tensor</a> so that they are m_Offset bytes separated. </p> <p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.xhtml#l00023">23</a> of file <a class="el" href="_memory_manager_8cpp_source.xhtml">MemoryManager.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">auto</span>& allocator = m_AllocatorBufferStoragePair.first;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& bufferStorage : m_AllocatorBufferStoragePair.second)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  bufferStorage.m_Buffer = allocator.m_CustomAllocator->allocate(bufferStorage.m_BufferSize, 0);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> tensorMemory : bufferStorage.m_TensorMemoryVector)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  tensorMemory->m_Data = allocator.m_CustomAllocator->GetMemoryRegionAtOffset(bufferStorage.m_Buffer,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  tensorMemory->m_Offset);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">auto</span>& allocator = m_AllocatorBufferStoragePair.first;</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& bufferStorage : m_AllocatorBufferStoragePair.second)</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  bufferStorage.m_Buffer = allocator.m_CustomAllocator->allocate(bufferStorage.m_BufferSize, 0);</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> tensorMemory : bufferStorage.m_TensorMemoryVector)</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  {</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  tensorMemory->m_Data = allocator.m_CustomAllocator->GetMemoryRegionAtOffset(bufferStorage.m_Buffer,</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  tensorMemory->m_Offset);</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div> +</div><!-- fragment --> </div> </div> <a id="afaf63777ab6c7323a7b4eceecdfee3df"></a> @@ -159,7 +178,17 @@ Public Member Functions</h2></td></tr> <p>Deallocate memory. </p> <p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.xhtml#l00041">41</a> of file <a class="el" href="_memory_manager_8cpp_source.xhtml">MemoryManager.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">auto</span>& allocator = m_AllocatorBufferStoragePair.first;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& bufferStorage : m_AllocatorBufferStoragePair.second)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  allocator.m_CustomAllocator->free(bufferStorage.m_Buffer);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div></div><!-- fragment --> +<div class="fragment"><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">auto</span>& allocator = m_AllocatorBufferStoragePair.first;</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& bufferStorage : m_AllocatorBufferStoragePair.second)</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  allocator.m_CustomAllocator->free(bufferStorage.m_Buffer);</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div> +</div><!-- fragment --> </div> </div> <a id="a07bc28679b487cc58281a168c3a1c18b"></a> @@ -198,17 +227,22 @@ Public Member Functions</h2></td></tr> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">bufferStorageVector</td><td>- Vector of <a class="el" href="structarmnn_1_1_buffer_storage.xhtml">BufferStorage</a>. </td></tr> - <tr><td class="paramdir">[in]</td><td class="paramname">customAllocator</td><td>- Pointer to <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml" title="Custom Allocator interface. ">ICustomAllocator</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">customAllocator</td><td>- Pointer to <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml" title="Custom Allocator interface.">ICustomAllocator</a>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">typeAlignment</td><td>- <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a> parameter. Value of which the size of each value has to be multiple of. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.xhtml#l00013">13</a> of file <a class="el" href="_memory_manager_8cpp_source.xhtml">MemoryManager.cpp</a>.</p> - -<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.xhtml#l00014">armnn::IgnoreUnused()</a>.</p> -<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(typeAlignment);</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  m_AllocatorBufferStoragePairVector.emplace_back(std::make_pair<Allocator, std::vector<BufferStorage>>(</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  Allocator{customAllocator},</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  std::move(bufferStorageVector)));</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &&...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.xhtml#l00014">IgnoreUnused.hpp:14</a></div></div> +<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(typeAlignment);</div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  m_AllocatorBufferStoragePairVector.emplace_back(std::make_pair<Allocator, std::vector<BufferStorage>>(</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  Allocator{customAllocator},</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  std::move(bufferStorageVector)));</div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div> </div><!-- fragment --> +<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.xhtml#l00014">armnn::IgnoreUnused()</a>.</p> + </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> @@ -217,13 +251,14 @@ Public Member Functions</h2></td></tr> </ul> </div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="anamespacearmnn_xhtml_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &&...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.xhtml#l00014">IgnoreUnused.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_memory_manager.xhtml">MemoryManager</a></li> - <li class="footer">Generated on Fri Feb 24 2023 10:24:31 for ArmNN by + <li class="footer">Generated on Wed Mar 22 2023 15:53:06 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> |