| <!-- 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: Option 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_option.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">Option Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Abstract base class for a command line option. |
| <a href="classarm__compute_1_1utils_1_1_option.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_option_8h_source.xhtml">Option.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:a8432d7cd1d4ea8732a64e9df51147cbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>)</td></tr> |
| <tr class="memdesc:a8432d7cd1d4ea8732a64e9df51147cbf"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a8432d7cd1d4ea8732a64e9df51147cbf">More...</a><br /></td></tr> |
| <tr class="separator:a8432d7cd1d4ea8732a64e9df51147cbf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6340a62771cbbb113fccaf3425f2ae48"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48">Option</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>)</td></tr> |
| <tr class="memdesc:a6340a62771cbbb113fccaf3425f2ae48"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6340a62771cbbb113fccaf3425f2ae48">More...</a><br /></td></tr> |
| <tr class="separator:a6340a62771cbbb113fccaf3425f2ae48"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af340fed9faa9f79d3bf2e385c50d1ca0"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">~Option</a> ()=default</td></tr> |
| <tr class="memdesc:af340fed9faa9f79d3bf2e385c50d1ca0"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#af340fed9faa9f79d3bf2e385c50d1ca0">More...</a><br /></td></tr> |
| <tr class="separator:af340fed9faa9f79d3bf2e385c50d1ca0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1adbcecf58804b109b928dd852bc29ef"><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_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">parse</a> (std::string value)=0</td></tr> |
| <tr class="memdesc:a1adbcecf58804b109b928dd852bc29ef"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string. <a href="#a1adbcecf58804b109b928dd852bc29ef">More...</a><br /></td></tr> |
| <tr class="separator:a1adbcecf58804b109b928dd852bc29ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d472b4309f5558f94258fabeff3474e"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a> () const =0</td></tr> |
| <tr class="memdesc:a6d472b4309f5558f94258fabeff3474e"><td class="mdescLeft"> </td><td class="mdescRight">Help message for the option. <a href="#a6d472b4309f5558f94258fabeff3474e">More...</a><br /></td></tr> |
| <tr class="separator:a6d472b4309f5558f94258fabeff3474e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d89c28bd42ba9a52da008bb69367171"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr> |
| <tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171"><td class="mdescLeft"> </td><td class="mdescRight">Name of the option. <a href="#a1d89c28bd42ba9a52da008bb69367171">More...</a><br /></td></tr> |
| <tr class="separator:a1d89c28bd42ba9a52da008bb69367171"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a564afafa4220cd36afbe388fcd24549b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">set_required</a> (bool <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>)</td></tr> |
| <tr class="memdesc:a564afafa4220cd36afbe388fcd24549b"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the option is required. <a href="#a564afafa4220cd36afbe388fcd24549b">More...</a><br /></td></tr> |
| <tr class="separator:a564afafa4220cd36afbe388fcd24549b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48a2672f362eeed9a3e93403f4d3de37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">set_help</a> (std::string <a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>)</td></tr> |
| <tr class="memdesc:a48a2672f362eeed9a3e93403f4d3de37"><td class="mdescLeft"> </td><td class="mdescRight">Set the help message for the option. <a href="#a48a2672f362eeed9a3e93403f4d3de37">More...</a><br /></td></tr> |
| <tr class="separator:a48a2672f362eeed9a3e93403f4d3de37"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5fcbfe1e97213aae098a4c0dc48ffe5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a> () const</td></tr> |
| <tr class="memdesc:ae5fcbfe1e97213aae098a4c0dc48ffe5"><td class="mdescLeft"> </td><td class="mdescRight">Is the option required? <a href="#ae5fcbfe1e97213aae098a4c0dc48ffe5">More...</a><br /></td></tr> |
| <tr class="separator:ae5fcbfe1e97213aae098a4c0dc48ffe5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d75095e0ce4d0cc3ed6bc4733664a74"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a> () const</td></tr> |
| <tr class="memdesc:a8d75095e0ce4d0cc3ed6bc4733664a74"><td class="mdescLeft"> </td><td class="mdescRight">Has a value been assigned to the option? <a href="#a8d75095e0ce4d0cc3ed6bc4733664a74">More...</a><br /></td></tr> |
| <tr class="separator:a8d75095e0ce4d0cc3ed6bc4733664a74"><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 base class for a command line option. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a8432d7cd1d4ea8732a64e9df51147cbf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8432d7cd1d4ea8732a64e9df51147cbf">◆ </a></span>Option() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml">Option</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00105">105</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  : _name{ std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>) }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a6340a62771cbbb113fccaf3425f2ae48"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6340a62771cbbb113fccaf3425f2ae48">◆ </a></span>Option() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml">Option</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_required</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_set</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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the option. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">is_required</td><td>Is the option required? </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">is_set</td><td>Has a value been assigned to the option? </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00110">110</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  : _name{ std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>) }, _is_required{ <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a> }, _is_set{ <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a> }</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1d89c28bd42ba9a52da008bb69367171"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">arm_compute::utils::Option::name</a></div><div class="ttdeci">std::string name() const</div><div class="ttdoc">Name of the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00115">Option.h:115</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_ae5fcbfe1e97213aae098a4c0dc48ffe5"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">arm_compute::utils::Option::is_required</a></div><div class="ttdeci">bool is_required() const</div><div class="ttdoc">Is the option required?</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00130">Option.h:130</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a8d75095e0ce4d0cc3ed6bc4733664a74"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">arm_compute::utils::Option::is_set</a></div><div class="ttdeci">bool is_set() const</div><div class="ttdoc">Has a value been assigned to the option?</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00135">Option.h:135</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <a id="af340fed9faa9f79d3bf2e385c50d1ca0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af340fed9faa9f79d3bf2e385c50d1ca0">◆ </a></span>~Option()</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_option.xhtml">Option</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="a6d472b4309f5558f94258fabeff3474e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6d472b4309f5558f94258fabeff3474e">◆ </a></span>help()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string help </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Help message for the option. </p> |
| <dl class="section return"><dt>Returns</dt><dd>String representing the help message for the specific subclass. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< LogFormat ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< std::string ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< arm_compute::CLTunerMode ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< arm_compute::graph::Target ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< unsigned int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< LogLevel ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< arm_compute::DataLayout ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< arm_compute::DataType ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">SimpleOption< bool ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_list_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumListOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_list_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumListOption< InstrumentsDescription ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< LogFormat ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< arm_compute::graph::Target ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< LogLevel ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< arm_compute::DataLayout ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">EnumOption< arm_compute::DataType ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_list_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">ListOption< T ></a>, and <a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#ae6038fe1a77c4b08a678530410f41efa">ToggleOption</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae5fcbfe1e97213aae098a4c0dc48ffe5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae5fcbfe1e97213aae098a4c0dc48ffe5">◆ </a></span>is_required()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool is_required </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Is the option required? </p> |
| <dl class="section return"><dt>Returns</dt><dd>True if the option is required. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00130">130</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> _is_required;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a8d75095e0ce4d0cc3ed6bc4733664a74"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8d75095e0ce4d0cc3ed6bc4733664a74">◆ </a></span>is_set()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool is_set </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Has a value been assigned to the option? </p> |
| <dl class="section return"><dt>Returns</dt><dd>True if a value has been set. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00135">135</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> {</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">return</span> _is_set;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_common_graph_options_8cpp_source.xhtml#l00183">arm_compute::utils::consume_common_graph_parameters()</a>, <a class="el" href="_common_options_8cpp_source.xhtml#l00098">CommonOptions::create_printers()</a>, and <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a1d89c28bd42ba9a52da008bb69367171"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1d89c28bd42ba9a52da008bb69367171">◆ </a></span>name()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string name </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Name of the option. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Name of the option. </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00115">115</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> _name;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_toggle_option_8h_source.xhtml#l00076">ToggleOption::help()</a>, <a class="el" href="_list_option_8h_source.xhtml#l00067">ListOption< T >::ListOption()</a>, and <a class="el" href="_toggle_option_8h_source.xhtml#l00052">ToggleOption::ToggleOption()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a1adbcecf58804b109b928dd852bc29ef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1adbcecf58804b109b928dd852bc29ef">◆ </a></span>parse()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool parse </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses the given string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>String representation as passed on the command line.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if the value could be parsed by the specific subclass. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< LogFormat ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< std::string ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< arm_compute::CLTunerMode ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< arm_compute::graph::Target ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< unsigned int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< LogLevel ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< arm_compute::DataLayout ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< arm_compute::DataType ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#afeee88c6cc79c347f803741da7f325f0">SimpleOption< bool ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_list_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumListOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_list_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumListOption< InstrumentsDescription ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< LogFormat ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< arm_compute::graph::Target ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< LogLevel ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< arm_compute::DataLayout ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_enum_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">EnumOption< arm_compute::DataType ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< T ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< LogFormat ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< std::string ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< arm_compute::CLTunerMode ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< arm_compute::graph::Target ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< unsigned int ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< LogLevel ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< arm_compute::DataLayout ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< arm_compute::DataType ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">SimpleOption< bool ></a>, <a class="el" href="classarm__compute_1_1utils_1_1_list_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">ListOption< T ></a>, and <a class="el" href="classarm__compute_1_1utils_1_1_toggle_option.xhtml#aba9622f1f4bc66fcba246f30d4175a4f">ToggleOption</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a48a2672f362eeed9a3e93403f4d3de37"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a48a2672f362eeed9a3e93403f4d3de37">◆ </a></span>set_help()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_help </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>help</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the help message for the option. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">help</td><td><a class="el" href="classarm__compute_1_1utils_1_1_option.xhtml" title="Abstract base class for a command line option.">Option</a> specific help message. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00125">125</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> {</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  _help = std::move(<a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a6d472b4309f5558f94258fabeff3474e"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">arm_compute::utils::Option::help</a></div><div class="ttdeci">virtual std::string help() const =0</div><div class="ttdoc">Help message for the option.</div></div> |
| </div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_common_graph_options_8cpp_source.xhtml#l00115">CommonGraphOptions::CommonGraphOptions()</a>, <a class="el" href="_common_options_8cpp_source.xhtml#l00038">CommonOptions::CommonOptions()</a>, and <a class="el" href="main_8cpp_source.xhtml#l00090">main()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a564afafa4220cd36afbe388fcd24549b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a564afafa4220cd36afbe388fcd24549b">◆ </a></span>set_required()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_required </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>is_required</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set whether the option is required. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">is_required</td><td>Pass true if the option is required. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_option_8h_source.xhtml#l00120">120</a> of file <a class="el" href="_option_8h_source.xhtml">Option.h</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  _is_required = <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> }</div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_ae5fcbfe1e97213aae098a4c0dc48ffe5"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">arm_compute::utils::Option::is_required</a></div><div class="ttdeci">bool is_required() const</div><div class="ttdoc">Is the option required?</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00130">Option.h:130</a></div></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>utils/command_line/<a class="el" href="_option_8h_source.xhtml">Option.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_option.xhtml">Option</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> |
