diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2022-08-19 15:23:36 +0100 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2022-08-19 15:23:36 +0100 |
commit | 7bfd38a721360183f3392f9ab35db18a0dd7fef8 (patch) | |
tree | 5b4da2f2e88636c939afbafa2571170297114e40 /22.08/class_i_executor.xhtml | |
parent | d5d43d82c0137e08553e44345c609cdd1a7931c7 (diff) | |
download | armnn-7bfd38a721360183f3392f9ab35db18a0dd7fef8.tar.gz |
Update Doxygen for 22.08 Release
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I4789fe868e0492839be1482e5cee3642ed90d756
Diffstat (limited to '22.08/class_i_executor.xhtml')
-rw-r--r-- | 22.08/class_i_executor.xhtml | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/22.08/class_i_executor.xhtml b/22.08/class_i_executor.xhtml new file mode 100644 index 0000000000..d23b477d53 --- /dev/null +++ b/22.08/class_i_executor.xhtml @@ -0,0 +1,271 @@ +<!-- 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: IExecutor 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"> +  <span id="projectnumber">22.08</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('class_i_executor.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> | +<a href="class_i_executor-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IExecutor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="class_i_executor.xhtml" title="IExecutor executes a network. ">IExecutor</a> executes a network. + <a href="class_i_executor.xhtml#details">More...</a></p> + +<p><code>#include <<a class="el" href="_i_executor_8hpp_source.xhtml">IExecutor.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IExecutor:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_i_executor.png" usemap="#IExecutor_map" alt=""/> + <map id="IExecutor_map" name="IExecutor_map"> +<area href="class_arm_n_n_executor.xhtml" alt="ArmNNExecutor" shape="rect" coords="0,56,103,80"/> +<area href="class_tf_lite_executor.xhtml" alt="TfLiteExecutor" shape="rect" coords="113,56,216,80"/> +</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:ab11f3f9cae37ecd9f9760d5ea82f47b3"><td class="memItemLeft" align="right" valign="top">virtual std::vector< const void * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_executor.xhtml#ab11f3f9cae37ecd9f9760d5ea82f47b3">Execute</a> ()=0</td></tr> +<tr class="memdesc:ab11f3f9cae37ecd9f9760d5ea82f47b3"><td class="mdescLeft"> </td><td class="mdescRight">Execute the given network. <a href="#ab11f3f9cae37ecd9f9760d5ea82f47b3">More...</a><br /></td></tr> +<tr class="separator:ab11f3f9cae37ecd9f9760d5ea82f47b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a225e907393c46b20bbed09e1a6a48e6d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_executor.xhtml#a225e907393c46b20bbed09e1a6a48e6d">PrintNetworkInfo</a> ()=0</td></tr> +<tr class="memdesc:a225e907393c46b20bbed09e1a6a48e6d"><td class="mdescLeft"> </td><td class="mdescRight">Print available information about the network. <a href="#a225e907393c46b20bbed09e1a6a48e6d">More...</a><br /></td></tr> +<tr class="separator:a225e907393c46b20bbed09e1a6a48e6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa5ca9ff9e89dbc47623206d4e7b98376"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_executor.xhtml#aa5ca9ff9e89dbc47623206d4e7b98376">CompareAndPrintResult</a> (std::vector< const void *> otherOutput)=0</td></tr> +<tr class="memdesc:aa5ca9ff9e89dbc47623206d4e7b98376"><td class="mdescLeft"> </td><td class="mdescRight">Compare the output with the result of another <a class="el" href="class_i_executor.xhtml" title="IExecutor executes a network. ">IExecutor</a>. <a href="#aa5ca9ff9e89dbc47623206d4e7b98376">More...</a><br /></td></tr> +<tr class="separator:aa5ca9ff9e89dbc47623206d4e7b98376"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a35ce388d080edd9b1fc52dd91cf80deb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_executor.xhtml#a35ce388d080edd9b1fc52dd91cf80deb">~IExecutor</a> ()</td></tr> +<tr class="separator:a35ce388d080edd9b1fc52dd91cf80deb"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="class_i_executor.xhtml" title="IExecutor executes a network. ">IExecutor</a> executes a network. </p> + +<p class="definition">Definition at line <a class="el" href="_i_executor_8hpp_source.xhtml#l00010">10</a> of file <a class="el" href="_i_executor_8hpp_source.xhtml">IExecutor.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a35ce388d080edd9b1fc52dd91cf80deb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a35ce388d080edd9b1fc52dd91cf80deb">◆ </a></span>~IExecutor()</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="class_i_executor.xhtml">IExecutor</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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_executor_8hpp_source.xhtml#l00021">21</a> of file <a class="el" href="_i_executor_8hpp_source.xhtml">IExecutor.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {};</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aa5ca9ff9e89dbc47623206d4e7b98376"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa5ca9ff9e89dbc47623206d4e7b98376">◆ </a></span>CompareAndPrintResult()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void CompareAndPrintResult </td> + <td>(</td> + <td class="paramtype">std::vector< const void *> </td> + <td class="paramname"><em>otherOutput</em></td><td>)</td> + <td></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>Compare the output with the result of another <a class="el" href="class_i_executor.xhtml" title="IExecutor executes a network. ">IExecutor</a>. </p> + +<p>Implemented in <a class="el" href="class_arm_n_n_executor.xhtml#ac65a3d900d923c4582e059c2281e70e3">ArmNNExecutor</a>, and <a class="el" href="class_tf_lite_executor.xhtml#ac65a3d900d923c4582e059c2281e70e3">TfLiteExecutor</a>.</p> + +</div> +</div> +<a id="ab11f3f9cae37ecd9f9760d5ea82f47b3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab11f3f9cae37ecd9f9760d5ea82f47b3">◆ </a></span>Execute()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::vector<const void*> Execute </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></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>Execute the given network. </p> +<dl class="section return"><dt>Returns</dt><dd>std::vector<const void*> A type erased vector of the outputs, that can be compared with the output of another <a class="el" href="class_i_executor.xhtml" title="IExecutor executes a network. ">IExecutor</a> </dd></dl> + +<p>Implemented in <a class="el" href="class_arm_n_n_executor.xhtml#a7b274ddaba15738d696359ad327a88ca">ArmNNExecutor</a>, and <a class="el" href="class_tf_lite_executor.xhtml#a7b274ddaba15738d696359ad327a88ca">TfLiteExecutor</a>.</p> + +</div> +</div> +<a id="a225e907393c46b20bbed09e1a6a48e6d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a225e907393c46b20bbed09e1a6a48e6d">◆ </a></span>PrintNetworkInfo()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void PrintNetworkInfo </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></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>Print available information about the network. </p> + +<p>Implemented in <a class="el" href="class_arm_n_n_executor.xhtml#a21887e76c6b67797ada411a163d81a62">ArmNNExecutor</a>, and <a class="el" href="class_tf_lite_executor.xhtml#a21887e76c6b67797ada411a163d81a62">TfLiteExecutor</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>tests/ExecuteNetwork/<a class="el" href="_i_executor_8hpp_source.xhtml">IExecutor.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="class_i_executor.xhtml">IExecutor</a></li> + <li class="footer">Generated on Fri Aug 19 2022 14:38:36 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> |