blob: d1546b201a92e0cde732c39c3c56088b8d565e7a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: include/armnn/backends/ITensorHandle.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ArmNN
&#160;<span id="projectnumber">NotReleased</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">ITensorHandle.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="include_2armnn_2backends_2_i_tensor_handle_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_memory_sources_8hpp.html">armnn/MemorySources.hpp</a>&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;boost/core/ignore_unused.hpp&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">class </span>TensorShape;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html"> 16</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html#aff95f063e2b8041b3d0e4b4dc0e3821d"> 19</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#aff95f063e2b8041b3d0e4b4dc0e3821d">~ITensorHandle</a>(){}</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a04149d0f9b9c54c05e95693111490daf">Manage</a>() = 0;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">Allocate</a>() = 0;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>* <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a437893b8dcf58a0b68b70e1ad7933be6">GetParent</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a9afbc055a017adf1bc38ee137bca6e90">Map</a>(<span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a563609828050f1b3a7868c23f3365923">Unmap</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html#a270c8f844df649b9b0599c1e4db44cd3"> 44</a></span>&#160; <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a270c8f844df649b9b0599c1e4db44cd3">Map</a>(<span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> <span class="keyword">const_cast&lt;</span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(<span class="keyword">static_cast&lt;</span><span class="keyword">const </span><a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>*<span class="keyword">&gt;</span>(<span class="keyword">this</span>)-&gt;<a class="code" href="classarmnn_1_1_i_tensor_handle.html#a9afbc055a017adf1bc38ee137bca6e90">Map</a>(blocking));</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html#ab2be1412c91842a072ad94759f52033e"> 50</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#ab2be1412c91842a072ad94759f52033e">Unmap</a>()</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keyword">const </span><a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>*<span class="keyword">&gt;</span>(<span class="keyword">this</span>)-&gt;<a class="code" href="classarmnn_1_1_i_tensor_handle.html#a563609828050f1b3a7868c23f3365923">Unmap</a>();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_tensor_shape.html">TensorShape</a> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a30c3e09ce55369b66469443a4ca5ef03">GetStrides</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_tensor_shape.html">TensorShape</a> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#affd5aae75cad90f472f96cfd25a13f29">GetShape</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// Testing support to be able to verify and set tensor data content</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a4ec32790513ea4af4c5746f1ee48fbfe">CopyOutTo</a>(<span class="keywordtype">void</span>* memory) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#ad495ac6d9fd9e1ba5bb7a02c731a2d83">CopyInFrom</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* memory) = 0;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html#a55cddc2dbb32d680cd85b635ba370e48"> 70</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a55cddc2dbb32d680cd85b635ba370e48">GetImportFlags</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_tensor_handle.html#a4f81a9eff30c9b9fe76f5b83af470ba7"> 76</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_i_tensor_handle.html#a4f81a9eff30c9b9fe76f5b83af470ba7">Import</a>(<span class="keywordtype">void</span>* memory, <a class="code" href="namespacearmnn.html#a0fc99721e27eb20ecd0ea85a3cc8b488">MemorySource</a> source)</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; boost::ignore_unused(memory, source);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;};</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;}</div><div class="ttc" id="_memory_sources_8hpp_html"><div class="ttname"><a href="_memory_sources_8hpp.html">MemorySources.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a270c8f844df649b9b0599c1e4db44cd3"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a270c8f844df649b9b0599c1e4db44cd3">armnn::ITensorHandle::Map</a></div><div class="ttdeci">void * Map(bool blocking=true)</div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00044">ITensorHandle.hpp:44</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a4f81a9eff30c9b9fe76f5b83af470ba7"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a4f81a9eff30c9b9fe76f5b83af470ba7">armnn::ITensorHandle::Import</a></div><div class="ttdeci">virtual bool Import(void *memory, MemorySource source)</div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00076">ITensorHandle.hpp:76</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a55cddc2dbb32d680cd85b635ba370e48"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a55cddc2dbb32d680cd85b635ba370e48">armnn::ITensorHandle::GetImportFlags</a></div><div class="ttdeci">virtual unsigned int GetImportFlags() const</div><div class="ttdoc">Get flags describing supported import sources. </div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00070">ITensorHandle.hpp:70</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a9afbc055a017adf1bc38ee137bca6e90"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a9afbc055a017adf1bc38ee137bca6e90">armnn::ITensorHandle::Map</a></div><div class="ttdeci">virtual const void * Map(bool blocking=true) const =0</div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a4ec32790513ea4af4c5746f1ee48fbfe"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a4ec32790513ea4af4c5746f1ee48fbfe">armnn::ITensorHandle::CopyOutTo</a></div><div class="ttdeci">virtual void CopyOutTo(void *memory) const =0</div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html">armnn::ITensorHandle</a></div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00016">ITensorHandle.hpp:16</a></div></div>
<div class="ttc" id="namespacearmnn_html_a0fc99721e27eb20ecd0ea85a3cc8b488"><div class="ttname"><a href="namespacearmnn.html#a0fc99721e27eb20ecd0ea85a3cc8b488">armnn::MemorySource</a></div><div class="ttdeci">MemorySource</div><div class="ttdef"><b>Definition:</b> <a href="_memory_sources_8hpp_source.html#l00013">MemorySources.hpp:13</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_affd5aae75cad90f472f96cfd25a13f29"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#affd5aae75cad90f472f96cfd25a13f29">armnn::ITensorHandle::GetShape</a></div><div class="ttdeci">virtual TensorShape GetShape() const =0</div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a437893b8dcf58a0b68b70e1ad7933be6"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a437893b8dcf58a0b68b70e1ad7933be6">armnn::ITensorHandle::GetParent</a></div><div class="ttdeci">virtual ITensorHandle * GetParent() const =0</div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a04149d0f9b9c54c05e95693111490daf"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a04149d0f9b9c54c05e95693111490daf">armnn::ITensorHandle::Manage</a></div><div class="ttdeci">virtual void Manage()=0</div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_aff95f063e2b8041b3d0e4b4dc0e3821d"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#aff95f063e2b8041b3d0e4b4dc0e3821d">armnn::ITensorHandle::~ITensorHandle</a></div><div class="ttdeci">virtual ~ITensorHandle()</div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00019">ITensorHandle.hpp:19</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_ab2be1412c91842a072ad94759f52033e"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#ab2be1412c91842a072ad94759f52033e">armnn::ITensorHandle::Unmap</a></div><div class="ttdeci">void Unmap()</div><div class="ttdoc">Unmap the tensor data that was previously mapped with call to Map(). </div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_tensor_handle_8hpp_source.html#l00050">ITensorHandle.hpp:50</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a30c3e09ce55369b66469443a4ca5ef03"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a30c3e09ce55369b66469443a4ca5ef03">armnn::ITensorHandle::GetStrides</a></div><div class="ttdeci">virtual TensorShape GetStrides() const =0</div></div>
<div class="ttc" id="namespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_helper_8hpp_source.html#l00011">BackendHelper.hpp:11</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a563609828050f1b3a7868c23f3365923"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a563609828050f1b3a7868c23f3365923">armnn::ITensorHandle::Unmap</a></div><div class="ttdeci">virtual void Unmap() const =0</div><div class="ttdoc">Unmap the tensor data. </div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_ad495ac6d9fd9e1ba5bb7a02c731a2d83"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#ad495ac6d9fd9e1ba5bb7a02c731a2d83">armnn::ITensorHandle::CopyInFrom</a></div><div class="ttdeci">virtual void CopyInFrom(const void *memory)=0</div></div>
<div class="ttc" id="classarmnn_1_1_tensor_shape_html"><div class="ttname"><a href="classarmnn_1_1_tensor_shape.html">armnn::TensorShape</a></div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8hpp_source.html#l00020">Tensor.hpp:20</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_tensor_handle_html_a5cceed8b707a09bf27eb61f17acf8a88"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">armnn::ITensorHandle::Allocate</a></div><div class="ttdeci">virtual void Allocate()=0</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.html">armnn</a></li><li class="navelem"><a class="el" href="dir_8946eb9d8f826e973720979438627a91.html">backends</a></li><li class="navelem"><a class="el" href="include_2armnn_2backends_2_i_tensor_handle_8hpp.html">ITensorHandle.hpp</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:06:53 for ArmNN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>