documentation/classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: TestCaseRegistrar&lt; T &gt; Class Template 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.10</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">TestCaseRegistrar&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Helper class to statically register a test case.
 124  <a href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_registrars_8h_source.xhtml">Registrars.h</a>&gt;</code></p>
 127 <table class="memberdecls">
 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 129 Public Member Functions</h2></td></tr>
 130 <tr class="memitem:a04917daee68d0de97571d85d56cb01b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml#a04917daee68d0de97571d85d56cb01b5">TestCaseRegistrar</a> (std::string test_name, <a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a> mode, <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case_factory.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">TestCaseFactory::Status</a> status)</td></tr>
 131 <tr class="memdesc:a04917daee68d0de97571d85d56cb01b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new test case with the given name to the framework.  <a href="#a04917daee68d0de97571d85d56cb01b5">More...</a><br/></td></tr>
 132 <tr class="separator:a04917daee68d0de97571d85d56cb01b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a085b203c4d33e00766b88d72e2d41ca9"><td class="memTemplParams" colspan="2">template&lt;typename D &gt; </td></tr>
 134 <tr class="memitem:a085b203c4d33e00766b88d72e2d41ca9"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml#a085b203c4d33e00766b88d72e2d41ca9">TestCaseRegistrar</a> (std::string test_name, <a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a> mode, <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case_factory.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">TestCaseFactory::Status</a> status, D &amp;&amp;dataset)</td></tr>
 135 <tr class="memdesc:a085b203c4d33e00766b88d72e2d41ca9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new data test case with the given name to the framework.  <a href="#a085b203c4d33e00766b88d72e2d41ca9">More...</a><br/></td></tr>
 136 <tr class="separator:a085b203c4d33e00766b88d72e2d41ca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 </table>
 138 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 139 <div class="textblock"><h3>template&lt;typename T&gt;<br/>
 140 class arm_compute::test::framework::detail::TestCaseRegistrar&lt; T &gt;</h3>
 141
 142 <p>Helper class to statically register a test case. </p>
 143
 144 <p>Definition at line <a class="el" href="_registrars_8h_source.xhtml#l00043">43</a> of file <a class="el" href="_registrars_8h_source.xhtml">Registrars.h</a>.</p>
 145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 146 <a class="anchor" id="a04917daee68d0de97571d85d56cb01b5"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml">TestCaseRegistrar</a> </td>
 155           <td>(</td>
 156           <td class="paramtype">std::string&#160;</td>
 157           <td class="paramname"><em>test_name</em>, </td>
 158         </tr>
 159         <tr>
 160           <td class="paramkey"></td>
 161           <td></td>
 162           <td class="paramtype"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a>&#160;</td>
 163           <td class="paramname"><em>mode</em>, </td>
 164         </tr>
 165         <tr>
 166           <td class="paramkey"></td>
 167           <td></td>
 168           <td class="paramtype"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case_factory.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">TestCaseFactory::Status</a>&#160;</td>
 169           <td class="paramname"><em>status</em>&#160;</td>
 170         </tr>
 171         <tr>
 172           <td></td>
 173           <td>)</td>
 174           <td></td><td></td>
 175         </tr>
 176       </table>
 177   </td>
 178   <td class="mlabels-right">
 179 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 180   </tr>
 181 </table>
 182 </div><div class="memdoc">
 183
 184 <p>Add a new test case with the given name to the framework. </p>
 185 <dl class="params"><dt>Parameters</dt><dd>
 186   <table class="params">
 187     <tr><td class="paramdir">[in]</td><td class="paramname">test_name</td><td>Name of the test case. </td></tr>
 188     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Mode in which the test should be activated. </td></tr>
 189     <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status of the test case. </td></tr>
 190   </table>
 191   </dd>
 192 </dl>
 193
 194 <p>Definition at line <a class="el" href="_registrars_8h_source.xhtml#l00080">80</a> of file <a class="el" href="_registrars_8h_source.xhtml">Registrars.h</a>.</p>
 195
 196 <p>References <a class="el" href="_framework_8h_source.xhtml#l00338">Framework::add_test_case()</a>, and <a class="el" href="_framework_8cpp_source.xhtml#l00079">Framework::get()</a>.</p>
 197 <div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;{</div>
 198 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#af8fbb8b386d3cce307a89002bcdbcfc9">Framework::get</a>().<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#ad8e7764125fcd790e0b151d26cfe949c">add_test_case</a>&lt;T&gt;(std::move(test_name), mode, status);</div>
 199 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;}</div>
 200 <div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_framework_xhtml_ad8e7764125fcd790e0b151d26cfe949c"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#ad8e7764125fcd790e0b151d26cfe949c">arm_compute::test::framework::Framework::add_test_case</a></div><div class="ttdeci">void add_test_case(std::string test_name, DatasetMode mode, TestCaseFactory::Status status)</div><div class="ttdoc">Add a test case to the framework. </div><div class="ttdef"><b>Definition:</b> <a href="_framework_8h_source.xhtml#l00338">Framework.h:338</a></div></div>
 201 <div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_framework_xhtml_af8fbb8b386d3cce307a89002bcdbcfc9"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#af8fbb8b386d3cce307a89002bcdbcfc9">arm_compute::test::framework::Framework::get</a></div><div class="ttdeci">static Framework &amp; get()</div><div class="ttdoc">Access to the singleton. </div><div class="ttdef"><b>Definition:</b> <a href="_framework_8cpp_source.xhtml#l00079">Framework.cpp:79</a></div></div>
 202 </div><!-- fragment -->
 203 </div>
 204 </div>
 205 <a class="anchor" id="a085b203c4d33e00766b88d72e2d41ca9"></a>
 206 <div class="memitem">
 207 <div class="memproto">
 208 <table class="mlabels">
 209   <tr>
 210   <td class="mlabels-left">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml">TestCaseRegistrar</a> </td>
 214           <td>(</td>
 215           <td class="paramtype">std::string&#160;</td>
 216           <td class="paramname"><em>test_name</em>, </td>
 217         </tr>
 218         <tr>
 219           <td class="paramkey"></td>
 220           <td></td>
 221           <td class="paramtype"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a>&#160;</td>
 222           <td class="paramname"><em>mode</em>, </td>
 223         </tr>
 224         <tr>
 225           <td class="paramkey"></td>
 226           <td></td>
 227           <td class="paramtype"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case_factory.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">TestCaseFactory::Status</a>&#160;</td>
 228           <td class="paramname"><em>status</em>, </td>
 229         </tr>
 230         <tr>
 231           <td class="paramkey"></td>
 232           <td></td>
 233           <td class="paramtype">D &amp;&amp;&#160;</td>
 234           <td class="paramname"><em>dataset</em>&#160;</td>
 235         </tr>
 236         <tr>
 237           <td></td>
 238           <td>)</td>
 239           <td></td><td></td>
 240         </tr>
 241       </table>
 242   </td>
 243   <td class="mlabels-right">
 244 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 245   </tr>
 246 </table>
 247 </div><div class="memdoc">
 248
 249 <p>Add a new data test case with the given name to the framework. </p>
 250 <dl class="params"><dt>Parameters</dt><dd>
 251   <table class="params">
 252     <tr><td class="paramdir">[in]</td><td class="paramname">test_name</td><td>Name of the test case. </td></tr>
 253     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Mode in which the test should be activated. </td></tr>
 254     <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status of the test case. </td></tr>
 255     <tr><td class="paramdir">[in]</td><td class="paramname">dataset</td><td>Dataset used as input for the test case. </td></tr>
 256   </table>
 257   </dd>
 258 </dl>
 259
 260 <p>Definition at line <a class="el" href="_registrars_8h_source.xhtml#l00087">87</a> of file <a class="el" href="_registrars_8h_source.xhtml">Registrars.h</a>.</p>
 261
 262 <p>References <a class="el" href="_framework_8h_source.xhtml#l00344">Framework::add_data_test_case()</a>, and <a class="el" href="_framework_8cpp_source.xhtml#l00079">Framework::get()</a>.</p>
 263 <div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;{</div>
 264 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    <span class="keyword">auto</span> it = dataset.begin();</div>
 265 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
 266 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i &lt; dataset.size(); ++i, ++it)</div>
 267 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    {</div>
 268 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;        <span class="comment">// WORKAROUND for GCC 4.9</span></div>
 269 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="comment">// The last argument should be *it to pass just the data and not the</span></div>
 270 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        <span class="comment">// iterator.</span></div>
 271 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#af8fbb8b386d3cce307a89002bcdbcfc9">Framework::get</a>().<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#aff39a3b89865624b6579d6980fb88654">add_data_test_case</a>&lt;T&gt;(test_name, mode, status, it.description(), it);</div>
 272 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    }</div>
 273 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;}</div>
 274 <div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_framework_xhtml_af8fbb8b386d3cce307a89002bcdbcfc9"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#af8fbb8b386d3cce307a89002bcdbcfc9">arm_compute::test::framework::Framework::get</a></div><div class="ttdeci">static Framework &amp; get()</div><div class="ttdoc">Access to the singleton. </div><div class="ttdef"><b>Definition:</b> <a href="_framework_8cpp_source.xhtml#l00079">Framework.cpp:79</a></div></div>
 275 <div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_framework_xhtml_aff39a3b89865624b6579d6980fb88654"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_framework.xhtml#aff39a3b89865624b6579d6980fb88654">arm_compute::test::framework::Framework::add_data_test_case</a></div><div class="ttdeci">void add_data_test_case(std::string test_name, DatasetMode mode, TestCaseFactory::Status status, std::string description, D &amp;&amp;data)</div><div class="ttdoc">Add a data test case to the framework. </div><div class="ttdef"><b>Definition:</b> <a href="_framework_8h_source.xhtml#l00344">Framework.h:344</a></div></div>
 276 </div><!-- fragment -->
 277 </div>
 278 </div>
 279 <hr/>The documentation for this class was generated from the following file:<ul>
 280 <li>tests/framework/<a class="el" href="_registrars_8h_source.xhtml">Registrars.h</a></li>
 281 </ul>
 282 </div><!-- contents -->
 283 </div><!-- doc-content -->
 284 <!-- start footer part -->
 285 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 286   <ul>
 287     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml">framework</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework_1_1detail.xhtml">detail</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1detail_1_1_test_case_registrar.xhtml">TestCaseRegistrar</a></li>
 288     <li class="footer">Generated on Thu Oct 12 2017 14:26:38 for Compute Library by
 289     <a href="http://www.doxygen.org/index.html">
 290     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 291   </ul>
 292 </div>
 293 </body>
 294 </html>