blob: a7bf6aa83b99bc0585688b5ebecf71874a203ae7 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!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.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: SubTensor Class Reference</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1_sub_tensor.xhtml','');});
/* @license-end */
</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="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SubTensor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Basic implementation of the sub-tensor interface.
<a href="classarm__compute_1_1_sub_tensor.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_sub_tensor_8h_source.xhtml">SubTensor.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for SubTensor:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_sub_tensor__coll__graph.svg" width="99" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a29f0969775d17df94d8e87c40b7b7df1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#a29f0969775d17df94d8e87c40b7b7df1">SubTensor</a> ()</td></tr>
<tr class="memdesc:a29f0969775d17df94d8e87c40b7b7df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor. <a href="#a29f0969775d17df94d8e87c40b7b7df1">More...</a><br /></td></tr>
<tr class="separator:a29f0969775d17df94d8e87c40b7b7df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d0af8325f260b3642402e3b05a6c0df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#a4d0af8325f260b3642402e3b05a6c0df">SubTensor</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *<a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">parent</a>, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;tensor_shape, const <a class="el" href="classarm__compute_1_1_coordinates.xhtml">Coordinates</a> &amp;coords, bool extend_parent=false)</td></tr>
<tr class="memdesc:a4d0af8325f260b3642402e3b05a6c0df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a4d0af8325f260b3642402e3b05a6c0df">More...</a><br /></td></tr>
<tr class="separator:a4d0af8325f260b3642402e3b05a6c0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1fc5900259cbc0bc26c9e6e28bb49b6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#af1fc5900259cbc0bc26c9e6e28bb49b6">~SubTensor</a> ()=default</td></tr>
<tr class="memdesc:af1fc5900259cbc0bc26c9e6e28bb49b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor: free the tensor's memory. <a href="#af1fc5900259cbc0bc26c9e6e28bb49b6">More...</a><br /></td></tr>
<tr class="separator:af1fc5900259cbc0bc26c9e6e28bb49b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7280b618490cedd24a18fe8849b4679"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#ab7280b618490cedd24a18fe8849b4679">SubTensor</a> (const <a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;)=delete</td></tr>
<tr class="memdesc:ab7280b618490cedd24a18fe8849b4679"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restrict instances of this class to be copy constructed. <a href="#ab7280b618490cedd24a18fe8849b4679">More...</a><br /></td></tr>
<tr class="separator:ab7280b618490cedd24a18fe8849b4679"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a31c7d9dde928db10b23bccd64b87d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#a90a31c7d9dde928db10b23bccd64b87d">operator=</a> (const <a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;)=delete</td></tr>
<tr class="memdesc:a90a31c7d9dde928db10b23bccd64b87d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restrict instances of this class to be copied. <a href="#a90a31c7d9dde928db10b23bccd64b87d">More...</a><br /></td></tr>
<tr class="separator:a90a31c7d9dde928db10b23bccd64b87d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a366eac7e6cd70c8032528a17da5c3999"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#a366eac7e6cd70c8032528a17da5c3999">SubTensor</a> (<a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a366eac7e6cd70c8032528a17da5c3999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed. <a href="#a366eac7e6cd70c8032528a17da5c3999">More...</a><br /></td></tr>
<tr class="separator:a366eac7e6cd70c8032528a17da5c3999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab77dfdfcd9be21524025d71a9650fba5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#ab77dfdfcd9be21524025d71a9650fba5">operator=</a> (<a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ab77dfdfcd9be21524025d71a9650fba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved. <a href="#ab77dfdfcd9be21524025d71a9650fba5">More...</a><br /></td></tr>
<tr class="separator:ab77dfdfcd9be21524025d71a9650fba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafd31a7d3ee584d6ccf9e226e5a330d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">parent</a> ()</td></tr>
<tr class="memdesc:aafd31a7d3ee584d6ccf9e226e5a330d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the parent tensor of the subtensor. <a href="#aafd31a7d3ee584d6ccf9e226e5a330d4">More...</a><br /></td></tr>
<tr class="separator:aafd31a7d3ee584d6ccf9e226e5a330d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47d74e4e51f9b1a636c4831bd747a97c"><td class="memItemLeft" align="right" valign="top"><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_sub_tensor.xhtml#a47d74e4e51f9b1a636c4831bd747a97c">info</a> () const override</td></tr>
<tr class="memdesc:a47d74e4e51f9b1a636c4831bd747a97c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata. <a href="#a47d74e4e51f9b1a636c4831bd747a97c">More...</a><br /></td></tr>
<tr class="separator:a47d74e4e51f9b1a636c4831bd747a97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3913a3ffefed788b1fa3fb91407472a"><td class="memItemLeft" align="right" valign="top"><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_sub_tensor.xhtml#af3913a3ffefed788b1fa3fb91407472a">info</a> () override</td></tr>
<tr class="memdesc:af3913a3ffefed788b1fa3fb91407472a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata. <a href="#af3913a3ffefed788b1fa3fb91407472a">More...</a><br /></td></tr>
<tr class="separator:af3913a3ffefed788b1fa3fb91407472a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24954cca5108a24706441fd99a7fb04c"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml#a24954cca5108a24706441fd99a7fb04c">buffer</a> () const override</td></tr>
<tr class="memdesc:a24954cca5108a24706441fd99a7fb04c"><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="#a24954cca5108a24706441fd99a7fb04c">More...</a><br /></td></tr>
<tr class="separator:a24954cca5108a24706441fd99a7fb04c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<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="classarm__compute_1_1_i_tensor.xhtml#a4aa2df36743089ac6814d83e7d4b7ffc">More...</a><br /></td></tr>
<tr class="separator:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbd73147d41e8a640bc299d12613c31e 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#adbd73147d41e8a640bc299d12613c31e">ptr_to_element</a> (const <a class="el" href="classarm__compute_1_1_coordinates.xhtml">Coordinates</a> &amp;id) const</td></tr>
<tr class="memdesc:adbd73147d41e8a640bc299d12613c31e 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="classarm__compute_1_1_i_tensor.xhtml#adbd73147d41e8a640bc299d12613c31e">More...</a><br /></td></tr>
<tr class="separator:adbd73147d41e8a640bc299d12613c31e inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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="classarm__compute_1_1_i_tensor.xhtml#a4a774ad8d5f4837f3d7de1876d367c5b">More...</a><br /></td></tr>
<tr class="separator:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade74189c92e70baa2848986c10dbe7ef 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#ade74189c92e70baa2848986c10dbe7ef">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>
<tr class="memdesc:ade74189c92e70baa2848986c10dbe7ef 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="classarm__compute_1_1_i_tensor.xhtml#ade74189c92e70baa2848986c10dbe7ef">More...</a><br /></td></tr>
<tr class="separator:ade74189c92e70baa2848986c10dbe7ef inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a209ea2ddfdfa80703799c92da8beb643 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a209ea2ddfdfa80703799c92da8beb643">is_used</a> () const</td></tr>
<tr class="memdesc:a209ea2ddfdfa80703799c92da8beb643 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags if the tensor is used or not. <a href="classarm__compute_1_1_i_tensor.xhtml#a209ea2ddfdfa80703799c92da8beb643">More...</a><br /></td></tr>
<tr class="separator:a209ea2ddfdfa80703799c92da8beb643 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bc00234de9adf8c99a21eb1d7d494c2 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#a9bc00234de9adf8c99a21eb1d7d494c2">mark_as_unused</a> () const</td></tr>
<tr class="memdesc:a9bc00234de9adf8c99a21eb1d7d494c2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marks a tensor as unused. <a href="classarm__compute_1_1_i_tensor.xhtml#a9bc00234de9adf8c99a21eb1d7d494c2">More...</a><br /></td></tr>
<tr class="separator:a9bc00234de9adf8c99a21eb1d7d494c2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic implementation of the sub-tensor interface. </p>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_sub_tensor_8h_source.xhtml">SubTensor.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a29f0969775d17df94d8e87c40b7b7df1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29f0969775d17df94d8e87c40b7b7df1">&#9670;&nbsp;</a></span>SubTensor() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default Constructor. </p>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00030">30</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; : _parent(<span class="keyword">nullptr</span>), _info()</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="a4d0af8325f260b3642402e3b05a6c0df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d0af8325f260b3642402e3b05a6c0df">&#9670;&nbsp;</a></span>SubTensor() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
<td class="paramname"><em>tensor_shape</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_coordinates.xhtml">Coordinates</a> &amp;&#160;</td>
<td class="paramname"><em>coords</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>extend_parent</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parent</td><td>Parent tensor </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tensor_shape</td><td>Shape of the subtensor </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">coords</td><td><a class="el" href="classarm__compute_1_1_coordinates.xhtml" title="Coordinates of an item.">Coordinates</a> of the first subtensor element inside the parent tensor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">extend_parent</td><td>(Optional) Extend parent with subtensor shape if subtensor indexes out of bounds </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00035">35</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; : _parent(<span class="keyword">nullptr</span>), _info()</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<a class="code" href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">parent</a> == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; _info = <a class="code" href="classarm__compute_1_1_sub_tensor_info.xhtml">SubTensorInfo</a>(<a class="code" href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">parent</a>-&gt;<a class="code" href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">info</a>(), tensor_shape, coords, extend_parent);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; _parent = <a class="code" href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">parent</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00337">Error.h:337</a></div></div>
<div class="ttc" id="classarm__compute_1_1_sub_tensor_info_xhtml"><div class="ttname"><a href="classarm__compute_1_1_sub_tensor_info.xhtml">arm_compute::SubTensorInfo</a></div><div class="ttdoc">Store the sub tensor's metadata.</div><div class="ttdef"><b>Definition:</b> <a href="_sub_tensor_info_8h_source.xhtml#l00042">SubTensorInfo.h:42</a></div></div>
<div class="ttc" id="classarm__compute_1_1_sub_tensor_xhtml_aafd31a7d3ee584d6ccf9e226e5a330d4"><div class="ttname"><a href="classarm__compute_1_1_sub_tensor.xhtml#aafd31a7d3ee584d6ccf9e226e5a330d4">arm_compute::SubTensor::parent</a></div><div class="ttdeci">ITensor * parent()</div><div class="ttdoc">Return the parent tensor of the subtensor.</div><div class="ttdef"><b>Definition:</b> <a href="_sub_tensor_8cpp_source.xhtml#l00059">SubTensor.cpp:59</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_tensor_xhtml_a0e95dc1e53c361348314873b168ae237"><div class="ttname"><a href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">arm_compute::ITensor::info</a></div><div class="ttdeci">virtual ITensorInfo * info() const =0</div><div class="ttdoc">Interface to be implemented by the child class to return the tensor's metadata.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00337">ARM_COMPUTE_ERROR_ON</a>, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">ITensor::info()</a>, and <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00059">SubTensor::parent()</a>.</p>
</div>
</div>
<a id="af1fc5900259cbc0bc26c9e6e28bb49b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1fc5900259cbc0bc26c9e6e28bb49b6">&#9670;&nbsp;</a></span>~SubTensor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor: free the tensor's memory. </p>
</div>
</div>
<a id="ab7280b618490cedd24a18fe8849b4679"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7280b618490cedd24a18fe8849b4679">&#9670;&nbsp;</a></span>SubTensor() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restrict instances of this class to be copy constructed. </p>
</div>
</div>
<a id="a366eac7e6cd70c8032528a17da5c3999"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a366eac7e6cd70c8032528a17da5c3999">&#9670;&nbsp;</a></span>SubTensor() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow instances of this class to be move constructed. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a24954cca5108a24706441fd99a7fb04c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24954cca5108a24706441fd99a7fb04c">&#9670;&nbsp;</a></span>buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t * buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Interface to be implemented by the child class to return a pointer to CPU memory. </p>
<dl class="section return"><dt>Returns</dt><dd>A CPU pointer to the beginning of the image's allocation. </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ITensor</a>.</p>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00053">53</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(_parent == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> _parent-&gt;<a class="code" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">buffer</a>();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00337">Error.h:337</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_tensor_xhtml_ab988210662dbd3bf32fd563c7dd1bdbf"><div class="ttname"><a href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">arm_compute::ITensor::buffer</a></div><div class="ttdeci">virtual uint8_t * buffer() const =0</div><div class="ttdoc">Interface to be implemented by the child class to return a pointer to CPU memory.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00337">ARM_COMPUTE_ERROR_ON</a>, and <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ITensor::buffer()</a>.</p>
</div>
</div>
<a id="a47d74e4e51f9b1a636c4831bd747a97c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47d74e4e51f9b1a636c4831bd747a97c">&#9670;&nbsp;</a></span>info() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> * info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Interface to be implemented by the child class to return the tensor's metadata. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the tensor's metadata. </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0e95dc1e53c361348314873b168ae237">ITensor</a>.</p>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00043">43</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> &amp;_info;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="af3913a3ffefed788b1fa3fb91407472a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3913a3ffefed788b1fa3fb91407472a">&#9670;&nbsp;</a></span>info() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> * info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Interface to be implemented by the child class to return the tensor's metadata. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the tensor's metadata. </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a7e6b5e55a2914b1fb1966310e7733ac4">ITensor</a>.</p>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00048">48</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">return</span> &amp;_info;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="a90a31c7d9dde928db10b23bccd64b87d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90a31c7d9dde928db10b23bccd64b87d">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a>&amp; operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restrict instances of this class to be copied. </p>
</div>
</div>
<a id="ab77dfdfcd9be21524025d71a9650fba5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab77dfdfcd9be21524025d71a9650fba5">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a>&amp; operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow instances of this class to be moved. </p>
</div>
</div>
<a id="aafd31a7d3ee584d6ccf9e226e5a330d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafd31a7d3ee584d6ccf9e226e5a330d4">&#9670;&nbsp;</a></span>parent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * parent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the parent tensor of the subtensor. </p>
<dl class="section return"><dt>Returns</dt><dd>Parent tensor </dd></dl>
<p class="definition">Definition at line <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00059">59</a> of file <a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;{</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> _parent;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_sub_tensor_8cpp_source.xhtml#l00035">SubTensor::SubTensor()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/runtime/<a class="el" href="_sub_tensor_8h_source.xhtml">SubTensor.h</a></li>
<li>src/runtime/<a class="el" href="_sub_tensor_8cpp_source.xhtml">SubTensor.cpp</a></li>
</ul>
</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="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_sub_tensor.xhtml">SubTensor</a></li>
<li class="footer">Generated on Mon Sep 2 2019 11:47:38 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>