arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_g_c_tensor_allocator.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: GCTensorAllocator Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_g_c_tensor_allocator.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">GCTensorAllocator Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Basic implementation of a GLES memory tensor allocator.  
126  <a href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_g_c_tensor_allocator_8h_source.xhtml">GCTensorAllocator.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for GCTensorAllocator:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_g_c_tensor_allocator__coll__graph.svg" width="150" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 </div>
134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137 Public Member Functions</h2></td></tr>
138 <tr class="memitem:aee6bdd0d3cf57c6f2790de67c10dee8f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#aee6bdd0d3cf57c6f2790de67c10dee8f">GCTensorAllocator</a> (<a class="el" href="classarm__compute_1_1_g_c_tensor.xhtml">GCTensor</a> *owner=nullptr)</td></tr>
139 <tr class="memdesc:aee6bdd0d3cf57c6f2790de67c10dee8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aee6bdd0d3cf57c6f2790de67c10dee8f">More...</a><br /></td></tr>
140 <tr class="separator:aee6bdd0d3cf57c6f2790de67c10dee8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:af8dcd8bb5e360d3ed8cc967cf35bac5e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#af8dcd8bb5e360d3ed8cc967cf35bac5e">GCTensorAllocator</a> (const <a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;)=delete</td></tr>
142 <tr class="memdesc:af8dcd8bb5e360d3ed8cc967cf35bac5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#af8dcd8bb5e360d3ed8cc967cf35bac5e">More...</a><br /></td></tr>
143 <tr class="separator:af8dcd8bb5e360d3ed8cc967cf35bac5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a56164dac01e367ad6b509517cd94464a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a56164dac01e367ad6b509517cd94464a">operator=</a> (const <a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:a56164dac01e367ad6b509517cd94464a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copy assigned (As this class contains pointers)  <a href="#a56164dac01e367ad6b509517cd94464a">More...</a><br /></td></tr>
146 <tr class="separator:a56164dac01e367ad6b509517cd94464a"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a59309185a3b64cb28d6031b94cfb711c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a59309185a3b64cb28d6031b94cfb711c">GCTensorAllocator</a> (<a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&amp;)=default</td></tr>
148 <tr class="memdesc:a59309185a3b64cb28d6031b94cfb711c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a59309185a3b64cb28d6031b94cfb711c">More...</a><br /></td></tr>
149 <tr class="separator:a59309185a3b64cb28d6031b94cfb711c"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a70d4c3ea42d68d50cc207d343173696a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a70d4c3ea42d68d50cc207d343173696a">operator=</a> (<a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&amp;)=default</td></tr>
151 <tr class="memdesc:a70d4c3ea42d68d50cc207d343173696a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a70d4c3ea42d68d50cc207d343173696a">More...</a><br /></td></tr>
152 <tr class="separator:a70d4c3ea42d68d50cc207d343173696a"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a97f251707019fc8404f7bbd60fbe0974"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a97f251707019fc8404f7bbd60fbe0974">~GCTensorAllocator</a> ()</td></tr>
154 <tr class="memdesc:a97f251707019fc8404f7bbd60fbe0974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a97f251707019fc8404f7bbd60fbe0974">More...</a><br /></td></tr>
155 <tr class="separator:a97f251707019fc8404f7bbd60fbe0974"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a6a731c70d12750586b67c6cde637b650"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a6a731c70d12750586b67c6cde637b650">data</a> ()</td></tr>
157 <tr class="memdesc:a6a731c70d12750586b67c6cde637b650"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the pointer to the mapped data.  <a href="#a6a731c70d12750586b67c6cde637b650">More...</a><br /></td></tr>
158 <tr class="separator:a6a731c70d12750586b67c6cde637b650"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:acb35468f30f12a68bf3c3f227d85a1df"><td class="memItemLeft" align="right" valign="top">GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#acb35468f30f12a68bf3c3f227d85a1df">get_gl_ssbo_name</a> () const </td></tr>
160 <tr class="memdesc:acb35468f30f12a68bf3c3f227d85a1df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the OpenGL ES buffer object name.  <a href="#acb35468f30f12a68bf3c3f227d85a1df">More...</a><br /></td></tr>
161 <tr class="separator:acb35468f30f12a68bf3c3f227d85a1df"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:a30fa70db7e8a0891a6e57c2036758c18"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a30fa70db7e8a0891a6e57c2036758c18">map</a> (bool blocking)</td></tr>
163 <tr class="memdesc:a30fa70db7e8a0891a6e57c2036758c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer on the given queue.  <a href="#a30fa70db7e8a0891a6e57c2036758c18">More...</a><br /></td></tr>
164 <tr class="separator:a30fa70db7e8a0891a6e57c2036758c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">unmap</a> ()</td></tr>
166 <tr class="memdesc:a1ffeb3b5abb3d61f62b58a391816201c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated buffer on the given queue.  <a href="#a1ffeb3b5abb3d61f62b58a391816201c">More...</a><br /></td></tr>
167 <tr class="separator:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:a6e509c2a177b0b29e9e2369535094dee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a6e509c2a177b0b29e9e2369535094dee">allocate</a> () override</td></tr>
169 <tr class="memdesc:a6e509c2a177b0b29e9e2369535094dee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate size specified by <a class="el" href="classarm__compute_1_1_tensor_info.xhtml" title="Store the tensor&#39;s metadata. ">TensorInfo</a> of GLES memory.  <a href="#a6e509c2a177b0b29e9e2369535094dee">More...</a><br /></td></tr>
170 <tr class="separator:a6e509c2a177b0b29e9e2369535094dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:a1468b0adb6ec3f9d38aa7d60b8a91974"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a1468b0adb6ec3f9d38aa7d60b8a91974">free</a> () override</td></tr>
172 <tr class="memdesc:a1468b0adb6ec3f9d38aa7d60b8a91974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free allocated GLES memory.  <a href="#a1468b0adb6ec3f9d38aa7d60b8a91974">More...</a><br /></td></tr>
173 <tr class="separator:a1468b0adb6ec3f9d38aa7d60b8a91974"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:a341a791505d0893631984f1c01b6568c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml#a341a791505d0893631984f1c01b6568c">set_associated_memory_group</a> (<a class="el" href="namespacearm__compute.xhtml#abb079bea3cd2a65a7018eab99392747e">GCMemoryGroup</a> *associated_memory_group)</td></tr>
175 <tr class="memdesc:a341a791505d0893631984f1c01b6568c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Associates the tensor with a memory group.  <a href="#a341a791505d0893631984f1c01b6568c">More...</a><br /></td></tr>
176 <tr class="separator:a341a791505d0893631984f1c01b6568c"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_tensor_allocator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_tensor_allocator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a></td></tr>
178 <tr class="memitem:af97d553d2aa86688c92db8ed9a67cf0e inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#af97d553d2aa86688c92db8ed9a67cf0e">ITensorAllocator</a> ()</td></tr>
179 <tr class="memdesc:af97d553d2aa86688c92db8ed9a67cf0e inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#af97d553d2aa86688c92db8ed9a67cf0e">More...</a><br /></td></tr>
180 <tr class="separator:af97d553d2aa86688c92db8ed9a67cf0e inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 <tr class="memitem:ae82acbc677aa7d77c6a3f5e3547ef917 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#ae82acbc677aa7d77c6a3f5e3547ef917">ITensorAllocator</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;)=default</td></tr>
182 <tr class="memdesc:ae82acbc677aa7d77c6a3f5e3547ef917 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copy constructed.  <a href="#ae82acbc677aa7d77c6a3f5e3547ef917">More...</a><br /></td></tr>
183 <tr class="separator:ae82acbc677aa7d77c6a3f5e3547ef917 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 <tr class="memitem:a12e5f2915e2461321b130dcf84f3e268 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a12e5f2915e2461321b130dcf84f3e268">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;)=default</td></tr>
185 <tr class="memdesc:a12e5f2915e2461321b130dcf84f3e268 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be copied.  <a href="#a12e5f2915e2461321b130dcf84f3e268">More...</a><br /></td></tr>
186 <tr class="separator:a12e5f2915e2461321b130dcf84f3e268 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
187 <tr class="memitem:a4fe09d257ff33e01defc7074ca22dc98 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a4fe09d257ff33e01defc7074ca22dc98">ITensorAllocator</a> (<a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;&amp;)=default</td></tr>
188 <tr class="memdesc:a4fe09d257ff33e01defc7074ca22dc98 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#a4fe09d257ff33e01defc7074ca22dc98">More...</a><br /></td></tr>
189 <tr class="separator:a4fe09d257ff33e01defc7074ca22dc98 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
190 <tr class="memitem:a46277b6e964a66a9936e06f9989f0ff6 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a46277b6e964a66a9936e06f9989f0ff6">operator=</a> (<a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> &amp;&amp;)=default</td></tr>
191 <tr class="memdesc:a46277b6e964a66a9936e06f9989f0ff6 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a46277b6e964a66a9936e06f9989f0ff6">More...</a><br /></td></tr>
192 <tr class="separator:a46277b6e964a66a9936e06f9989f0ff6 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 <tr class="memitem:a8378fc6c887231765b885f8033c7bb99 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a8378fc6c887231765b885f8033c7bb99">~ITensorAllocator</a> ()=default</td></tr>
194 <tr class="memdesc:a8378fc6c887231765b885f8033c7bb99 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a8378fc6c887231765b885f8033c7bb99">More...</a><br /></td></tr>
195 <tr class="separator:a8378fc6c887231765b885f8033c7bb99 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
196 <tr class="memitem:aa72161e0e3c0f6b2da20f835de6af680 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#aa72161e0e3c0f6b2da20f835de6af680">init</a> (const <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;input)</td></tr>
197 <tr class="memdesc:aa72161e0e3c0f6b2da20f835de6af680 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a tensor based on the passed <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>.  <a href="#aa72161e0e3c0f6b2da20f835de6af680">More...</a><br /></td></tr>
198 <tr class="separator:aa72161e0e3c0f6b2da20f835de6af680 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
199 <tr class="memitem:a2b12680d0e794d5e81f489df22b38231 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a2b12680d0e794d5e81f489df22b38231">info</a> ()</td></tr>
200 <tr class="memdesc:a2b12680d0e794d5e81f489df22b38231 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a reference to the tensor's metadata.  <a href="#a2b12680d0e794d5e81f489df22b38231">More...</a><br /></td></tr>
201 <tr class="separator:a2b12680d0e794d5e81f489df22b38231 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
202 <tr class="memitem:ad129de4883c35830834987e9b68314e1 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#ad129de4883c35830834987e9b68314e1">info</a> () const </td></tr>
203 <tr class="memdesc:ad129de4883c35830834987e9b68314e1 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant reference to the tensor's metadata.  <a href="#ad129de4883c35830834987e9b68314e1">More...</a><br /></td></tr>
204 <tr class="separator:ad129de4883c35830834987e9b68314e1 inherit pub_methods_classarm__compute_1_1_i_tensor_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
205 </table>
206 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
207 <div class="textblock"><p>Basic implementation of a GLES memory tensor allocator. </p>
208
209 <p>Definition at line <a class="el" href="_g_c_tensor_allocator_8h_source.xhtml#l00056">56</a> of file <a class="el" href="_g_c_tensor_allocator_8h_source.xhtml">GCTensorAllocator.h</a>.</p>
210 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
211 <a class="anchor" id="aee6bdd0d3cf57c6f2790de67c10dee8f"></a>
212 <div class="memitem">
213 <div class="memproto">
214       <table class="memname">
215         <tr>
216           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> </td>
217           <td>(</td>
218           <td class="paramtype"><a class="el" href="classarm__compute_1_1_g_c_tensor.xhtml">GCTensor</a> *&#160;</td>
219           <td class="paramname"><em>owner</em> = <code>nullptr</code></td><td>)</td>
220           <td></td>
221         </tr>
222       </table>
223 </div><div class="memdoc">
224
225 <p>Default constructor. </p>
226
227 </div>
228 </div>
229 <a class="anchor" id="af8dcd8bb5e360d3ed8cc967cf35bac5e"></a>
230 <div class="memitem">
231 <div class="memproto">
232 <table class="mlabels">
233   <tr>
234   <td class="mlabels-left">
235       <table class="memname">
236         <tr>
237           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> </td>
238           <td>(</td>
239           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&#160;</td>
240           <td class="paramname"></td><td>)</td>
241           <td></td>
242         </tr>
243       </table>
244   </td>
245   <td class="mlabels-right">
246 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
247   </tr>
248 </table>
249 </div><div class="memdoc">
250
251 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
252
253 </div>
254 </div>
255 <a class="anchor" id="a59309185a3b64cb28d6031b94cfb711c"></a>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="mlabels">
259   <tr>
260   <td class="mlabels-left">
261       <table class="memname">
262         <tr>
263           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> </td>
264           <td>(</td>
265           <td class="paramtype"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&amp;&#160;</td>
266           <td class="paramname"></td><td>)</td>
267           <td></td>
268         </tr>
269       </table>
270   </td>
271   <td class="mlabels-right">
272 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
273   </tr>
274 </table>
275 </div><div class="memdoc">
276
277 <p>Allow instances of this class to be moved. </p>
278
279 </div>
280 </div>
281 <a class="anchor" id="a97f251707019fc8404f7bbd60fbe0974"></a>
282 <div class="memitem">
283 <div class="memproto">
284       <table class="memname">
285         <tr>
286           <td class="memname">~<a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> </td>
287           <td>(</td>
288           <td class="paramname"></td><td>)</td>
289           <td></td>
290         </tr>
291       </table>
292 </div><div class="memdoc">
293
294 <p>Default destructor. </p>
295
296 </div>
297 </div>
298 <h2 class="groupheader">Member Function Documentation</h2>
299 <a class="anchor" id="a6e509c2a177b0b29e9e2369535094dee"></a>
300 <div class="memitem">
301 <div class="memproto">
302 <table class="mlabels">
303   <tr>
304   <td class="mlabels-left">
305       <table class="memname">
306         <tr>
307           <td class="memname">void allocate </td>
308           <td>(</td>
309           <td class="paramname"></td><td>)</td>
310           <td></td>
311         </tr>
312       </table>
313   </td>
314   <td class="mlabels-right">
315 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
316   </tr>
317 </table>
318 </div><div class="memdoc">
319
320 <p>Allocate size specified by <a class="el" href="classarm__compute_1_1_tensor_info.xhtml" title="Store the tensor&#39;s metadata. ">TensorInfo</a> of GLES memory. </p>
321 <dl class="section note"><dt>Note</dt><dd>: The tensor must not already be allocated when calling this function. </dd></dl>
322
323 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#aa8a4946cd749d482dd996874d295af85">ITensorAllocator</a>.</p>
324
325 </div>
326 </div>
327 <a class="anchor" id="a6a731c70d12750586b67c6cde637b650"></a>
328 <div class="memitem">
329 <div class="memproto">
330       <table class="memname">
331         <tr>
332           <td class="memname">uint8_t* data </td>
333           <td>(</td>
334           <td class="paramname"></td><td>)</td>
335           <td></td>
336         </tr>
337       </table>
338 </div><div class="memdoc">
339
340 <p>Interface to be implemented by the child class to return the pointer to the mapped data. </p>
341 <dl class="section return"><dt>Returns</dt><dd>a pointer to the data. </dd></dl>
342
343 </div>
344 </div>
345 <a class="anchor" id="a1468b0adb6ec3f9d38aa7d60b8a91974"></a>
346 <div class="memitem">
347 <div class="memproto">
348 <table class="mlabels">
349   <tr>
350   <td class="mlabels-left">
351       <table class="memname">
352         <tr>
353           <td class="memname">void free </td>
354           <td>(</td>
355           <td class="paramname"></td><td>)</td>
356           <td></td>
357         </tr>
358       </table>
359   </td>
360   <td class="mlabels-right">
361 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
362   </tr>
363 </table>
364 </div><div class="memdoc">
365
366 <p>Free allocated GLES memory. </p>
367 <dl class="section note"><dt>Note</dt><dd>The tensor must have been allocated when calling this function. </dd></dl>
368
369 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a1781eecaabd2bc97d074437d01b2c683">ITensorAllocator</a>.</p>
370
371 </div>
372 </div>
373 <a class="anchor" id="acb35468f30f12a68bf3c3f227d85a1df"></a>
374 <div class="memitem">
375 <div class="memproto">
376       <table class="memname">
377         <tr>
378           <td class="memname">GLuint get_gl_ssbo_name </td>
379           <td>(</td>
380           <td class="paramname"></td><td>)</td>
381           <td> const</td>
382         </tr>
383       </table>
384 </div><div class="memdoc">
385
386 <p>Get the OpenGL ES buffer object name. </p>
387 <dl class="section return"><dt>Returns</dt><dd>The buffer object name </dd></dl>
388
389 </div>
390 </div>
391 <a class="anchor" id="a30fa70db7e8a0891a6e57c2036758c18"></a>
392 <div class="memitem">
393 <div class="memproto">
394       <table class="memname">
395         <tr>
396           <td class="memname">uint8_t* map </td>
397           <td>(</td>
398           <td class="paramtype">bool&#160;</td>
399           <td class="paramname"><em>blocking</em></td><td>)</td>
400           <td></td>
401         </tr>
402       </table>
403 </div><div class="memdoc">
404
405 <p>Enqueue a map operation of the allocated buffer on the given queue. </p>
406 <dl class="params"><dt>Parameters</dt><dd>
407   <table class="params">
408     <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>If true, then the mapping will be ready to use by the time this method returns, else it is the caller's responsibility to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.</td></tr>
409   </table>
410   </dd>
411 </dl>
412 <dl class="section return"><dt>Returns</dt><dd>The mapping address. </dd></dl>
413
414 </div>
415 </div>
416 <a class="anchor" id="a56164dac01e367ad6b509517cd94464a"></a>
417 <div class="memitem">
418 <div class="memproto">
419 <table class="mlabels">
420   <tr>
421   <td class="mlabels-left">
422       <table class="memname">
423         <tr>
424           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a>&amp; operator= </td>
425           <td>(</td>
426           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&#160;</td>
427           <td class="paramname"></td><td>)</td>
428           <td></td>
429         </tr>
430       </table>
431   </td>
432   <td class="mlabels-right">
433 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
434   </tr>
435 </table>
436 </div><div class="memdoc">
437
438 <p>Prevent instances of this class from being copy assigned (As this class contains pointers) </p>
439
440 </div>
441 </div>
442 <a class="anchor" id="a70d4c3ea42d68d50cc207d343173696a"></a>
443 <div class="memitem">
444 <div class="memproto">
445 <table class="mlabels">
446   <tr>
447   <td class="mlabels-left">
448       <table class="memname">
449         <tr>
450           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a>&amp; operator= </td>
451           <td>(</td>
452           <td class="paramtype"><a class="el" href="classarm__compute_1_1_g_c_tensor_allocator.xhtml">GCTensorAllocator</a> &amp;&amp;&#160;</td>
453           <td class="paramname"></td><td>)</td>
454           <td></td>
455         </tr>
456       </table>
457   </td>
458   <td class="mlabels-right">
459 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
460   </tr>
461 </table>
462 </div><div class="memdoc">
463
464 <p>Allow instances of this class to be moved. </p>
465
466 </div>
467 </div>
468 <a class="anchor" id="a341a791505d0893631984f1c01b6568c"></a>
469 <div class="memitem">
470 <div class="memproto">
471       <table class="memname">
472         <tr>
473           <td class="memname">void set_associated_memory_group </td>
474           <td>(</td>
475           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#abb079bea3cd2a65a7018eab99392747e">GCMemoryGroup</a> *&#160;</td>
476           <td class="paramname"><em>associated_memory_group</em></td><td>)</td>
477           <td></td>
478         </tr>
479       </table>
480 </div><div class="memdoc">
481
482 <p>Associates the tensor with a memory group. </p>
483 <dl class="params"><dt>Parameters</dt><dd>
484   <table class="params">
485     <tr><td class="paramdir">[in]</td><td class="paramname">associated_memory_group</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> group to associate the tensor with </td></tr>
486   </table>
487   </dd>
488 </dl>
489
490 </div>
491 </div>
492 <a class="anchor" id="a1ffeb3b5abb3d61f62b58a391816201c"></a>
493 <div class="memitem">
494 <div class="memproto">
495       <table class="memname">
496         <tr>
497           <td class="memname">void unmap </td>
498           <td>(</td>
499           <td class="paramname"></td><td>)</td>
500           <td></td>
501         </tr>
502       </table>
503 </div><div class="memdoc">
504
505 <p>Enqueue an unmap operation of the allocated buffer on the given queue. </p>
506 <dl class="section note"><dt>Note</dt><dd>This method simply enqueue the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before the memory is accessed by the device. </dd></dl>
507
508 </div>
509 </div>
510 <hr/>The documentation for this class was generated from the following file:<ul>
511 <li>arm_compute/runtime/GLES_COMPUTE/<a class="el" href="_g_c_tensor_allocator_8h_source.xhtml">GCTensorAllocator.h</a></li>
512 </ul>
513 </div><!-- contents -->
514 </div><!-- doc-content -->
515 <!-- start footer part -->
516 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
517   <ul>
518     <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_g_c_tensor_allocator.xhtml">GCTensorAllocator</a></li>
519     <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
520     <a href="http://www.doxygen.org/index.html">
521     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
522   </ul>
523 </div>
524 </body>
525 </html>