arm_compute v17.10
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1test_1_1framework_1_1_test_filter.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: TestFilter 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="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_1_test_filter.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">TestFilter Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
120 </div><!--header-->
121 <div class="contents">
122
123 <p>Test filter class.  
124  <a href="classarm__compute_1_1test_1_1framework_1_1_test_filter.xhtml#details">More...</a></p>
125
126 <p><code>#include &lt;<a class="el" href="_test_filter_8h_source.xhtml">TestFilter.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:a6c1c1828685702cd5b6a577d568d629c"><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_1_test_filter.xhtml#a6c1c1828685702cd5b6a577d568d629c">TestFilter</a> ()=default</td></tr>
131 <tr class="memdesc:a6c1c1828685702cd5b6a577d568d629c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a6c1c1828685702cd5b6a577d568d629c">More...</a><br/></td></tr>
132 <tr class="separator:a6c1c1828685702cd5b6a577d568d629c"><td class="memSeparator" colspan="2">&#160;</td></tr>
133 <tr class="memitem:acaae1b3a05dabc78c7086f863a3f93cf"><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_1_test_filter.xhtml#acaae1b3a05dabc78c7086f863a3f93cf">TestFilter</a> (<a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a> mode, const std::string &amp;name_filter, const std::string &amp;id_filter)</td></tr>
134 <tr class="memdesc:acaae1b3a05dabc78c7086f863a3f93cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#acaae1b3a05dabc78c7086f863a3f93cf">More...</a><br/></td></tr>
135 <tr class="separator:acaae1b3a05dabc78c7086f863a3f93cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
136 <tr class="memitem:ad4f8f3424c5f57e91d554e7e00a31fcf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_filter.xhtml#ad4f8f3424c5f57e91d554e7e00a31fcf">is_selected</a> (const <a class="el" href="structarm__compute_1_1test_1_1framework_1_1_test_info.xhtml">TestInfo</a> &amp;info) const </td></tr>
137 <tr class="memdesc:ad4f8f3424c5f57e91d554e7e00a31fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a test case is selected to be executed.  <a href="#ad4f8f3424c5f57e91d554e7e00a31fcf">More...</a><br/></td></tr>
138 <tr class="separator:ad4f8f3424c5f57e91d554e7e00a31fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 </table>
140 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141 <div class="textblock"><p>Test filter class. </p>
142 <p>Stores information about which test cases are selected for execution. Based on test name and test id. </p>
143
144 <p>Definition at line <a class="el" href="_test_filter_8h_source.xhtml#l00046">46</a> of file <a class="el" href="_test_filter_8h_source.xhtml">TestFilter.h</a>.</p>
145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
146 <a class="anchor" id="a6c1c1828685702cd5b6a577d568d629c"></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_1_test_filter.xhtml">TestFilter</a> </td>
155           <td>(</td>
156           <td class="paramname"></td><td>)</td>
157           <td></td>
158         </tr>
159       </table>
160   </td>
161   <td class="mlabels-right">
162 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
163   </tr>
164 </table>
165 </div><div class="memdoc">
166
167 <p>Default constructor. </p>
168 <p>All tests selected. </p>
169
170 </div>
171 </div>
172 <a class="anchor" id="acaae1b3a05dabc78c7086f863a3f93cf"></a>
173 <div class="memitem">
174 <div class="memproto">
175       <table class="memname">
176         <tr>
177           <td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_filter.xhtml">TestFilter</a> </td>
178           <td>(</td>
179           <td class="paramtype"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cf">DatasetMode</a>&#160;</td>
180           <td class="paramname"><em>mode</em>, </td>
181         </tr>
182         <tr>
183           <td class="paramkey"></td>
184           <td></td>
185           <td class="paramtype">const std::string &amp;&#160;</td>
186           <td class="paramname"><em>name_filter</em>, </td>
187         </tr>
188         <tr>
189           <td class="paramkey"></td>
190           <td></td>
191           <td class="paramtype">const std::string &amp;&#160;</td>
192           <td class="paramname"><em>id_filter</em>&#160;</td>
193         </tr>
194         <tr>
195           <td></td>
196           <td>)</td>
197           <td></td><td></td>
198         </tr>
199       </table>
200 </div><div class="memdoc">
201
202 <p>Constructor. </p>
203 <p>The id_filter string has be a comma separated list of test ids. ... can be used to include a range of tests. For instance, "..., 15" means all test up to and including 15, "3, 6, ..., 10" means tests 3 and 6 to 10, and "15, ..." means test 15 and all following.</p>
204 <dl class="params"><dt>Parameters</dt><dd>
205   <table class="params">
206     <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>Dataset mode. </td></tr>
207     <tr><td class="paramdir">[in]</td><td class="paramname">name_filter</td><td>Regular expression to filter tests by name. Only matching tests will be executed. </td></tr>
208     <tr><td class="paramdir">[in]</td><td class="paramname">id_filter</td><td>String to match selected test ids. Only matching tests will be executed. </td></tr>
209   </table>
210   </dd>
211 </dl>
212
213 <p>Definition at line <a class="el" href="_test_filter_8cpp_source.xhtml#l00038">38</a> of file <a class="el" href="_test_filter_8cpp_source.xhtml">TestFilter.cpp</a>.</p>
214 <div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    : _dataset_mode{ mode }, _name_filter{ name_filter }, _id_filter{ parse_id_filter(id_filter) }</div>
215 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;{</div>
216 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;}</div>
217 </div><!-- fragment -->
218 </div>
219 </div>
220 <h2 class="groupheader">Member Function Documentation</h2>
221 <a class="anchor" id="ad4f8f3424c5f57e91d554e7e00a31fcf"></a>
222 <div class="memitem">
223 <div class="memproto">
224       <table class="memname">
225         <tr>
226           <td class="memname">bool is_selected </td>
227           <td>(</td>
228           <td class="paramtype">const <a class="el" href="structarm__compute_1_1test_1_1framework_1_1_test_info.xhtml">TestInfo</a> &amp;&#160;</td>
229           <td class="paramname"><em>info</em></td><td>)</td>
230           <td> const</td>
231         </tr>
232       </table>
233 </div><div class="memdoc">
234
235 <p>Check if a test case is selected to be executed. </p>
236 <dl class="params"><dt>Parameters</dt><dd>
237   <table class="params">
238     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Test case info.</td></tr>
239   </table>
240   </dd>
241 </dl>
242 <dl class="section return"><dt>Returns</dt><dd>True if the test case is selected to be executed. </dd></dl>
243
244 <p>Definition at line <a class="el" href="_test_filter_8cpp_source.xhtml#l00043">43</a> of file <a class="el" href="_test_filter_8cpp_source.xhtml">TestFilter.cpp</a>.</p>
245
246 <p>References <a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cfa055c1a591abb0e8cd86dc969727bcc0b">arm_compute::test::framework::DISABLED</a>, <a class="el" href="_framework_8h_source.xhtml#l00068">TestInfo::id</a>, <a class="el" href="_framework_8h_source.xhtml#l00070">TestInfo::mode</a>, and <a class="el" href="_framework_8h_source.xhtml#l00069">TestInfo::name</a>.</p>
247
248 <p>Referenced by <a class="el" href="_framework_8cpp_source.xhtml#l00430">Framework::run()</a>, and <a class="el" href="_framework_8cpp_source.xhtml#l00535">Framework::test_infos()</a>.</p>
249 <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;{</div>
250 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordflow">if</span>((<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>.mode &amp; _dataset_mode) == <a class="code" href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cfa055c1a591abb0e8cd86dc969727bcc0b">DatasetMode::DISABLED</a>)</div>
251 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    {</div>
252 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
253 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    }</div>
254 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
255 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordflow">if</span>(!std::regex_search(<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>.name, _name_filter))</div>
256 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    {</div>
257 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
258 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    }</div>
259 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
260 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keywordflow">if</span>(!_id_filter.empty())</div>
261 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    {</div>
262 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keywordtype">bool</span> found = <span class="keyword">false</span>;</div>
263 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
264 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;        <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span> range : _id_filter)</div>
265 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        {</div>
266 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;            <span class="keywordflow">if</span>(range.first &lt;= <a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>.id &amp;&amp; <a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>.id &lt;= range.second)</div>
267 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;            {</div>
268 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;                found = <span class="keyword">true</span>;</div>
269 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;                <span class="keywordflow">break</span>;</div>
270 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;            }</div>
271 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        }</div>
272 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
273 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        <span class="keywordflow">if</span>(!found)</div>
274 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        {</div>
275 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
276 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        }</div>
277 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    }</div>
278 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
279 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
280 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;}</div>
281 <div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_a096668313a9a819d54a2e65ec21ff0cc"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info</a></div><div class="ttdeci">src info() -&gt; set_format(Format::S16)</div></div>
282 <div class="ttc" id="namespacearm__compute_1_1test_1_1framework_xhtml_a7edf31944a6144ffd493d2f9a7bfb5cfa055c1a591abb0e8cd86dc969727bcc0b"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1framework.xhtml#a7edf31944a6144ffd493d2f9a7bfb5cfa055c1a591abb0e8cd86dc969727bcc0b">arm_compute::test::framework::DatasetMode::DISABLED</a></div></div>
283 </div><!-- fragment -->
284 </div>
285 </div>
286 <hr/>The documentation for this class was generated from the following files:<ul>
287 <li>tests/framework/<a class="el" href="_test_filter_8h_source.xhtml">TestFilter.h</a></li>
288 <li>tests/framework/<a class="el" href="_test_filter_8cpp_source.xhtml">TestFilter.cpp</a></li>
289 </ul>
290 </div><!-- contents -->
291 </div><!-- doc-content -->
292 <!-- start footer part -->
293 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
294   <ul>
295     <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="classarm__compute_1_1test_1_1framework_1_1_test_filter.xhtml">TestFilter</a></li>
296     <li class="footer">Generated on Thu Oct 12 2017 14:26:38 for Compute Library by
297     <a href="http://www.doxygen.org/index.html">
298     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
299   </ul>
300 </div>
301 </body>
302 </html>