blob: 7ac206c07c903198881141903169f2475197c431 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.17-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arm NN: src/backends/backendsCommon/WorkloadFactoryBase.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>
<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="customdoxygen.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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
<td id="projectalign" style="padding-left: 0.9em;">
<div id="projectname">
&#160;<span id="projectnumber">24.02</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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('_workload_factory_base_8hpp_source.html',''); initResizable(); });
/* @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="headertitle">
<div class="title">WorkloadFactoryBase.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_workload_factory_base_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 © 2019, 2023 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; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_workload_factory_8hpp.html">armnn/backends/WorkloadFactory.hpp</a>&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</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"><a class="line" href="classarmnn_1_1_workload_factory_base.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_workload_factory_base.html">WorkloadFactoryBase</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_workload_factory.html">IWorkloadFactory</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classarmnn_1_1_workload_factory_base.html#aed0a782f32856bde72bc10d9381dc11e"> 16</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_workload_factory_base.html#aed0a782f32856bde72bc10d9381dc11e">SupportsSubTensors</a>()<span class="keyword"> const override</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; };</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classarmnn_1_1_workload_factory_base.html#a99251f9711c087d7c1b5a08236ef0201"> 19</a></span>&#160; std::unique_ptr&lt;ITensorHandle&gt; <a class="code" href="classarmnn_1_1_workload_factory_base.html#a99251f9711c087d7c1b5a08236ef0201">CreateSubTensorHandle</a>(<a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>&amp; <span class="comment">/*parent*/</span>,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <a class="code" href="classarmnn_1_1_tensor_shape.html">TensorShape</a> <span class="keyword">const</span>&amp; <span class="comment">/*subTensorShape*/</span>,</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keyword">const</span> *<span class="comment">/*subTensorOrigin*/</span>)<span class="keyword"> const override</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">nullptr</span>; };</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classarmnn_1_1_workload_factory_base.html#a526eaec84398bc8067f407769b31f4a9"> 25</a></span>&#160; std::unique_ptr&lt;ITensorHandle&gt; <a class="code" href="classarmnn_1_1_workload_factory_base.html#a526eaec84398bc8067f407769b31f4a9">CreateTensorHandle</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_tensor_info.html">TensorInfo</a>&amp; <span class="comment">/*tensorInfo*/</span>,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <span class="comment">/*IsMemoryManaged*/</span>)<span class="keyword"> const override</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">nullptr</span>; }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classarmnn_1_1_workload_factory_base.html#a68f34fb8ec9a7921a1f6c17b4f5312e6"> 29</a></span>&#160; std::unique_ptr&lt;ITensorHandle&gt; <a class="code" href="classarmnn_1_1_workload_factory_base.html#a68f34fb8ec9a7921a1f6c17b4f5312e6">CreateTensorHandle</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_tensor_info.html">TensorInfo</a>&amp; <span class="comment">/*tensorInfo*/</span>,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> <span class="comment">/*dataLayout*/</span>,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <span class="comment">/*IsMemoryManaged*/</span>)<span class="keyword"> const override</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">nullptr</span>; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarmnn_1_1_workload_factory_base.html#a30b9965b6bce898c027235de615e2331"> 34</a></span>&#160; std::unique_ptr&lt;IWorkload&gt; <a class="code" href="classarmnn_1_1_workload_factory_base.html#a30b9965b6bce898c027235de615e2331">CreateWorkload</a>(<a class="code" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">LayerType</a> <span class="comment">/*type*/</span>,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_queue_descriptor.html">QueueDescriptor</a>&amp; <span class="comment">/*descriptor*/</span>,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_workload_info.html">WorkloadInfo</a>&amp; <span class="comment">/*info*/</span>)<span class="keyword"> const override</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">nullptr</span>; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} <span class="comment">//namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html_a526eaec84398bc8067f407769b31f4a9"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html#a526eaec84398bc8067f407769b31f4a9">armnn::WorkloadFactoryBase::CreateTensorHandle</a></div><div class="ttdeci">std::unique_ptr&lt; ITensorHandle &gt; CreateTensorHandle(const TensorInfo &amp;, const bool) const override</div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00025">WorkloadFactoryBase.hpp:25</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html">armnn::WorkloadFactoryBase</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00013">WorkloadFactoryBase.hpp:13</a></div></div>
<div class="ttc" id="anamespacearmnn_html_ad1d5cce2d9e9a5d61c243e5c989112e0"><div class="ttname"><a href="namespacearmnn.html#ad1d5cce2d9e9a5d61c243e5c989112e0">armnn::DataLayout</a></div><div class="ttdeci">DataLayout</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00062">Types.hpp:62</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_tensor_info_html"><div class="ttname"><a href="classarmnn_1_1_tensor_info.html">armnn::TensorInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8hpp_source.html#l00152">Tensor.hpp:152</a></div></div>
<div class="ttc" id="aclassarmnn_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="_i_tensor_handle_8hpp_source.html#l00016">ITensorHandle.hpp:16</a></div></div>
<div class="ttc" id="a_workload_factory_8hpp_html"><div class="ttname"><a href="_workload_factory_8hpp.html">WorkloadFactory.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_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="astructarmnn_1_1_workload_info_html"><div class="ttname"><a href="structarmnn_1_1_workload_info.html">armnn::WorkloadInfo</a></div><div class="ttdoc">Contains information about TensorInfos of a layer.</div><div class="ttdef"><b>Definition:</b> <a href="_workload_info_8hpp_source.html#l00016">WorkloadInfo.hpp:16</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_workload_factory_html"><div class="ttname"><a href="classarmnn_1_1_i_workload_factory.html">armnn::IWorkloadFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_8hpp_source.html#l00022">WorkloadFactory.hpp:22</a></div></div>
<div class="ttc" id="astructarmnn_1_1_queue_descriptor_html"><div class="ttname"><a href="structarmnn_1_1_queue_descriptor.html">armnn::QueueDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_data_8hpp_source.html#l00024">WorkloadData.hpp:24</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html_a30b9965b6bce898c027235de615e2331"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html#a30b9965b6bce898c027235de615e2331">armnn::WorkloadFactoryBase::CreateWorkload</a></div><div class="ttdeci">std::unique_ptr&lt; IWorkload &gt; CreateWorkload(LayerType, const QueueDescriptor &amp;, const WorkloadInfo &amp;) const override</div><div class="ttdoc">Backends should implement their own CreateWorkload function with a switch statement.</div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00034">WorkloadFactoryBase.hpp:34</a></div></div>
<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html_a68f34fb8ec9a7921a1f6c17b4f5312e6"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html#a68f34fb8ec9a7921a1f6c17b4f5312e6">armnn::WorkloadFactoryBase::CreateTensorHandle</a></div><div class="ttdeci">std::unique_ptr&lt; ITensorHandle &gt; CreateTensorHandle(const TensorInfo &amp;, DataLayout, const bool) const override</div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00029">WorkloadFactoryBase.hpp:29</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html_aed0a782f32856bde72bc10d9381dc11e"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html#aed0a782f32856bde72bc10d9381dc11e">armnn::WorkloadFactoryBase::SupportsSubTensors</a></div><div class="ttdeci">bool SupportsSubTensors() const override</div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00016">WorkloadFactoryBase.hpp:16</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">armnn::LayerType</a></div><div class="ttdeci">LayerType</div><div class="ttdoc">When adding a new layer, adapt also the LastLayer enum value in the enum class LayerType below.</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00491">Types.hpp:491</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_workload_factory_base_html_a99251f9711c087d7c1b5a08236ef0201"><div class="ttname"><a href="classarmnn_1_1_workload_factory_base.html#a99251f9711c087d7c1b5a08236ef0201">armnn::WorkloadFactoryBase::CreateSubTensorHandle</a></div><div class="ttdeci">std::unique_ptr&lt; ITensorHandle &gt; CreateSubTensorHandle(ITensorHandle &amp;, TensorShape const &amp;, unsigned int const *) const override</div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_base_8hpp_source.html#l00019">WorkloadFactoryBase.hpp:19</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.html">backends</a></li><li class="navelem"><a class="el" href="dir_797a213d7d01b98ef12d53b0820ea64e.html">backendsCommon</a></li><li class="navelem"><a class="el" href="_workload_factory_base_8hpp.html">WorkloadFactoryBase.hpp</a></li>
<li class="footer">Generated on Wed Feb 14 2024 16:36:15 for Arm NN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>