Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 549b9600a6eaf0727fa084465a75f173edf8f381 / . / 22.05 / _cxxopts_utils_8hpp.xhtml
blob: 780544b25e2be739d3321a9fa55784fbcda99368 [file] [log] [blame]
Nikhil Raj549b9602022-05-24 11:32:07 +0100[diff] [blame^]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: tests/CxxoptsUtils.hpp File Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">22.05</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('_cxxopts_utils_8hpp.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#func-members">Functions</a> </div>
99 <div class="headertitle">
100<div class="title">CxxoptsUtils.hpp File Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103<div class="textblock"><code>#include &lt;cxxopts/cxxopts.hpp&gt;</code><br />
104</div>
105<p><a href="_cxxopts_utils_8hpp_source.xhtml">Go to the source code of this file.</a></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
108Functions</h2></td></tr>
109<tr class="memitem:a54dc0f90125fe080b8d0c503e542ca77"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_cxxopts_utils_8hpp.xhtml#a54dc0f90125fe080b8d0c503e542ca77">CheckRequiredOptions</a> (const cxxopts::ParseResult &amp;result, const std::vector&lt; std::string &gt; &amp;required)</td></tr>
110<tr class="memdesc:a54dc0f90125fe080b8d0c503e542ca77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ensure all mandatory command-line parameters have been passed to cxxopts. <a href="#a54dc0f90125fe080b8d0c503e542ca77">More...</a><br /></td></tr>
111<tr class="separator:a54dc0f90125fe080b8d0c503e542ca77"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table>
113<h2 class="groupheader">Function Documentation</h2>
114<a id="a54dc0f90125fe080b8d0c503e542ca77"></a>
115<h2 class="memtitle"><span class="permalink"><a href="#a54dc0f90125fe080b8d0c503e542ca77">&#9670;&nbsp;</a></span>CheckRequiredOptions()</h2>
116
117<div class="memitem">
118<div class="memproto">
119<table class="mlabels">
120 <tr>
121 <td class="mlabels-left">
122 <table class="memname">
123 <tr>
124 <td class="memname">bool CheckRequiredOptions </td>
125 <td>(</td>
126 <td class="paramtype">const cxxopts::ParseResult &amp;&#160;</td>
127 <td class="paramname"><em>result</em>, </td>
128 </tr>
129 <tr>
130 <td class="paramkey"></td>
131 <td></td>
132 <td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
133 <td class="paramname"><em>required</em>&#160;</td>
134 </tr>
135 <tr>
136 <td></td>
137 <td>)</td>
138 <td></td><td></td>
139 </tr>
140 </table>
141 </td>
142 <td class="mlabels-right">
143<span class="mlabels"><span class="mlabel">inline</span></span> </td>
144 </tr>
145</table>
146</div><div class="memdoc">
147
148<p>Ensure all mandatory command-line parameters have been passed to cxxopts. </p>
149<dl class="params"><dt>Parameters</dt><dd>
150 <table class="params">
151 <tr><td class="paramname">result</td><td>returned from the cxxopts parse(argc, argv) call </td></tr>
152 <tr><td class="paramname">required</td><td>vector of strings listing the mandatory parameters to be input from the command-line </td></tr>
153 </table>
154 </dd>
155</dl>
156<dl class="section return"><dt>Returns</dt><dd>boolean value - true if all required parameters satisfied, false otherwise </dd></dl>
157
158<p class="definition">Definition at line <a class="el" href="_cxxopts_utils_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_cxxopts_utils_8hpp_source.xhtml">CxxoptsUtils.hpp</a>.</p>
159
160<p class="reference">Referenced by <a class="el" href="_inference_test_8cpp_source.xhtml#l00028">armnn::test::ParseCommandLine()</a>.</p>
161<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">const</span> std::string&amp; str : required)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">if</span>(result.count(str) == 0)</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; std::cerr &lt;&lt; <span class="stringliteral">&quot;--&quot;</span> &lt;&lt; str &lt;&lt; <span class="stringliteral">&quot; parameter is mandatory&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; }</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;}</div></div><!-- fragment -->
162</div>
163</div>
164</div><!-- contents -->
165</div><!-- doc-content -->
166<!-- start footer part -->
167<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
168 <ul>
169 <li class="navelem"><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.xhtml">tests</a></li><li class="navelem"><a class="el" href="_cxxopts_utils_8hpp.xhtml">CxxoptsUtils.hpp</a></li>
170 <li class="footer">Generated on Tue May 24 2022 11:27:20 for ArmNN by
171 <a href="http://www.doxygen.org/index.html">
172 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
173 </ul>
174</div>
175</body>
176</html>