1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<!-- Copyright (c) 2020 ARM Limited. -->
<!-- -->
<!-- SPDX-License-Identifier: MIT -->
<!-- -->
<!-- HTML header for doxygen 1.8.13-->
<!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.13"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: tests/ExecuteNetwork/ExecuteNetworkProgramOptions.hpp 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">
$(document).ready(initResizable);
</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" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
 <span id="projectnumber">21.02</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('_execute_network_program_options_8hpp_source.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="headertitle">
<div class="title">ExecuteNetworkProgramOptions.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_execute_network_program_options_8hpp.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 © 2020 Arm Ltd and Contributors. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="_execute_network_params_8hpp.xhtml">ExecuteNetworkParams.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <<a class="code" href="_i_runtime_8hpp.xhtml">armnn/IRuntime.hpp</a>></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/*</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Historically we use the ',' character to separate dimensions in a tensor shape. However, cxxopts will read this</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * an an array of values which is fine until we have multiple tensors specified. This lumps the values of all shapes</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * together in a single array and we cannot break it up again. We'll change the vector delimiter to a '.'. We do this</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * as close as possible to the usage of cxxopts to avoid polluting other possible uses.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="_execute_network_program_options_8hpp.xhtml#a564e0c1dcc7d9a5202f36755f4fb07c7"> 17</a></span> <span class="preprocessor">#define CXXOPTS_VECTOR_DELIMITER '.'</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <cxxopts/cxxopts.hpp></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/// Holds and parses program options for the ExecuteNetwork application</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="struct_program_options.xhtml"> 21</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="struct_program_options.xhtml">ProgramOptions</a></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {<span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// Initializes ProgramOptions by adding options to the underlying cxxopts::options object.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// (Does not parse any options)</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> <a class="code" href="struct_program_options.xhtml#a263a38a1c179c73585830a0b0c1b100c">ProgramOptions</a>();</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// Runs ParseOptions() on initialization</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> <a class="code" href="struct_program_options.xhtml#a263a38a1c179c73585830a0b0c1b100c">ProgramOptions</a>(<span class="keywordtype">int</span> ac, <span class="keyword">const</span> <span class="keywordtype">char</span>* av[]);</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// Parses program options from the command line or another source and stores</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// the values in member variables. It also checks the validity of the parsed parameters.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// Throws a cxxopts exception if parsing fails or an armnn exception if parameters are not valid.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="struct_program_options.xhtml#a59cc301c978c454abd5ce1851a63e59e">ParseOptions</a>(<span class="keywordtype">int</span> ac, <span class="keyword">const</span> <span class="keywordtype">char</span>* av[]);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// Ensures that the parameters for ExecuteNetwork fit together</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="struct_program_options.xhtml#a2f256c5c35e40765ca21bc976230e724">ValidateExecuteNetworkParams</a>();</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// Ensures that the runtime options are valid</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="struct_program_options.xhtml#ab6758e6a48ebf606c8f6f4c43b7c9633">ValidateRuntimeOptions</a>();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="struct_program_options.xhtml#a527ff87c89c802951159885523c5e037"> 41</a></span>  cxxopts::Options <a class="code" href="struct_program_options.xhtml#a527ff87c89c802951159885523c5e037">m_CxxOptions</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="struct_program_options.xhtml#a16963a1c56b9300c949247c0cefe65ab"> 42</a></span>  cxxopts::ParseResult <a class="code" href="struct_program_options.xhtml#a16963a1c56b9300c949247c0cefe65ab">m_CxxResult</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="struct_program_options.xhtml#a85f77fe8adc087571402b9e204ad77dd"> 44</a></span>  <a class="code" href="struct_execute_network_params.xhtml">ExecuteNetworkParams</a> <a class="code" href="struct_program_options.xhtml#a85f77fe8adc087571402b9e204ad77dd">m_ExNetParams</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="struct_program_options.xhtml#a521b82f1467d6ede7a11db36f4d0823d"> 45</a></span>  <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml">armnn::IRuntime::CreationOptions</a> <a class="code" href="struct_program_options.xhtml#a521b82f1467d6ede7a11db36f4d0823d">m_RuntimeOptions</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> };</div><div class="ttc" id="struct_program_options_xhtml_a85f77fe8adc087571402b9e204ad77dd"><div class="ttname"><a href="struct_program_options.xhtml#a85f77fe8adc087571402b9e204ad77dd">ProgramOptions::m_ExNetParams</a></div><div class="ttdeci">ExecuteNetworkParams m_ExNetParams</div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8hpp_source.xhtml#l00044">ExecuteNetworkProgramOptions.hpp:44</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a527ff87c89c802951159885523c5e037"><div class="ttname"><a href="struct_program_options.xhtml#a527ff87c89c802951159885523c5e037">ProgramOptions::m_CxxOptions</a></div><div class="ttdeci">cxxopts::Options m_CxxOptions</div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8hpp_source.xhtml#l00041">ExecuteNetworkProgramOptions.hpp:41</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a2f256c5c35e40765ca21bc976230e724"><div class="ttname"><a href="struct_program_options.xhtml#a2f256c5c35e40765ca21bc976230e724">ProgramOptions::ValidateExecuteNetworkParams</a></div><div class="ttdeci">void ValidateExecuteNetworkParams()</div><div class="ttdoc">Ensures that the parameters for ExecuteNetwork fit together. </div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8cpp_source.xhtml#l00135">ExecuteNetworkProgramOptions.cpp:135</a></div></div>
<div class="ttc" id="_i_runtime_8hpp_xhtml"><div class="ttname"><a href="_i_runtime_8hpp.xhtml">IRuntime.hpp</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a521b82f1467d6ede7a11db36f4d0823d"><div class="ttname"><a href="struct_program_options.xhtml#a521b82f1467d6ede7a11db36f4d0823d">ProgramOptions::m_RuntimeOptions</a></div><div class="ttdeci">armnn::IRuntime::CreationOptions m_RuntimeOptions</div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8hpp_source.xhtml#l00045">ExecuteNetworkProgramOptions.hpp:45</a></div></div>
<div class="ttc" id="_execute_network_params_8hpp_xhtml"><div class="ttname"><a href="_execute_network_params_8hpp.xhtml">ExecuteNetworkParams.hpp</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a263a38a1c179c73585830a0b0c1b100c"><div class="ttname"><a href="struct_program_options.xhtml#a263a38a1c179c73585830a0b0c1b100c">ProgramOptions::ProgramOptions</a></div><div class="ttdeci">ProgramOptions()</div><div class="ttdoc">Initializes ProgramOptions by adding options to the underlying cxxopts::options object. </div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8cpp_source.xhtml#l00150">ExecuteNetworkProgramOptions.cpp:150</a></div></div>
<div class="ttc" id="struct_execute_network_params_xhtml"><div class="ttname"><a href="struct_execute_network_params.xhtml">ExecuteNetworkParams</a></div><div class="ttdoc">Holds all parameters necessary to execute a network Check ExecuteNetworkProgramOptions.cpp for a description of each parameter. </div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_params_8hpp_source.xhtml#l00013">ExecuteNetworkParams.hpp:13</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a59cc301c978c454abd5ce1851a63e59e"><div class="ttname"><a href="struct_program_options.xhtml#a59cc301c978c454abd5ce1851a63e59e">ProgramOptions::ParseOptions</a></div><div class="ttdeci">void ParseOptions(int ac, const char *av[])</div><div class="ttdoc">Parses program options from the command line or another source and stores the values in member variab...</div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8cpp_source.xhtml#l00368">ExecuteNetworkProgramOptions.cpp:368</a></div></div>
<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml">armnn::IRuntime::CreationOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00043">IRuntime.hpp:43</a></div></div>
<div class="ttc" id="struct_program_options_xhtml"><div class="ttname"><a href="struct_program_options.xhtml">ProgramOptions</a></div><div class="ttdoc">Holds and parses program options for the ExecuteNetwork application. </div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8hpp_source.xhtml#l00021">ExecuteNetworkProgramOptions.hpp:21</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_ab6758e6a48ebf606c8f6f4c43b7c9633"><div class="ttname"><a href="struct_program_options.xhtml#ab6758e6a48ebf606c8f6f4c43b7c9633">ProgramOptions::ValidateRuntimeOptions</a></div><div class="ttdeci">void ValidateRuntimeOptions()</div><div class="ttdoc">Ensures that the runtime options are valid. </div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8cpp_source.xhtml#l00140">ExecuteNetworkProgramOptions.cpp:140</a></div></div>
<div class="ttc" id="struct_program_options_xhtml_a16963a1c56b9300c949247c0cefe65ab"><div class="ttname"><a href="struct_program_options.xhtml#a16963a1c56b9300c949247c0cefe65ab">ProgramOptions::m_CxxResult</a></div><div class="ttdeci">cxxopts::ParseResult m_CxxResult</div><div class="ttdef"><b>Definition:</b> <a href="_execute_network_program_options_8hpp_source.xhtml#l00042">ExecuteNetworkProgramOptions.hpp:42</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_59425e443f801f1f2fd8bbe4959a3ccf.xhtml">tests</a></li><li class="navelem"><a class="el" href="dir_3502d64799b714c597b8fa7662494b65.xhtml">ExecuteNetwork</a></li><li class="navelem"><a class="el" href="_execute_network_program_options_8hpp.xhtml">ExecuteNetworkProgramOptions.hpp</a></li>
<li class="footer">Generated on Thu Feb 25 2021 17:27:54 for ArmNN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
