blob: ffa579ba40f058d4f942aa0efa65163bdb1c6f08 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!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.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: IMemoryGroup 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="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="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('classarm__compute_1_1_i_memory_group.xhtml','');});
/* @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> </div>
<div class="headertitle">
<div class="title">IMemoryGroup Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> group interface.
<a href="classarm__compute_1_1_i_memory_group.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_i_memory_group_8h_source.xhtml">IMemoryGroup.h</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:a9bd7b2a6304e2332de8a1fcfefb0111e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#a9bd7b2a6304e2332de8a1fcfefb0111e">~IMemoryGroup</a> ()=default</td></tr>
<tr class="memdesc:a9bd7b2a6304e2332de8a1fcfefb0111e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor. <a href="#a9bd7b2a6304e2332de8a1fcfefb0111e">More...</a><br /></td></tr>
<tr class="separator:a9bd7b2a6304e2332de8a1fcfefb0111e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accdbc89f54447d25dfc018d38070f4ea"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#accdbc89f54447d25dfc018d38070f4ea">acquire</a> ()=0</td></tr>
<tr class="memdesc:accdbc89f54447d25dfc018d38070f4ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquires backing memory for the whole group. <a href="#accdbc89f54447d25dfc018d38070f4ea">More...</a><br /></td></tr>
<tr class="separator:accdbc89f54447d25dfc018d38070f4ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab0a52fdd148a54108e7bf49287d7c47"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#aab0a52fdd148a54108e7bf49287d7c47">release</a> ()=0</td></tr>
<tr class="memdesc:aab0a52fdd148a54108e7bf49287d7c47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases backing memory of the whole group. <a href="#aab0a52fdd148a54108e7bf49287d7c47">More...</a><br /></td></tr>
<tr class="separator:aab0a52fdd148a54108e7bf49287d7c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4f0ba2c065527f486249f37350a235c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#aa4f0ba2c065527f486249f37350a235c">mappings</a> ()=0</td></tr>
<tr class="memdesc:aa4f0ba2c065527f486249f37350a235c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the memory mapping of the group. <a href="#aa4f0ba2c065527f486249f37350a235c">More...</a><br /></td></tr>
<tr class="separator:aa4f0ba2c065527f486249f37350a235c"><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><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> group interface. </p>
<p class="definition">Definition at line <a class="el" href="_i_memory_group_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_i_memory_group_8h_source.xhtml">IMemoryGroup.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9bd7b2a6304e2332de8a1fcfefb0111e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd7b2a6304e2332de8a1fcfefb0111e">&#9670;&nbsp;</a></span>~IMemoryGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="accdbc89f54447d25dfc018d38070f4ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accdbc89f54447d25dfc018d38070f4ea">&#9670;&nbsp;</a></span>acquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void acquire </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Acquires backing memory for the whole group. </p>
<p>Implemented in <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">MemoryGroupBase&lt; TensorType &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">MemoryGroupBase&lt; CLTensor &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">MemoryGroupBase&lt; GCTensor &gt;</a>, and <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">MemoryGroupBase&lt; Tensor &gt;</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_memory_group_8h_source.xhtml#l00053">MemoryGroupResourceScope::MemoryGroupResourceScope()</a>.</p>
</div>
</div>
<a id="aa4f0ba2c065527f486249f37350a235c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4f0ba2c065527f486249f37350a235c">&#9670;&nbsp;</a></span>mappings()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a>&amp; mappings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the memory mapping of the group. </p>
<p>Implemented in <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">MemoryGroupBase&lt; TensorType &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">MemoryGroupBase&lt; CLTensor &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">MemoryGroupBase&lt; GCTensor &gt;</a>, and <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">MemoryGroupBase&lt; Tensor &gt;</a>.</p>
</div>
</div>
<a id="aab0a52fdd148a54108e7bf49287d7c47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab0a52fdd148a54108e7bf49287d7c47">&#9670;&nbsp;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases backing memory of the whole group. </p>
<p>Implemented in <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">MemoryGroupBase&lt; TensorType &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">MemoryGroupBase&lt; CLTensor &gt;</a>, <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">MemoryGroupBase&lt; GCTensor &gt;</a>, and <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">MemoryGroupBase&lt; Tensor &gt;</a>.</p>
<p class="reference">Referenced by <a class="el" href="_i_memory_group_8h_source.xhtml#l00067">MemoryGroupResourceScope::~MemoryGroupResourceScope()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>arm_compute/runtime/<a class="el" href="_i_memory_group_8h_source.xhtml">IMemoryGroup.h</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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a></li>
<li class="footer">Generated on Mon Sep 2 2019 11:47:35 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>