| <!-- 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: Example 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&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"> |
|  <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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_example.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">Example Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Abstract <a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml" title="Abstract Example class.">Example</a> class. |
| <a href="classarm__compute_1_1utils_1_1_example.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>></code></p> |
| <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:ae678db013a8393ad2799a7de8b2b9304"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#ae678db013a8393ad2799a7de8b2b9304">do_setup</a> (int argc, char **argv)</td></tr> |
| <tr class="memdesc:ae678db013a8393ad2799a7de8b2b9304"><td class="mdescLeft"> </td><td class="mdescRight">Setup the example. <a href="#ae678db013a8393ad2799a7de8b2b9304">More...</a><br /></td></tr> |
| <tr class="separator:ae678db013a8393ad2799a7de8b2b9304"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#a90b4bc2c4bae857bc3536f4a18e29772">do_run</a> ()</td></tr> |
| <tr class="memdesc:a90b4bc2c4bae857bc3536f4a18e29772"><td class="mdescLeft"> </td><td class="mdescRight">Run the example. <a href="#a90b4bc2c4bae857bc3536f4a18e29772">More...</a><br /></td></tr> |
| <tr class="separator:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b3acd6be09cf86066760caaa89f7be5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#a9b3acd6be09cf86066760caaa89f7be5">do_teardown</a> ()</td></tr> |
| <tr class="memdesc:a9b3acd6be09cf86066760caaa89f7be5"><td class="mdescLeft"> </td><td class="mdescRight">Teardown the example. <a href="#a9b3acd6be09cf86066760caaa89f7be5">More...</a><br /></td></tr> |
| <tr class="separator:a9b3acd6be09cf86066760caaa89f7be5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afeec4c960afa54ec7a45c519ad87cf2b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#afeec4c960afa54ec7a45c519ad87cf2b">~Example</a> ()=default</td></tr> |
| <tr class="memdesc:afeec4c960afa54ec7a45c519ad87cf2b"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#afeec4c960afa54ec7a45c519ad87cf2b">More...</a><br /></td></tr> |
| <tr class="separator:afeec4c960afa54ec7a45c519ad87cf2b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Abstract <a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml" title="Abstract Example class.">Example</a> class. </p> |
| <p>All examples have to inherit from this class. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00070">70</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="afeec4c960afa54ec7a45c519ad87cf2b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afeec4c960afa54ec7a45c519ad87cf2b">◆ </a></span>~Example()</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="classarm__compute_1_1utils_1_1_example.xhtml">Example</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">virtual</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a90b4bc2c4bae857bc3536f4a18e29772"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a90b4bc2c4bae857bc3536f4a18e29772">◆ </a></span>do_run()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void do_run </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>Run the example. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00085">85</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> {};</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="ae678db013a8393ad2799a7de8b2b9304"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae678db013a8393ad2799a7de8b2b9304">◆ </a></span>do_setup()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool do_setup </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>argc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char ** </td> |
| <td class="paramname"><em>argv</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Setup the example. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">argc</td><td>Argument count. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">argv</td><td>Argument values.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True in case of no errors in setup else false </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00080">80</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  };</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a9b3acd6be09cf86066760caaa89f7be5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b3acd6be09cf86066760caaa89f7be5">◆ </a></span>do_teardown()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void do_teardown </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>Teardown the example. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00087">87</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> {};</div></div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>utils/<a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</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="namespacearm__compute_1_1utils.xhtml">utils</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml">Example</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:42 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> |