blob: c48c37c92d30ef495bb577e48e74030e9a0000e7 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +00001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: src/armnnUtils/VerificationHelpers.cpp Source File</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('_verification_helpers_8cpp_source.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="headertitle">
96<div class="title">VerificationHelpers.cpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_verification_helpers_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
100<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div>
101<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_verification_helpers_8hpp.html">VerificationHelpers.hpp</a>&quot;</span></div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_exceptions_8hpp.html">armnn/Exceptions.hpp</a>&gt;</span></div>
106<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;fmt/format.h&gt;</span></div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacearmnn.html">armnn</a>;</div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
111<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn_utils.html">armnnUtils</a></div>
112<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
114<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="namespacearmnn_utils.html#a97dc68ae76f04b81c833184724836c9a"> 16</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacearmnn_utils.html#a97dc68ae76f04b81c833184724836c9a">CheckValidSize</a>(std::initializer_list&lt;size_t&gt; validInputCounts,</div>
115<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordtype">size_t</span> actualValue,</div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* validExpr,</div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* actualExpr,</div>
118<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_check_location.html">CheckLocation</a>&amp; location)</div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">bool</span> isValid = std::any_of(validInputCounts.begin(),</div>
121<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; validInputCounts.end(),</div>
122<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; [&amp;actualValue](<span class="keywordtype">size_t</span> x) { return x == actualValue; } );</div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (!isValid)</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div>
125<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_parse_exception.html">ParseException</a>(fmt::format(<span class="stringliteral">&quot;{} = {} is not valid, not in {{}}. {}&quot;</span>,</div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; actualExpr,</div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; actualValue,</div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; validExpr,</div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; location.<a class="code" href="structarmnn_1_1_check_location.html#a5e3562cda960da001597e7dd5679b140">AsString</a>()));</div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
133<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespacearmnn_utils.html#ab075020544612cd151ebdd08db537396"> 35</a></span>&#160;uint32_t <a class="code" href="namespacearmnn_utils.html#ab075020544612cd151ebdd08db537396">NonNegative</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* expr,</div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; int32_t value,</div>
135<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_check_location.html">CheckLocation</a>&amp; location)</div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">if</span> (value &lt; 0)</div>
138<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_parse_exception.html">ParseException</a>(fmt::format(<span class="stringliteral">&quot;&#39;{}&#39; must be non-negative, received: {} at {}&quot;</span>,</div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; expr,</div>
141<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; value,</div>
142<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; location.<a class="code" href="structarmnn_1_1_check_location.html#a5e3562cda960da001597e7dd5679b140">AsString</a>()));</div>
143<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
144<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">else</span></div>
145<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
146<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>uint32_t<span class="keyword">&gt;</span>(value);</div>
147<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
148<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;}</div>
149<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
150<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="namespacearmnn_utils.html#a2e0aa273755368a1bf5fc65102df4a92"> 52</a></span>&#160;int32_t <a class="code" href="namespacearmnn_utils.html#a2e0aa273755368a1bf5fc65102df4a92">VerifyInt32</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* expr,</div>
151<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; int64_t value,</div>
152<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_check_location.html">armnn::CheckLocation</a>&amp; location)</div>
153<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div>
154<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">if</span> (value &lt; std::numeric_limits&lt;int&gt;::min() || value &gt; std::numeric_limits&lt;int&gt;::max())</div>
155<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div>
156<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_parse_exception.html">ParseException</a>(fmt::format(<span class="stringliteral">&quot;&#39;{}&#39; must should fit into a int32 (ArmNN don&#39;t support int64),&quot;</span></div>
157<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="stringliteral">&quot; received: {} at {}&quot;</span>,</div>
158<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; expr,</div>
159<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; value,</div>
160<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; location.<a class="code" href="structarmnn_1_1_check_location.html#a5e3562cda960da001597e7dd5679b140">AsString</a>()));</div>
161<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
162<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">else</span></div>
163<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; {</div>
164<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>int32_t<span class="keyword">&gt;</span>(value);</div>
165<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
166<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
167<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
168<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}<span class="comment">// armnnUtils</span></div>
169</div><!-- fragment --></div><!-- contents -->
170</div><!-- doc-content -->
171<div class="ttc" id="anamespacearmnn_utils_html_ab075020544612cd151ebdd08db537396"><div class="ttname"><a href="namespacearmnn_utils.html#ab075020544612cd151ebdd08db537396">armnnUtils::NonNegative</a></div><div class="ttdeci">uint32_t NonNegative(const char *expr, int32_t value, const CheckLocation &amp;location)</div><div class="ttdef"><b>Definition:</b> <a href="_verification_helpers_8cpp_source.html#l00035">VerificationHelpers.cpp:35</a></div></div>
172<div class="ttc" id="astructarmnn_1_1_check_location_html_a5e3562cda960da001597e7dd5679b140"><div class="ttname"><a href="structarmnn_1_1_check_location.html#a5e3562cda960da001597e7dd5679b140">armnn::CheckLocation::AsString</a></div><div class="ttdeci">std::string AsString() const</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00029">Exceptions.hpp:29</a></div></div>
173<div class="ttc" id="anamespacearmnn_utils_html_a97dc68ae76f04b81c833184724836c9a"><div class="ttname"><a href="namespacearmnn_utils.html#a97dc68ae76f04b81c833184724836c9a">armnnUtils::CheckValidSize</a></div><div class="ttdeci">void CheckValidSize(std::initializer_list&lt; size_t &gt; validInputCounts, size_t actualValue, const char *validExpr, const char *actualExpr, const CheckLocation &amp;location)</div><div class="ttdef"><b>Definition:</b> <a href="_verification_helpers_8cpp_source.html#l00016">VerificationHelpers.cpp:16</a></div></div>
174<div class="ttc" id="a_verification_helpers_8hpp_html"><div class="ttname"><a href="_verification_helpers_8hpp.html">VerificationHelpers.hpp</a></div></div>
175<div class="ttc" id="astructarmnn_1_1_check_location_html"><div class="ttname"><a href="structarmnn_1_1_check_location.html">armnn::CheckLocation</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00014">Exceptions.hpp:14</a></div></div>
176<div class="ttc" id="anamespacearmnn_utils_html"><div class="ttname"><a href="namespacearmnn_utils.html">armnnUtils</a></div><div class="ttdef"><b>Definition:</b> <a href="_compatible_types_8hpp_source.html#l00010">CompatibleTypes.hpp:10</a></div></div>
177<div class="ttc" id="anamespacearmnn_utils_html_a2e0aa273755368a1bf5fc65102df4a92"><div class="ttname"><a href="namespacearmnn_utils.html#a2e0aa273755368a1bf5fc65102df4a92">armnnUtils::VerifyInt32</a></div><div class="ttdeci">int32_t VerifyInt32(const char *expr, int64_t value, const armnn::CheckLocation &amp;location)</div><div class="ttdef"><b>Definition:</b> <a href="_verification_helpers_8cpp_source.html#l00052">VerificationHelpers.cpp:52</a></div></div>
178<div class="ttc" id="aclassarmnn_1_1_parse_exception_html"><div class="ttname"><a href="classarmnn_1_1_parse_exception.html">armnn::ParseException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00092">Exceptions.hpp:92</a></div></div>
179<div class="ttc" id="a_exceptions_8hpp_html"><div class="ttname"><a href="_exceptions_8hpp.html">Exceptions.hpp</a></div></div>
180<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div>
181<!-- start footer part -->
182<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
183 <ul>
184 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5d9c764a006d252ff232a5efbbd99a46.html">armnnUtils</a></li><li class="navelem"><a class="el" href="_verification_helpers_8cpp.html">VerificationHelpers.cpp</a></li>
185 <li class="footer">Generated on Wed Feb 14 2024 16:36:15 for Arm NN by
186 <a href="http://www.doxygen.org/index.html">
187 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
188 </ul>
189</div>
190</body>
191</html>