blob: 753f63e162c38965c2917aec5da95c7dff1fa9f5 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.9.1-->
<!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.11"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: ValidationProgramOptions 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);
$(window).load(resizeHeight);
</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/javascript">
$(document).ready(function() { init_search(); });
</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" />
</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;">
<td style="padding-left: 0.5em;">
<div id="projectname">Compute Library
&#160;<span id="projectnumber">v17.06</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
<li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
<li><a href="files.xhtml"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
</ul>
</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('classarm__compute_1_1test_1_1validation_1_1_validation_program_options.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> </div>
<div class="headertitle">
<div class="title">ValidationProgramOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Subclass of <a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml">ProgramOptions</a> that adds validation specific options.
<a href="classarm__compute_1_1test_1_1validation_1_1_validation_program_options.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_validation_program_options_8h_source.xhtml">ValidationProgramOptions.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ValidationProgramOptions:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1test_1_1validation_1_1_validation_program_options__coll__graph.svg" width="184" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></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:a8f7ec5ec56f63fc1ab7f7452cf4aaf91"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_validation_program_options.xhtml#a8f7ec5ec56f63fc1ab7f7452cf4aaf91">ValidationProgramOptions</a> ()</td></tr>
<tr class="memdesc:a8f7ec5ec56f63fc1ab7f7452cf4aaf91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines additonal options. <a href="#a8f7ec5ec56f63fc1ab7f7452cf4aaf91">More...</a><br /></td></tr>
<tr class="separator:a8f7ec5ec56f63fc1ab7f7452cf4aaf91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarm__compute_1_1test_1_1_program_options"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1test_1_1_program_options')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml">ProgramOptions</a></td></tr>
<tr class="memitem:a263a38a1c179c73585830a0b0c1b100c inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#a263a38a1c179c73585830a0b0c1b100c">ProgramOptions</a> ()</td></tr>
<tr class="memdesc:a263a38a1c179c73585830a0b0c1b100c inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines available options. <a href="#a263a38a1c179c73585830a0b0c1b100c">More...</a><br /></td></tr>
<tr class="separator:a263a38a1c179c73585830a0b0c1b100c inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a468383228eb02136468e91be3663ec8b inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#a468383228eb02136468e91be3663ec8b">wants_help</a> () const </td></tr>
<tr class="memdesc:a468383228eb02136468e91be3663ec8b inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals if the &ndash;help flag has been passed on the commandline. <a href="#a468383228eb02136468e91be3663ec8b">More...</a><br /></td></tr>
<tr class="separator:a468383228eb02136468e91be3663ec8b inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b576b0164ac6ad02b26f8b5b01575ba inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#a9b576b0164ac6ad02b26f8b5b01575ba">get_help</a> () const </td></tr>
<tr class="memdesc:a9b576b0164ac6ad02b26f8b5b01575ba inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string describing all available options. <a href="#a9b576b0164ac6ad02b26f8b5b01575ba">More...</a><br /></td></tr>
<tr class="separator:a9b576b0164ac6ad02b26f8b5b01575ba inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24d4b7fe84e05687b4c390ed8096b8a inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#ae24d4b7fe84e05687b4c390ed8096b8a">parse_commandline</a> (int argc, char **argv)</td></tr>
<tr class="memdesc:ae24d4b7fe84e05687b4c390ed8096b8a inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given arguments and makes them available via <a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#ad9477503abc6ea34d01994c663261cc7">get</a>. <a href="#ae24d4b7fe84e05687b4c390ed8096b8a">More...</a><br /></td></tr>
<tr class="separator:ae24d4b7fe84e05687b4c390ed8096b8a inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9477503abc6ea34d01994c663261cc7 inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ad9477503abc6ea34d01994c663261cc7 inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml#ad9477503abc6ea34d01994c663261cc7">get</a> (const std::string &amp;name, T &amp;value) const </td></tr>
<tr class="memdesc:ad9477503abc6ea34d01994c663261cc7 inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets <code>value</code> if it has been specified on the command line. <a href="#ad9477503abc6ea34d01994c663261cc7">More...</a><br /></td></tr>
<tr class="separator:ad9477503abc6ea34d01994c663261cc7 inherit pub_methods_classarm__compute_1_1test_1_1_program_options"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Subclass of <a class="el" href="classarm__compute_1_1test_1_1_program_options.xhtml">ProgramOptions</a> that adds validation specific options. </p>
<p>Definition at line <a class="el" href="_validation_program_options_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_validation_program_options_8h_source.xhtml">ValidationProgramOptions.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8f7ec5ec56f63fc1ab7f7452cf4aaf91"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_validation_program_options.xhtml">ValidationProgramOptions</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines additonal options. </p>
<p>Definition at line <a class="el" href="_validation_program_options_8cpp_source.xhtml#l00041">41</a> of file <a class="el" href="_validation_program_options_8cpp_source.xhtml">ValidationProgramOptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; boost::program_options::options_description options(<span class="stringliteral">&quot;Validation options&quot;</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; options.add_options()(<span class="stringliteral">&quot;runs&quot;</span>, boost::program_options::value&lt;unsigned int&gt;()-&gt;default_value(1), <span class="stringliteral">&quot;Repetitions per test&quot;</span>);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; options.add_options()(<span class="stringliteral">&quot;threads&quot;</span>, boost::program_options::value&lt;unsigned int&gt;()-&gt;default_value(std::thread::hardware_concurrency()), <span class="stringliteral">&quot;Number of parallel CPU threads&quot;</span>);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; add_options(options);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>tests/validation/<a class="el" href="_validation_program_options_8h_source.xhtml">ValidationProgramOptions.h</a></li>
<li>tests/validation/<a class="el" href="_validation_program_options_8cpp_source.xhtml">ValidationProgramOptions.cpp</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_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml">validation</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1validation_1_1_validation_program_options.xhtml">ValidationProgramOptions</a></li>
<li class="footer">Generated on Fri Jun 23 2017 15:44:36 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>