arm_compute v18.02
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_i_g_c_tensor.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: IGCTensor 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.02</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_i_g_c_tensor.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">IGCTensor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for GLES Compute tensor.  
126  <a href="classarm__compute_1_1_i_g_c_tensor.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_i_g_c_tensor_8h_source.xhtml">IGCTensor.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for IGCTensor:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_g_c_tensor__coll__graph.svg" width="96" 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:a78e2cb61c2ed12459fea5a97728d74d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a78e2cb61c2ed12459fea5a97728d74d2">IGCTensor</a> ()</td></tr>
139 <tr class="memdesc:a78e2cb61c2ed12459fea5a97728d74d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a78e2cb61c2ed12459fea5a97728d74d2">More...</a><br /></td></tr>
140 <tr class="separator:a78e2cb61c2ed12459fea5a97728d74d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a15242f453f1928c3dbc2a30ec08480e6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a15242f453f1928c3dbc2a30ec08480e6">IGCTensor</a> (const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;)=delete</td></tr>
142 <tr class="memdesc:a15242f453f1928c3dbc2a30ec08480e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a15242f453f1928c3dbc2a30ec08480e6">More...</a><br /></td></tr>
143 <tr class="separator:a15242f453f1928c3dbc2a30ec08480e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a53ba7801ed7dbf945a0413addd6dc990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a53ba7801ed7dbf945a0413addd6dc990">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:a53ba7801ed7dbf945a0413addd6dc990"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copy assigned (As this class contains pointers).  <a href="#a53ba7801ed7dbf945a0413addd6dc990">More...</a><br /></td></tr>
146 <tr class="separator:a53ba7801ed7dbf945a0413addd6dc990"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:adcca5090c26cd20e37d2878510b32bad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#adcca5090c26cd20e37d2878510b32bad">IGCTensor</a> (<a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&amp;)=default</td></tr>
148 <tr class="memdesc:adcca5090c26cd20e37d2878510b32bad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#adcca5090c26cd20e37d2878510b32bad">More...</a><br /></td></tr>
149 <tr class="separator:adcca5090c26cd20e37d2878510b32bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:aa49cf1d6ea350774509911cad4903ad6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#aa49cf1d6ea350774509911cad4903ad6">operator=</a> (<a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&amp;)=default</td></tr>
151 <tr class="memdesc:aa49cf1d6ea350774509911cad4903ad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aa49cf1d6ea350774509911cad4903ad6">More...</a><br /></td></tr>
152 <tr class="separator:aa49cf1d6ea350774509911cad4903ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:aa5f7b3eca1cadbb4e72617eca3d6faeb"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#aa5f7b3eca1cadbb4e72617eca3d6faeb">~IGCTensor</a> ()=default</td></tr>
154 <tr class="memdesc:aa5f7b3eca1cadbb4e72617eca3d6faeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#aa5f7b3eca1cadbb4e72617eca3d6faeb">More...</a><br /></td></tr>
155 <tr class="separator:aa5f7b3eca1cadbb4e72617eca3d6faeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a14c53d2d17be6fa8a2c9861527c7b002"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">map</a> (bool blocking=true)</td></tr>
157 <tr class="memdesc:a14c53d2d17be6fa8a2c9861527c7b002"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map on an allocated buffer.  <a href="#a14c53d2d17be6fa8a2c9861527c7b002">More...</a><br /></td></tr>
158 <tr class="separator:a14c53d2d17be6fa8a2c9861527c7b002"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <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_i_g_c_tensor.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">unmap</a> ()</td></tr>
160 <tr class="memdesc:a1ffeb3b5abb3d61f62b58a391816201c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unmap an allocated and mapped buffer.  <a href="#a1ffeb3b5abb3d61f62b58a391816201c">More...</a><br /></td></tr>
161 <tr class="separator:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
163 <tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the contents of the tensor synchronously.  <a href="#ac8bb3912a3ce86b15842e79d0b421204">More...</a><br /></td></tr>
164 <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:ace7b855e3c647d29cc37a1ce147901dc"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#ace7b855e3c647d29cc37a1ce147901dc">buffer</a> () const override</td></tr>
166 <tr class="memdesc:ace7b855e3c647d29cc37a1ce147901dc"><td class="mdescLeft">&#160;</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>
167 <tr class="separator:ace7b855e3c647d29cc37a1ce147901dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:a78046d8dc1b472a13fe70d8862f2edaf"><td class="memItemLeft" align="right" valign="top">virtual GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a78046d8dc1b472a13fe70d8862f2edaf">gc_buffer</a> () const =0</td></tr>
169 <tr class="memdesc:a78046d8dc1b472a13fe70d8862f2edaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's gles compute buffer id.  <a href="#a78046d8dc1b472a13fe70d8862f2edaf">More...</a><br /></td></tr>
170 <tr class="separator:a78046d8dc1b472a13fe70d8862f2edaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:a61f1b6619df2a9324c6360b077083f39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a61f1b6619df2a9324c6360b077083f39">needs_shifting</a> () const </td></tr>
172 <tr class="memdesc:a61f1b6619df2a9324c6360b077083f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag indicating whether the tensor has been left aligned by a kernel and therefore needs shifting.  <a href="#a61f1b6619df2a9324c6360b077083f39">More...</a><br /></td></tr>
173 <tr class="separator:a61f1b6619df2a9324c6360b077083f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:a69cfba8177b402abe134fdad5fe4c7dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a69cfba8177b402abe134fdad5fe4c7dc">set_needs_shifting</a> (bool <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml#a61f1b6619df2a9324c6360b077083f39">needs_shifting</a>)</td></tr>
175 <tr class="memdesc:a69cfba8177b402abe134fdad5fe4c7dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the flag indicating whether or not a tensor needs shifting.  <a href="#a69cfba8177b402abe134fdad5fe4c7dc">More...</a><br /></td></tr>
176 <tr class="separator:a69cfba8177b402abe134fdad5fe4c7dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a></td></tr>
178 <tr class="memitem:a0e95dc1e53c361348314873b168ae237 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">info</a> () const =0</td></tr>
179 <tr class="memdesc:a0e95dc1e53c361348314873b168ae237 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata.  <a href="#a0e95dc1e53c361348314873b168ae237">More...</a><br /></td></tr>
180 <tr class="separator:a0e95dc1e53c361348314873b168ae237 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 <tr class="memitem:a7e6b5e55a2914b1fb1966310e7733ac4 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a7e6b5e55a2914b1fb1966310e7733ac4">info</a> ()=0</td></tr>
182 <tr class="memdesc:a7e6b5e55a2914b1fb1966310e7733ac4 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata.  <a href="#a7e6b5e55a2914b1fb1966310e7733ac4">More...</a><br /></td></tr>
183 <tr class="separator:a7e6b5e55a2914b1fb1966310e7733ac4 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 <tr class="memitem:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><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.xhtml#a4aa2df36743089ac6814d83e7d4b7ffc">~ITensor</a> ()=default</td></tr>
185 <tr class="memdesc:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a4aa2df36743089ac6814d83e7d4b7ffc">More...</a><br /></td></tr>
186 <tr class="separator:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
187 <tr class="memitem:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</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> &amp;<a class="el" href="hwc_8hpp.xhtml#abaabdc509cdaba7df9f56c6c76f3ae19">id</a>) const </td></tr>
188 <tr class="memdesc:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the element at the passed coordinates.  <a href="#a48c7a05cc63f541d732250e39339cee2">More...</a><br /></td></tr>
189 <tr class="separator:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
190 <tr class="memitem:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><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.xhtml#a4a774ad8d5f4837f3d7de1876d367c5b">copy_from</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;src)</td></tr>
191 <tr class="memdesc:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy the content of another tensor.  <a href="#a4a774ad8d5f4837f3d7de1876d367c5b">More...</a><br /></td></tr>
192 <tr class="separator:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 <tr class="memitem:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><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.xhtml#a0b092c86d6e0fb8a114281565953a02a">print</a> (std::ostream &amp;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>
194 <tr class="memdesc:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a tensor to a given stream using user defined formatting information.  <a href="#a0b092c86d6e0fb8a114281565953a02a">More...</a><br /></td></tr>
195 <tr class="separator:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
196 </table>
197 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
198 <div class="textblock"><p>Interface for GLES Compute tensor. </p>
199
200 <p>Definition at line <a class="el" href="_i_g_c_tensor_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_g_c_tensor_8h_source.xhtml">IGCTensor.h</a>.</p>
201 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
202 <a class="anchor" id="a78e2cb61c2ed12459fea5a97728d74d2"></a>
203 <div class="memitem">
204 <div class="memproto">
205       <table class="memname">
206         <tr>
207           <td class="memname"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> </td>
208           <td>(</td>
209           <td class="paramname"></td><td>)</td>
210           <td></td>
211         </tr>
212       </table>
213 </div><div class="memdoc">
214
215 <p>Default constructor. </p>
216
217 </div>
218 </div>
219 <a class="anchor" id="a15242f453f1928c3dbc2a30ec08480e6"></a>
220 <div class="memitem">
221 <div class="memproto">
222 <table class="mlabels">
223   <tr>
224   <td class="mlabels-left">
225       <table class="memname">
226         <tr>
227           <td class="memname"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> </td>
228           <td>(</td>
229           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&#160;</td>
230           <td class="paramname"></td><td>)</td>
231           <td></td>
232         </tr>
233       </table>
234   </td>
235   <td class="mlabels-right">
236 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
237   </tr>
238 </table>
239 </div><div class="memdoc">
240
241 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
242
243 </div>
244 </div>
245 <a class="anchor" id="adcca5090c26cd20e37d2878510b32bad"></a>
246 <div class="memitem">
247 <div class="memproto">
248 <table class="mlabels">
249   <tr>
250   <td class="mlabels-left">
251       <table class="memname">
252         <tr>
253           <td class="memname"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> </td>
254           <td>(</td>
255           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> &amp;&amp;&#160;</td>
256           <td class="paramname"></td><td>)</td>
257           <td></td>
258         </tr>
259       </table>
260   </td>
261   <td class="mlabels-right">
262 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
263   </tr>
264 </table>
265 </div><div class="memdoc">
266
267 <p>Allow instances of this class to be moved. </p>
268
269 </div>
270 </div>
271 <a class="anchor" id="aa5f7b3eca1cadbb4e72617eca3d6faeb"></a>
272 <div class="memitem">
273 <div class="memproto">
274 <table class="mlabels">
275   <tr>
276   <td class="mlabels-left">
277       <table class="memname">
278         <tr>
279           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> </td>
280           <td>(</td>
281           <td class="paramname"></td><td>)</td>
282           <td></td>
283         </tr>
284       </table>
285   </td>
286   <td class="mlabels-right">
287 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
288   </tr>
289 </table>
290 </div><div class="memdoc">
291
292 <p>Virtual destructor. </p>
293
294 </div>
295 </div>
296 <h2 class="groupheader">Member Function Documentation</h2>
297 <a class="anchor" id="ace7b855e3c647d29cc37a1ce147901dc"></a>
298 <div class="memitem">
299 <div class="memproto">
300 <table class="mlabels">
301   <tr>
302   <td class="mlabels-left">
303       <table class="memname">
304         <tr>
305           <td class="memname">uint8_t* buffer </td>
306           <td>(</td>
307           <td class="paramname"></td><td>)</td>
308           <td> const</td>
309         </tr>
310       </table>
311   </td>
312   <td class="mlabels-right">
313 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
314   </tr>
315 </table>
316 </div><div class="memdoc">
317
318 <p>Interface to be implemented by the child class to return a pointer to CPU memory. </p>
319 <dl class="section return"><dt>Returns</dt><dd>A CPU pointer to the beginning of the image's allocation. </dd></dl>
320
321 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ITensor</a>.</p>
322
323 <p>Reimplemented in <a class="el" href="classarm__compute_1_1_g_c_tensor.xhtml#ace7b855e3c647d29cc37a1ce147901dc">GCTensor</a>.</p>
324
325 </div>
326 </div>
327 <a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
328 <div class="memitem">
329 <div class="memproto">
330       <table class="memname">
331         <tr>
332           <td class="memname">void clear </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>Clear the contents of the tensor synchronously. </p>
341
342 </div>
343 </div>
344 <a class="anchor" id="a78046d8dc1b472a13fe70d8862f2edaf"></a>
345 <div class="memitem">
346 <div class="memproto">
347 <table class="mlabels">
348   <tr>
349   <td class="mlabels-left">
350       <table class="memname">
351         <tr>
352           <td class="memname">virtual GLuint gc_buffer </td>
353           <td>(</td>
354           <td class="paramname"></td><td>)</td>
355           <td> const</td>
356         </tr>
357       </table>
358   </td>
359   <td class="mlabels-right">
360 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
361   </tr>
362 </table>
363 </div><div class="memdoc">
364
365 <p>Interface to be implemented by the child class to return the tensor's gles compute buffer id. </p>
366 <dl class="section return"><dt>Returns</dt><dd>A SSBO buffer id. </dd></dl>
367
368 <p>Implemented in <a class="el" href="classarm__compute_1_1_g_c_tensor.xhtml#acccf4173f8c67e6f93ea3353c9590c9e">GCTensor</a>.</p>
369
370 </div>
371 </div>
372 <a class="anchor" id="a14c53d2d17be6fa8a2c9861527c7b002"></a>
373 <div class="memitem">
374 <div class="memproto">
375       <table class="memname">
376         <tr>
377           <td class="memname">void map </td>
378           <td>(</td>
379           <td class="paramtype">bool&#160;</td>
380           <td class="paramname"><em>blocking</em> = <code>true</code></td><td>)</td>
381           <td></td>
382         </tr>
383       </table>
384 </div><div class="memdoc">
385
386 <p>Map on an allocated buffer. </p>
387 <dl class="params"><dt>Parameters</dt><dd>
388   <table class="params">
389     <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>(Optional) 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>
390   </table>
391   </dd>
392 </dl>
393
394 <p>Referenced by <a class="el" href="_g_l_e_s___c_o_m_p_u_t_e_2_helper_8h_source.xhtml#l00084">arm_compute::test::gles_compute::print_tensor()</a>, and <a class="el" href="tests_2_utils_8h_source.xhtml#l00667">arm_compute::test::sync_tensor_if_necessary()</a>.</p>
395
396 </div>
397 </div>
398 <a class="anchor" id="a61f1b6619df2a9324c6360b077083f39"></a>
399 <div class="memitem">
400 <div class="memproto">
401       <table class="memname">
402         <tr>
403           <td class="memname">bool needs_shifting </td>
404           <td>(</td>
405           <td class="paramname"></td><td>)</td>
406           <td> const</td>
407         </tr>
408       </table>
409 </div><div class="memdoc">
410
411 <p>Flag indicating whether the tensor has been left aligned by a kernel and therefore needs shifting. </p>
412 <dl class="section return"><dt>Returns</dt><dd>True if the tensor is left aligned. </dd></dl>
413
414 </div>
415 </div>
416 <a class="anchor" id="a53ba7801ed7dbf945a0413addd6dc990"></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_i_g_c_tensor.xhtml">IGCTensor</a>&amp; operator= </td>
425           <td>(</td>
426           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</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="aa49cf1d6ea350774509911cad4903ad6"></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_i_g_c_tensor.xhtml">IGCTensor</a>&amp; operator= </td>
451           <td>(</td>
452           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</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="a69cfba8177b402abe134fdad5fe4c7dc"></a>
469 <div class="memitem">
470 <div class="memproto">
471       <table class="memname">
472         <tr>
473           <td class="memname">void set_needs_shifting </td>
474           <td>(</td>
475           <td class="paramtype">bool&#160;</td>
476           <td class="paramname"><em>needs_shifting</em></td><td>)</td>
477           <td></td>
478         </tr>
479       </table>
480 </div><div class="memdoc">
481
482 <p>Set the flag indicating whether or not a tensor needs shifting. </p>
483 <dl class="params"><dt>Parameters</dt><dd>
484   <table class="params">
485     <tr><td class="paramdir">[in]</td><td class="paramname">needs_shifting</td><td>Indicates if the tensor is left aligned or not. </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>Unmap an allocated and mapped buffer. </p>
506
507 <p>Referenced by <a class="el" href="_g_l_e_s___c_o_m_p_u_t_e_2_helper_8h_source.xhtml#l00084">arm_compute::test::gles_compute::print_tensor()</a>, and <a class="el" href="tests_2_utils_8h_source.xhtml#l00667">arm_compute::test::sync_tensor_if_necessary()</a>.</p>
508
509 </div>
510 </div>
511 <hr/>The documentation for this class was generated from the following file:<ul>
512 <li>arm_compute/core/GLES_COMPUTE/<a class="el" href="_i_g_c_tensor_8h_source.xhtml">IGCTensor.h</a></li>
513 </ul>
514 </div><!-- contents -->
515 </div><!-- doc-content -->
516 <!-- start footer part -->
517 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
518   <ul>
519     <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_g_c_tensor.xhtml">IGCTensor</a></li>
520     <li class="footer">Generated on Thu Feb 22 2018 15:45:24 for Compute Library by
521     <a href="http://www.doxygen.org/index.html">
522     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
523   </ul>
524 </div>
525 </body>
526 </html>