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: Tensor 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_tensor.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">Tensor Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic implementation of the tensor interface.
125 <a href="classarm__compute_1_1_tensor.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_tensor_8h_source.xhtml">Tensor.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for Tensor:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_tensor__coll__graph.svg" width="78" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:a09dacbd79d16b74ba8698e27ae3dc42b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#a09dacbd79d16b74ba8698e27ae3dc42b">Tensor</a> ()</td></tr>
138 <tr class="memdesc:a09dacbd79d16b74ba8698e27ae3dc42b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a09dacbd79d16b74ba8698e27ae3dc42b">More...</a><br /></td></tr>
139 <tr class="separator:a09dacbd79d16b74ba8698e27ae3dc42b"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:ae55ef806b29ad70cd952e2c1508715ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#ae55ef806b29ad70cd952e2c1508715ae">~Tensor</a> ()=default</td></tr>
141 <tr class="memdesc:ae55ef806b29ad70cd952e2c1508715ae"><td class="mdescLeft"> </td><td class="mdescRight">Destructor: free the tensor's memory. <a href="#ae55ef806b29ad70cd952e2c1508715ae">More...</a><br /></td></tr>
142 <tr class="separator:ae55ef806b29ad70cd952e2c1508715ae"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a05a9201bf0316d34ffc32a013ecc2e91"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#a05a9201bf0316d34ffc32a013ecc2e91">Tensor</a> (<a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> &&)=default</td></tr>
144 <tr class="memdesc:a05a9201bf0316d34ffc32a013ecc2e91"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be move constructed. <a href="#a05a9201bf0316d34ffc32a013ecc2e91">More...</a><br /></td></tr>
145 <tr class="separator:a05a9201bf0316d34ffc32a013ecc2e91"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:a008f5e2a1c019e9b401753210a99ddfe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#a008f5e2a1c019e9b401753210a99ddfe">operator=</a> (<a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> &&)=default</td></tr>
147 <tr class="memdesc:a008f5e2a1c019e9b401753210a99ddfe"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#a008f5e2a1c019e9b401753210a99ddfe">More...</a><br /></td></tr>
148 <tr class="separator:a008f5e2a1c019e9b401753210a99ddfe"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:a531ec877bfc923dea3ab6f1be5e6e1ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_tensor_allocator.xhtml">TensorAllocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#a531ec877bfc923dea3ab6f1be5e6e1ac">allocator</a> ()</td></tr>
150 <tr class="memdesc:a531ec877bfc923dea3ab6f1be5e6e1ac"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the tensor's allocator. <a href="#a531ec877bfc923dea3ab6f1be5e6e1ac">More...</a><br /></td></tr>
151 <tr class="separator:a531ec877bfc923dea3ab6f1be5e6e1ac"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a97de03c31e0ca04be6960e2e3ffdca95"><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_tensor.xhtml#a97de03c31e0ca04be6960e2e3ffdca95">info</a> () const override</td></tr>
153 <tr class="memdesc:a97de03c31e0ca04be6960e2e3ffdca95"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata. <a href="#a97de03c31e0ca04be6960e2e3ffdca95">More...</a><br /></td></tr>
154 <tr class="separator:a97de03c31e0ca04be6960e2e3ffdca95"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:aa5b3539cef9e42dee1882e909ba34e4f"><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_tensor.xhtml#aa5b3539cef9e42dee1882e909ba34e4f">info</a> () override</td></tr>
156 <tr class="memdesc:aa5b3539cef9e42dee1882e909ba34e4f"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata. <a href="#aa5b3539cef9e42dee1882e909ba34e4f">More...</a><br /></td></tr>
157 <tr class="separator:aa5b3539cef9e42dee1882e909ba34e4f"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:ace7b855e3c647d29cc37a1ce147901dc"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_tensor.xhtml#ace7b855e3c647d29cc37a1ce147901dc">buffer</a> () const override</td></tr>
159 <tr class="memdesc:ace7b855e3c647d29cc37a1ce147901dc"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to return a pointer to CPU memory. <a href="#ace7b855e3c647d29cc37a1ce147901dc">More...</a><br /></td></tr>
160 <tr class="separator:ace7b855e3c647d29cc37a1ce147901dc"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_tensor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_tensor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a></td></tr>
162 <tr class="memitem:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4aa2df36743089ac6814d83e7d4b7ffc">~ITensor</a> ()=default</td></tr>
163 <tr class="memdesc:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a4aa2df36743089ac6814d83e7d4b7ffc">More...</a><br /></td></tr>
164 <tr class="separator:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2"> </td></tr>
165 <tr class="memitem:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a48c7a05cc63f541d732250e39339cee2">ptr_to_element</a> (const <a class="el" href="classarm__compute_1_1_coordinates.xhtml">Coordinates</a> &id) const </td></tr>
166 <tr class="memdesc:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the element at the passed coordinates. <a href="#a48c7a05cc63f541d732250e39339cee2">More...</a><br /></td></tr>
167 <tr class="separator:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2"> </td></tr>
168 <tr class="memitem:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4a774ad8d5f4837f3d7de1876d367c5b">copy_from</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &src)</td></tr>
169 <tr class="memdesc:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft"> </td><td class="mdescRight">Copy the content of another tensor. <a href="#a4a774ad8d5f4837f3d7de1876d367c5b">More...</a><br /></td></tr>
170 <tr class="separator:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2"> </td></tr>
171 <tr class="memitem:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0b092c86d6e0fb8a114281565953a02a">print</a> (std::ostream &s, <a class="el" href="structarm__compute_1_1_i_o_format_info.xhtml">IOFormatInfo</a> io_fmt=<a class="el" href="structarm__compute_1_1_i_o_format_info.xhtml">IOFormatInfo</a>()) const </td></tr>
172 <tr class="memdesc:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft"> </td><td class="mdescRight">Print a tensor to a given stream using user defined formatting information. <a href="#a0b092c86d6e0fb8a114281565953a02a">More...</a><br /></td></tr>
173 <tr class="separator:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2"> </td></tr>
175 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
176 <div class="textblock"><p>Basic implementation of the tensor interface. </p>
178 <p>Definition at line <a class="el" href="_tensor_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_tensor_8h_source.xhtml">Tensor.h</a>.</p>
179 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
180 <a class="anchor" id="a09dacbd79d16b74ba8698e27ae3dc42b"></a>
181 <div class="memitem">
182 <div class="memproto">
183 <table class="memname">
185 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> </td>
187 <td class="paramname"></td><td>)</td>
191 </div><div class="memdoc">
197 <a class="anchor" id="ae55ef806b29ad70cd952e2c1508715ae"></a>
198 <div class="memitem">
199 <div class="memproto">
200 <table class="mlabels">
202 <td class="mlabels-left">
203 <table class="memname">
205 <td class="memname">~<a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> </td>
207 <td class="paramname"></td><td>)</td>
212 <td class="mlabels-right">
213 <span class="mlabels"><span class="mlabel">default</span></span> </td>
216 </div><div class="memdoc">
218 <p>Destructor: free the tensor's memory. </p>
222 <a class="anchor" id="a05a9201bf0316d34ffc32a013ecc2e91"></a>
223 <div class="memitem">
224 <div class="memproto">
225 <table class="mlabels">
227 <td class="mlabels-left">
228 <table class="memname">
230 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> </td>
232 <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</a> && </td>
233 <td class="paramname"></td><td>)</td>
238 <td class="mlabels-right">
239 <span class="mlabels"><span class="mlabel">default</span></span> </td>
242 </div><div class="memdoc">
244 <p>Allow instances of this class to be move constructed. </p>
248 <h2 class="groupheader">Member Function Documentation</h2>
249 <a class="anchor" id="a531ec877bfc923dea3ab6f1be5e6e1ac"></a>
250 <div class="memitem">
251 <div class="memproto">
252 <table class="memname">
254 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_allocator.xhtml">TensorAllocator</a>* allocator </td>
256 <td class="paramname"></td><td>)</td>
260 </div><div class="memdoc">
262 <p>Return a pointer to the tensor's allocator. </p>
263 <dl class="section return"><dt>Returns</dt><dd>A pointer to the tensor's allocator </dd></dl>
265 <p>Referenced by <a class="el" href="neon__copy__objects_8cpp_source.xhtml#l00035">main_neon_copy_objects()</a>.</p>
269 <a class="anchor" id="ace7b855e3c647d29cc37a1ce147901dc"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
274 <td class="mlabels-left">
275 <table class="memname">
277 <td class="memname">uint8_t* buffer </td>
279 <td class="paramname"></td><td>)</td>
284 <td class="mlabels-right">
285 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
288 </div><div class="memdoc">
290 <p>Interface to be implemented by the child class to return a pointer to CPU memory. </p>
291 <dl class="section return"><dt>Returns</dt><dd>A CPU pointer to the beginning of the image's allocation. </dd></dl>
293 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ITensor</a>.</p>
297 <a class="anchor" id="a97de03c31e0ca04be6960e2e3ffdca95"></a>
298 <div class="memitem">
299 <div class="memproto">
300 <table class="mlabels">
302 <td class="mlabels-left">
303 <table class="memname">
305 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>* info </td>
307 <td class="paramname"></td><td>)</td>
312 <td class="mlabels-right">
313 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
316 </div><div class="memdoc">
318 <p>Interface to be implemented by the child class to return the tensor's metadata. </p>
319 <dl class="section return"><dt>Returns</dt><dd>A pointer to the tensor's metadata. </dd></dl>
321 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a8df2a8ec8fcd4258450270f15651b6c9">ITensor</a>.</p>
323 <p>Referenced by <a class="el" href="neon__copy__objects_8cpp_source.xhtml#l00035">main_neon_copy_objects()</a>.</p>
327 <a class="anchor" id="aa5b3539cef9e42dee1882e909ba34e4f"></a>
328 <div class="memitem">
329 <div class="memproto">
330 <table class="mlabels">
332 <td class="mlabels-left">
333 <table class="memname">
335 <td class="memname"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a>* info </td>
337 <td class="paramname"></td><td>)</td>
342 <td class="mlabels-right">
343 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
346 </div><div class="memdoc">
348 <p>Interface to be implemented by the child class to return the tensor's metadata. </p>
349 <dl class="section return"><dt>Returns</dt><dd>A pointer to the tensor's metadata. </dd></dl>
351 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4d0ad991bc87d99aa39ca1ba6df15469">ITensor</a>.</p>
355 <a class="anchor" id="a008f5e2a1c019e9b401753210a99ddfe"></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_tensor.xhtml">Tensor</a>& operator= </td>
365 <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor.xhtml">Tensor</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 moved. </p>
381 <hr/>The documentation for this class was generated from the following file:<ul>
382 <li>arm_compute/runtime/<a class="el" href="_tensor_8h_source.xhtml">Tensor.h</a></li>
384 </div><!-- contents -->
385 </div><!-- doc-content -->
386 <!-- start footer part -->
387 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
389 <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_tensor.xhtml">Tensor</a></li>
390 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
391 <a href="http://www.doxygen.org/index.html">
392 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>