blob: 79435a3d75552ba7e435b28332215a14645ce867 [file] [log] [blame]
<!-- Copyright (c) 2020 ARM Limited. -->
<!-- -->
<!-- SPDX-License-Identifier: MIT -->
<!-- -->
<!-- HTML header for doxygen 1.8.13-->
<!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="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: IBackend 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">
$(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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02</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('classarmnn_1_1_i_backend.xhtml','');});
</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> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classarmnn_1_1_i_backend-members.xhtml">List of all members</a> </div>
<div class="headertitle">
<div class="title">IBackend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.xhtml" title="Each backend should implement an IBackend. ">IBackend</a>.
<a href="classarmnn_1_1_i_backend.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IBackend:</div>
<div class="dyncontent">
<div class="center">
<img src="classarmnn_1_1_i_backend.png" usemap="#IBackend_map" alt=""/>
<map id="IBackend_map" name="IBackend_map">
<area href="classarmnn_1_1_i_backend_internal.xhtml" alt="IBackendInternal" shape="rect" coords="174,56,280,80"/>
<area href="classarmnn_1_1_cl_backend.xhtml" alt="ClBackend" shape="rect" coords="0,112,106,136"/>
<area href="classarmnn_1_1_mock_backend.xhtml" alt="MockBackend" shape="rect" coords="116,112,222,136"/>
<area href="classarmnn_1_1_neon_backend.xhtml" alt="NeonBackend" shape="rect" coords="232,112,338,136"/>
<area href="classarmnn_1_1_ref_backend.xhtml" alt="RefBackend" shape="rect" coords="348,112,454,136"/>
</map>
</div></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:aa9fc23b7155bd678232eeb351059b748"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#aa9fc23b7155bd678232eeb351059b748">GetId</a> () const =0</td></tr>
<tr class="separator:aa9fc23b7155bd678232eeb351059b748"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a7cfc55eae265fa65b7d25e7dd3203f22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#a7cfc55eae265fa65b7d25e7dd3203f22">IBackend</a> ()</td></tr>
<tr class="separator:a7cfc55eae265fa65b7d25e7dd3203f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa73289e0503a4f7ec5909e117a57aa2b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#aa73289e0503a4f7ec5909e117a57aa2b">~IBackend</a> ()</td></tr>
<tr class="separator:aa73289e0503a4f7ec5909e117a57aa2b"><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>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.xhtml" title="Each backend should implement an IBackend. ">IBackend</a>. </p>
<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00147">147</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7cfc55eae265fa65b7d25e7dd3203f22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cfc55eae265fa65b7d25e7dd3203f22">&#9670;&nbsp;</a></span>IBackend()</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="classarmnn_1_1_i_backend.xhtml">IBackend</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">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00150">150</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<a id="aa73289e0503a4f7ec5909e117a57aa2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa73289e0503a4f7ec5909e117a57aa2b">&#9670;&nbsp;</a></span>~IBackend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_backend.xhtml">IBackend</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">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00151">151</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;{}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa9fc23b7155bd678232eeb351059b748"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9fc23b7155bd678232eeb351059b748">&#9670;&nbsp;</a></span>GetId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&amp; GetId </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">MockBackend</a>, <a class="el" href="classarmnn_1_1_cl_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">ClBackend</a>, <a class="el" href="classarmnn_1_1_neon_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">NeonBackend</a>, and <a class="el" href="classarmnn_1_1_ref_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">RefBackend</a>.</p>
<p class="reference">Referenced by <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml#l00012">TestDynamicBackendId()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/armnn/<a class="el" href="_types_8hpp_source.xhtml">Types.hpp</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_backend.xhtml">IBackend</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:09:18 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>