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">
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>ARM Compute Library: ITensorAllocator 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.04</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
68 <input type="text" id="MSearchField" value="Search" accesskey="S"
69 onfocus="searchBox.OnSearchFieldFocus(true)"
70 onblur="searchBox.OnSearchFieldFocus(false)"
71 onkeyup="searchBox.OnSearchFieldChange(event)"/>
72 </span><span class="right">
73 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_tensor_allocator.xhtml','');});
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104 onmouseover="return searchBox.OnSearchSelectShow()"
105 onmouseout="return searchBox.OnSearchSelectHide()"
106 onkeydown="return searchBox.OnSearchSelectKey(event)">
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0"
112 name="MSearchResults" id="MSearchResults">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">ITensorAllocator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
122 <div class="contents">
124 <p>Interface to allocate tensors.
125 <a href="classarm__compute_1_1_i_tensor_allocator.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_tensor_allocator_8h_source.xhtml">ITensorAllocator.h</a>></code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130 Public Member Functions</h2></td></tr>
131 <tr class="memitem:af97d553d2aa86688c92db8ed9a67cf0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#af97d553d2aa86688c92db8ed9a67cf0e">ITensorAllocator</a> ()</td></tr>
132 <tr class="memdesc:af97d553d2aa86688c92db8ed9a67cf0e"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#af97d553d2aa86688c92db8ed9a67cf0e">More...</a><br /></td></tr>
133 <tr class="separator:af97d553d2aa86688c92db8ed9a67cf0e"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ae82acbc677aa7d77c6a3f5e3547ef917"><td class="memItemLeft" align="right" valign="top"> </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> &)=default</td></tr>
135 <tr class="memdesc:ae82acbc677aa7d77c6a3f5e3547ef917"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be copy constructed. <a href="#ae82acbc677aa7d77c6a3f5e3547ef917">More...</a><br /></td></tr>
136 <tr class="separator:ae82acbc677aa7d77c6a3f5e3547ef917"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:a12e5f2915e2461321b130dcf84f3e268"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> & </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> &)=default</td></tr>
138 <tr class="memdesc:a12e5f2915e2461321b130dcf84f3e268"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be copied. <a href="#a12e5f2915e2461321b130dcf84f3e268">More...</a><br /></td></tr>
139 <tr class="separator:a12e5f2915e2461321b130dcf84f3e268"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a4fe09d257ff33e01defc7074ca22dc98"><td class="memItemLeft" align="right" valign="top"> </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> &&)=default</td></tr>
141 <tr class="memdesc:a4fe09d257ff33e01defc7074ca22dc98"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be move constructed. <a href="#a4fe09d257ff33e01defc7074ca22dc98">More...</a><br /></td></tr>
142 <tr class="separator:a4fe09d257ff33e01defc7074ca22dc98"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a46277b6e964a66a9936e06f9989f0ff6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> & </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> &&)=default</td></tr>
144 <tr class="memdesc:a46277b6e964a66a9936e06f9989f0ff6"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#a46277b6e964a66a9936e06f9989f0ff6">More...</a><br /></td></tr>
145 <tr class="separator:a46277b6e964a66a9936e06f9989f0ff6"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:a8378fc6c887231765b885f8033c7bb99"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a8378fc6c887231765b885f8033c7bb99">~ITensorAllocator</a> ()=default</td></tr>
147 <tr class="memdesc:a8378fc6c887231765b885f8033c7bb99"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a8378fc6c887231765b885f8033c7bb99">More...</a><br /></td></tr>
148 <tr class="separator:a8378fc6c887231765b885f8033c7bb99"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:aa72161e0e3c0f6b2da20f835de6af680"><td class="memItemLeft" align="right" valign="top">void </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> &input)</td></tr>
150 <tr class="memdesc:aa72161e0e3c0f6b2da20f835de6af680"><td class="mdescLeft"> </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>
151 <tr class="separator:aa72161e0e3c0f6b2da20f835de6af680"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a2b12680d0e794d5e81f489df22b38231"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#a2b12680d0e794d5e81f489df22b38231">info</a> ()</td></tr>
153 <tr class="memdesc:a2b12680d0e794d5e81f489df22b38231"><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the tensor's metadata. <a href="#a2b12680d0e794d5e81f489df22b38231">More...</a><br /></td></tr>
154 <tr class="separator:a2b12680d0e794d5e81f489df22b38231"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ad129de4883c35830834987e9b68314e1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#ad129de4883c35830834987e9b68314e1">info</a> () const </td></tr>
156 <tr class="memdesc:ad129de4883c35830834987e9b68314e1"><td class="mdescLeft"> </td><td class="mdescRight">Return a constant reference to the tensor's metadata. <a href="#ad129de4883c35830834987e9b68314e1">More...</a><br /></td></tr>
157 <tr class="separator:ad129de4883c35830834987e9b68314e1"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:aa8a4946cd749d482dd996874d295af85"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml#aa8a4946cd749d482dd996874d295af85">allocate</a> ()=0</td></tr>
159 <tr class="memdesc:aa8a4946cd749d482dd996874d295af85"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to allocate the tensor. <a href="#aa8a4946cd749d482dd996874d295af85">More...</a><br /></td></tr>
160 <tr class="separator:aa8a4946cd749d482dd996874d295af85"><td class="memSeparator" colspan="2"> </td></tr>
162 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
163 <div class="textblock"><p>Interface to allocate tensors. </p>
165 <p>Definition at line <a class="el" href="_i_tensor_allocator_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_tensor_allocator_8h_source.xhtml">ITensorAllocator.h</a>.</p>
166 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
167 <a class="anchor" id="af97d553d2aa86688c92db8ed9a67cf0e"></a>
168 <div class="memitem">
169 <div class="memproto">
170 <table class="memname">
172 <td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> </td>
174 <td class="paramname"></td><td>)</td>
178 </div><div class="memdoc">
180 <p>Default constructor. </p>
184 <a class="anchor" id="ae82acbc677aa7d77c6a3f5e3547ef917"></a>
185 <div class="memitem">
186 <div class="memproto">
187 <table class="mlabels">
189 <td class="mlabels-left">
190 <table class="memname">
192 <td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> </td>
194 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> & </td>
195 <td class="paramname"></td><td>)</td>
200 <td class="mlabels-right">
201 <span class="mlabels"><span class="mlabel">default</span></span> </td>
204 </div><div class="memdoc">
206 <p>Allow instances of this class to be copy constructed. </p>
210 <a class="anchor" id="a4fe09d257ff33e01defc7074ca22dc98"></a>
211 <div class="memitem">
212 <div class="memproto">
213 <table class="mlabels">
215 <td class="mlabels-left">
216 <table class="memname">
218 <td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> </td>
220 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> && </td>
221 <td class="paramname"></td><td>)</td>
226 <td class="mlabels-right">
227 <span class="mlabels"><span class="mlabel">default</span></span> </td>
230 </div><div class="memdoc">
232 <p>Allow instances of this class to be move constructed. </p>
236 <a class="anchor" id="a8378fc6c887231765b885f8033c7bb99"></a>
237 <div class="memitem">
238 <div class="memproto">
239 <table class="mlabels">
241 <td class="mlabels-left">
242 <table class="memname">
244 <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> </td>
246 <td class="paramname"></td><td>)</td>
251 <td class="mlabels-right">
252 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
255 </div><div class="memdoc">
257 <p>Default virtual destructor. </p>
261 <h2 class="groupheader">Member Function Documentation</h2>
262 <a class="anchor" id="aa8a4946cd749d482dd996874d295af85"></a>
263 <div class="memitem">
264 <div class="memproto">
265 <table class="mlabels">
267 <td class="mlabels-left">
268 <table class="memname">
270 <td class="memname">virtual void allocate </td>
272 <td class="paramname"></td><td>)</td>
277 <td class="mlabels-right">
278 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
281 </div><div class="memdoc">
283 <p>Interface to be implemented by the child class to allocate the tensor. </p>
284 <dl class="section note"><dt>Note</dt><dd>The child is expected to use the <a class="el" href="classarm__compute_1_1_tensor_info.xhtml" title="Store the tensor's metadata. ">TensorInfo</a> to get the size of the memory allocation. </dd></dl>
285 <dl class="section warning"><dt>Warning</dt><dd>The tensor must not already be allocated. Otherwise calling the function will fail. </dd></dl>
287 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_tensor_allocator.xhtml#a6e509c2a177b0b29e9e2369535094dee">CLTensorAllocator</a>, and <a class="el" href="classarm__compute_1_1_tensor_allocator.xhtml#a6e509c2a177b0b29e9e2369535094dee">TensorAllocator</a>.</p>
289 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00053">main_cl_convolution()</a>, <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>, and <a class="el" href="neoncl__scale__median__gaussian_8cpp_source.xhtml#l00039">main_neoncl_scale_median_gaussian()</a>.</p>
293 <a class="anchor" id="a2b12680d0e794d5e81f489df22b38231"></a>
294 <div class="memitem">
295 <div class="memproto">
296 <table class="memname">
298 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>& info </td>
300 <td class="paramname"></td><td>)</td>
304 </div><div class="memdoc">
306 <p>Return a reference to the tensor's metadata. </p>
307 <dl class="section return"><dt>Returns</dt><dd>Reference to the tensor's metadata. </dd></dl>
311 <a class="anchor" id="ad129de4883c35830834987e9b68314e1"></a>
312 <div class="memitem">
313 <div class="memproto">
314 <table class="memname">
316 <td class="memname">const <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>& info </td>
318 <td class="paramname"></td><td>)</td>
322 </div><div class="memdoc">
324 <p>Return a constant reference to the tensor's metadata. </p>
325 <dl class="section return"><dt>Returns</dt><dd>Constant reference to the tensor's metadata. </dd></dl>
329 <a class="anchor" id="aa72161e0e3c0f6b2da20f835de6af680"></a>
330 <div class="memitem">
331 <div class="memproto">
332 <table class="memname">
334 <td class="memname">void init </td>
336 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> & </td>
337 <td class="paramname"><em>input</em></td><td>)</td>
341 </div><div class="memdoc">
343 <p>Initialize a tensor based on the passed <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>. </p>
344 <dl class="params"><dt>Parameters</dt><dd>
345 <table class="params">
346 <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td><a class="el" href="classarm__compute_1_1_tensor_info.xhtml" title="Store the tensor's metadata. ">TensorInfo</a> object containing the description of the tensor to initialize. </td></tr>
351 <p>Referenced by <a class="el" href="cl__convolution_8cpp_source.xhtml#l00053">main_cl_convolution()</a>, <a class="el" href="cl__events_8cpp_source.xhtml#l00033">main_cl_events()</a>, and <a class="el" href="neoncl__scale__median__gaussian_8cpp_source.xhtml#l00039">main_neoncl_scale_median_gaussian()</a>.</p>
355 <a class="anchor" id="a12e5f2915e2461321b130dcf84f3e268"></a>
356 <div class="memitem">
357 <div class="memproto">
358 <table class="mlabels">
360 <td class="mlabels-left">
361 <table class="memname">
363 <td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a>& operator= </td>
365 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> & </td>
366 <td class="paramname"></td><td>)</td>
371 <td class="mlabels-right">
372 <span class="mlabels"><span class="mlabel">default</span></span> </td>
375 </div><div class="memdoc">
377 <p>Allow instances of this class to be copied. </p>
381 <a class="anchor" id="a46277b6e964a66a9936e06f9989f0ff6"></a>
382 <div class="memitem">
383 <div class="memproto">
384 <table class="mlabels">
386 <td class="mlabels-left">
387 <table class="memname">
389 <td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a>& operator= </td>
391 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor_allocator.xhtml">ITensorAllocator</a> && </td>
392 <td class="paramname"></td><td>)</td>
397 <td class="mlabels-right">
398 <span class="mlabels"><span class="mlabel">default</span></span> </td>
401 </div><div class="memdoc">
403 <p>Allow instances of this class to be moved. </p>
407 <hr/>The documentation for this class was generated from the following file:<ul>
408 <li>arm_compute/runtime/<a class="el" href="_i_tensor_allocator_8h_source.xhtml">ITensorAllocator.h</a></li>
410 </div><!-- contents -->
411 </div><!-- doc-content -->
412 <!-- start footer part -->
413 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
415 <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_tensor_allocator.xhtml">ITensorAllocator</a></li>
416 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
417 <a href="http://www.doxygen.org/index.html">
418 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>