| <!-- 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: utils/command_line/Option.h Source File</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">20.02.1</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('_option_8h_source.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="headertitle"> |
| <div class="title">Option.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_option_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2017-2018 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef ARM_COMPUTE_UTILS_OPTIONBASE</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define ARM_COMPUTE_UTILS_OPTIONBASE</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>utils</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {<span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/** Abstract base class for a command line option. */</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml"> 34</a></span> <span class="keyword">class </span><a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml">Option</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /** Constructor.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param[in] name Name of the option.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a>(std::string <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /** Constructor.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @param[in] name Name of the option.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @param[in] is_required Is the option required?</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @param[in] is_set Has a value been assigned to the option?</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option</a>(std::string <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>, <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>, <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /** Default destructor. */</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">~Option</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /** Parses the given string.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @param[in] value String representation as passed on the command line.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> *</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @return True if the value could be parsed by the specific subclass.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">parse</a>(std::string value) = 0;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /** Help message for the option.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return String representing the help message for the specific subclass.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> */</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> std::string <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /** Name of the option.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> *</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * @return Name of the option.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::string <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171">name</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /** Set whether the option is required.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> *</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @param[in] is_required Pass true if the option is required.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> */</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">set_required</a>(<span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> /** Set the help message for the option.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @param[in] help Option specific help message.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">set_help</a>(std::string <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a6d472b4309f5558f94258fabeff3474e">help</a>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /** Is the option required?</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @return True if the option is required.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> */</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5">is_required</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> /** Has a value been assigned to the option?</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @return True if a value has been set.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74">is_set</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::string _name;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> _is_required{ <span class="keyword">false</span> };</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">bool</span> _is_set{ <span class="keyword">false</span> };</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::string _help{};</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf"> 105</a></span> <span class="keyword">inline</span> <a class="code" href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">Option::Option</a>(std::string name)</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  : _name{ std::move(name) }</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="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_simple_option.xhtml#a6340a62771cbbb113fccaf3425f2ae48"> 110</a></span> <span class="keyword">inline</span> Option::Option(std::string name, <span class="keywordtype">bool</span> is_required, <span class="keywordtype">bool</span> is_set)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  : _name{ std::move(name) }, _is_required{ is_required }, _is_set{ is_set }</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="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml#a1d89c28bd42ba9a52da008bb69367171"> 115</a></span> <span class="keyword">inline</span> std::string Option::name()<span class="keyword"> const</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword"></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 class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b"> 120</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> Option::set_required(<span class="keywordtype">bool</span> is_required)</div><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 = is_required;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37"> 125</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> Option::set_help(std::string <a class="code" href="namespace_gemm_tuner.xhtml#a81ae9faedaa69e3e28e2960a0548df8d">help</a>)</div><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="namespace_gemm_tuner.xhtml#a81ae9faedaa69e3e28e2960a0548df8d">help</a>);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml#ae5fcbfe1e97213aae098a4c0dc48ffe5"> 130</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> Option::is_required()<span class="keyword"> const</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keyword"></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 class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classarm__compute_1_1utils_1_1_option.xhtml#a8d75095e0ce4d0cc3ed6bc4733664a74"> 135</a></span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> Option::is_set()<span class="keyword"> const</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword"></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 class="line"><a name="l00139"></a><span class="lineno"> 139</span> } <span class="comment">// namespace utils</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> } <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_UTILS_OPTIONBASE */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml">arm_compute::utils::Option</a></div><div class="ttdoc">Abstract base class for a command line option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00034">Option.h:34</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a1adbcecf58804b109b928dd852bc29ef"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a1adbcecf58804b109b928dd852bc29ef">arm_compute::utils::Option::parse</a></div><div class="ttdeci">virtual bool parse(std::string value)=0</div><div class="ttdoc">Parses the given string.</div></div> |
| <div class="ttc" id="namespace_gemm_tuner_xhtml_a81ae9faedaa69e3e28e2960a0548df8d"><div class="ttname"><a href="namespace_gemm_tuner.xhtml#a81ae9faedaa69e3e28e2960a0548df8d">GemmTuner.help</a></div><div class="ttdeci">help</div><div class="ttdef"><b>Definition:</b> <a href="_gemm_tuner_8py_source.xhtml#l00528">GemmTuner.py:528</a></div></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 class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2020 ARM Limited.</div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></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_af340fed9faa9f79d3bf2e385c50d1ca0"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#af340fed9faa9f79d3bf2e385c50d1ca0">arm_compute::utils::Option::~Option</a></div><div class="ttdeci">virtual ~Option()=default</div><div class="ttdoc">Default destructor.</div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a564afafa4220cd36afbe388fcd24549b"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a564afafa4220cd36afbe388fcd24549b">arm_compute::utils::Option::set_required</a></div><div class="ttdeci">void set_required(bool is_required)</div><div class="ttdoc">Set whether the option is required.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00120">Option.h:120</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a8432d7cd1d4ea8732a64e9df51147cbf"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a8432d7cd1d4ea8732a64e9df51147cbf">arm_compute::utils::Option::Option</a></div><div class="ttdeci">Option(std::string name)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00105">Option.h:105</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 class="ttc" id="classarm__compute_1_1utils_1_1_option_xhtml_a48a2672f362eeed9a3e93403f4d3de37"><div class="ttname"><a href="classarm__compute_1_1utils_1_1_option.xhtml#a48a2672f362eeed9a3e93403f4d3de37">arm_compute::utils::Option::set_help</a></div><div class="ttdeci">void set_help(std::string help)</div><div class="ttdoc">Set the help message for the option.</div><div class="ttdef"><b>Definition:</b> <a href="_option_8h_source.xhtml#l00125">Option.h:125</a></div></div> |
| </div><!-- fragment --></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="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.xhtml">utils</a></li><li class="navelem"><a class="el" href="dir_7e20423ab48dcd11e2e5380033c0b7a2.xhtml">command_line</a></li><li class="navelem"><a class="el" href="_option_8h.xhtml">Option.h</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:07:06 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> |
