diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2022-11-23 11:05:29 +0000 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2022-11-23 11:09:30 +0000 |
| commit | cb0630959aeae05bc2ae9f6d80cf5f5983a8fb77 (patch) | |
| tree | 0dbcf7ed5eb76622aba7bb742f39621aa476e3e8 /22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml | |
| parent | 7bfd38a721360183f3392f9ab35db18a0dd7fef8 (diff) | |
| download | armnn-cb0630959aeae05bc2ae9f6d80cf5f5983a8fb77.tar.gz | |
IVGCVSW-7075 Update Doxygen for 22.11 Release
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: Ib5669e8fd3739d1b10f5dd694d020d51799896dc
Diffstat (limited to '22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml')
| -rw-r--r-- | 22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml | 280 |
1 files changed, 280 insertions, 0 deletions
diff --git a/22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml b/22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml new file mode 100644 index 0000000000..4d909a20ef --- /dev/null +++ b/22.11/classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml @@ -0,0 +1,280 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: ClBackend::ClBackendCustomAllocatorWrapper 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> +<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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" 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> +<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: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">22.11</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"> +$(document).ready(function(){initNavTree('classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml','');}); +</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> | +<a href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ClBackend::ClBackendCustomAllocatorWrapper Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for ClBackend::ClBackendCustomAllocatorWrapper:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.png" usemap="#ClBackend::ClBackendCustomAllocatorWrapper_map" alt=""/> + <map id="ClBackend::ClBackendCustomAllocatorWrapper_map" name="ClBackend::ClBackendCustomAllocatorWrapper_map"> +</map> + </div></div> +<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:acd00af9a7ba0a698230b82b675160c6b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#acd00af9a7ba0a698230b82b675160c6b">ClBackendCustomAllocatorWrapper</a> (std::shared_ptr< <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> > alloc)</td></tr> +<tr class="separator:acd00af9a7ba0a698230b82b675160c6b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#aae0c9f2cf99b1724ec4a6d4e292327d2">allocate</a> (size_t size, size_t alignment) override</td></tr> +<tr class="separator:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abbd17af5b3fbeff226e4051433c1b929"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#abbd17af5b3fbeff226e4051433c1b929">free</a> (void *ptr) override</td></tr> +<tr class="separator:abbd17af5b3fbeff226e4051433c1b929"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf2dabeaea489183b26da69ab593165b"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< arm_compute::IMemoryRegion > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#abf2dabeaea489183b26da69ab593165b">make_region</a> (size_t size, size_t alignment) override</td></tr> +<tr class="separator:abf2dabeaea489183b26da69ab593165b"><td class="memSeparator" colspan="2"> </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="_cl_backend_8hpp_source.xhtml#l00113">113</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="acd00af9a7ba0a698230b82b675160c6b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acd00af9a7ba0a698230b82b675160c6b">◆ </a></span>ClBackendCustomAllocatorWrapper()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml">ClBackendCustomAllocatorWrapper</a> </td> + <td>(</td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> > </td> + <td class="paramname"><em>alloc</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00116">116</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  : m_CustomAllocator(alloc)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aae0c9f2cf99b1724ec4a6d4e292327d2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aae0c9f2cf99b1724ec4a6d4e292327d2">◆ </a></span>allocate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void* allocate </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>alignment</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00119">119</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">auto</span> alloc = m_CustomAllocator->allocate(size, alignment);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> MapAllocatedMemory(alloc, size, m_CustomAllocator->GetMemorySourceType());</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="abbd17af5b3fbeff226e4051433c1b929"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abbd17af5b3fbeff226e4051433c1b929">◆ </a></span>free()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void free </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>ptr</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00124">124</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">auto</span> hostMemPtr = m_AllocatedBufferMappings[ptr];</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  clReleaseMemObject(static_cast<cl_mem>(ptr));</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  m_CustomAllocator->free(hostMemPtr);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="abf2dabeaea489183b26da69ab593165b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf2dabeaea489183b26da69ab593165b">◆ </a></span>make_region()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::unique_ptr<arm_compute::IMemoryRegion> make_region </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>alignment</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00130">130</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p> + +<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a966e13d8aabbff3966a5cd28d67b4846">armnn::DmaBuf</a>, <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a7f9067c59dd34aca0ad09a7f283ed1f8">armnn::DmaBufProtected</a>, <a class="el" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::error</a>, and <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a1131a914388fac73e5f07b0ba0aad523">armnn::Malloc</a>.</p> +<div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">auto</span> hostMemPtr = m_CustomAllocator->allocate(size, alignment);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  cl_mem buffer = MapAllocatedMemory(hostMemPtr, size, m_CustomAllocator->GetMemorySourceType());</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">return</span> std::make_unique<ClBackendCustomAllocatorMemoryRegion>(cl::Buffer(buffer),</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  hostMemPtr,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  m_CustomAllocator->GetMemorySourceType());</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/backends/cl/<a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- 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_cl_backend.xhtml">ClBackend</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml">ClBackendCustomAllocatorWrapper</a></li> + <li class="footer">Generated on Wed Nov 23 2022 10:57:39 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |