documentation/classarm__compute_1_1utils_1_1_example.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: Example Class Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1utils_1_1_example.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">Example Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Abstract <a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml" title="Abstract Example class. ">Example</a> class.
 126  <a href="classarm__compute_1_1utils_1_1_example.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:a96b30c1d1256c2ab3f731a162ad08609"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#a96b30c1d1256c2ab3f731a162ad08609">do_setup</a> (int argc, char **argv)</td></tr>
 133 <tr class="memdesc:a96b30c1d1256c2ab3f731a162ad08609"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the example.  <a href="#a96b30c1d1256c2ab3f731a162ad08609">More...</a><br /></td></tr>
 134 <tr class="separator:a96b30c1d1256c2ab3f731a162ad08609"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#a90b4bc2c4bae857bc3536f4a18e29772">do_run</a> ()</td></tr>
 136 <tr class="memdesc:a90b4bc2c4bae857bc3536f4a18e29772"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the example.  <a href="#a90b4bc2c4bae857bc3536f4a18e29772">More...</a><br /></td></tr>
 137 <tr class="separator:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a9b3acd6be09cf86066760caaa89f7be5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#a9b3acd6be09cf86066760caaa89f7be5">do_teardown</a> ()</td></tr>
 139 <tr class="memdesc:a9b3acd6be09cf86066760caaa89f7be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Teardown the example.  <a href="#a9b3acd6be09cf86066760caaa89f7be5">More...</a><br /></td></tr>
 140 <tr class="separator:a9b3acd6be09cf86066760caaa89f7be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:afeec4c960afa54ec7a45c519ad87cf2b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#afeec4c960afa54ec7a45c519ad87cf2b">~Example</a> ()=default</td></tr>
 142 <tr class="memdesc:afeec4c960afa54ec7a45c519ad87cf2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#afeec4c960afa54ec7a45c519ad87cf2b">More...</a><br /></td></tr>
 143 <tr class="separator:afeec4c960afa54ec7a45c519ad87cf2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 </table>
 145 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 146 <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>
 147 <p>All examples have to inherit from this class. </p>
 148
 149 <p>Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00062">62</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p>
 150 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 151 <a class="anchor" id="afeec4c960afa54ec7a45c519ad87cf2b"></a>
 152 <div class="memitem">
 153 <div class="memproto">
 154 <table class="mlabels">
 155   <tr>
 156   <td class="mlabels-left">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml">Example</a> </td>
 160           <td>(</td>
 161           <td class="paramname"></td><td>)</td>
 162           <td></td>
 163         </tr>
 164       </table>
 165   </td>
 166   <td class="mlabels-right">
 167 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 168   </tr>
 169 </table>
 170 </div><div class="memdoc">
 171
 172 <p>Default destructor. </p>
 173
 174 <p>Referenced by <a class="el" href="utils_2_utils_8h_source.xhtml#l00074">Example::do_teardown()</a>.</p>
 175
 176 </div>
 177 </div>
 178 <h2 class="groupheader">Member Function Documentation</h2>
 179 <a class="anchor" id="a90b4bc2c4bae857bc3536f4a18e29772"></a>
 180 <div class="memitem">
 181 <div class="memproto">
 182 <table class="mlabels">
 183   <tr>
 184   <td class="mlabels-left">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">virtual void do_run </td>
 188           <td>(</td>
 189           <td class="paramname"></td><td>)</td>
 190           <td></td>
 191         </tr>
 192       </table>
 193   </td>
 194   <td class="mlabels-right">
 195 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
 196   </tr>
 197 </table>
 198 </div><div class="memdoc">
 199
 200 <p>Run the example. </p>
 201
 202 <p>Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00072">72</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p>
 203 <div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{};</div></div><!-- fragment -->
 204 </div>
 205 </div>
 206 <a class="anchor" id="a96b30c1d1256c2ab3f731a162ad08609"></a>
 207 <div class="memitem">
 208 <div class="memproto">
 209 <table class="mlabels">
 210   <tr>
 211   <td class="mlabels-left">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">virtual void do_setup </td>
 215           <td>(</td>
 216           <td class="paramtype">int&#160;</td>
 217           <td class="paramname"><em>argc</em>, </td>
 218         </tr>
 219         <tr>
 220           <td class="paramkey"></td>
 221           <td></td>
 222           <td class="paramtype">char **&#160;</td>
 223           <td class="paramname"><em>argv</em>&#160;</td>
 224         </tr>
 225         <tr>
 226           <td></td>
 227           <td>)</td>
 228           <td></td><td></td>
 229         </tr>
 230       </table>
 231   </td>
 232   <td class="mlabels-right">
 233 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
 234   </tr>
 235 </table>
 236 </div><div class="memdoc">
 237
 238 <p>Setup the example. </p>
 239 <dl class="params"><dt>Parameters</dt><dd>
 240   <table class="params">
 241     <tr><td class="paramdir">[in]</td><td class="paramname">argc</td><td>Argument count. </td></tr>
 242     <tr><td class="paramdir">[in]</td><td class="paramname">argv</td><td>Argument values. </td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246
 247 <p>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>
 248 <div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;{};</div></div><!-- fragment -->
 249 </div>
 250 </div>
 251 <a class="anchor" id="a9b3acd6be09cf86066760caaa89f7be5"></a>
 252 <div class="memitem">
 253 <div class="memproto">
 254 <table class="mlabels">
 255   <tr>
 256   <td class="mlabels-left">
 257       <table class="memname">
 258         <tr>
 259           <td class="memname">virtual void do_teardown </td>
 260           <td>(</td>
 261           <td class="paramname"></td><td>)</td>
 262           <td></td>
 263         </tr>
 264       </table>
 265   </td>
 266   <td class="mlabels-right">
 267 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
 268   </tr>
 269 </table>
 270 </div><div class="memdoc">
 271
 272 <p>Teardown the example. </p>
 273
 274 <p>Definition at line <a class="el" href="utils_2_utils_8h_source.xhtml#l00074">74</a> of file <a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a>.</p>
 275
 276 <p>References <a class="el" href="utils_2_utils_8cpp_source.xhtml#l00070">arm_compute::utils::run_example()</a>, and <a class="el" href="classarm__compute_1_1utils_1_1_example.xhtml#afeec4c960afa54ec7a45c519ad87cf2b">Example::~Example()</a>.</p>
 277 <div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;{};</div></div><!-- fragment -->
 278 </div>
 279 </div>
 280 <hr/>The documentation for this class was generated from the following file:<ul>
 281 <li>utils/<a class="el" href="utils_2_utils_8h_source.xhtml">Utils.h</a></li>
 282 </ul>
 283 </div><!-- contents -->
 284 </div><!-- doc-content -->
 285 <!-- start footer part -->
 286 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 287   <ul>
 288     <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>
 289     <li class="footer">Generated on Wed May 23 2018 11:36:45 for Compute Library by
 290     <a href="http://www.doxygen.org/index.html">
 291     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 292   </ul>
 293 </div>
 294 </body>
 295 </html>