blob: 4c050738069204a8651d237fe68562ce04cb7ffe [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +00001<!-- 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: SelectiveComparer&lt; T, false &gt; Struct Template 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">20.02</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('struct_selective_comparer_3_01_t_00_01false_01_4.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="#pub-static-methods">Static Public Member Functions</a> &#124;
99<a href="struct_selective_comparer_3_01_t_00_01false_01_4-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">SelectiveComparer&lt; T, false &gt; Struct Template Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>&gt;</code></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
108Static Public Member Functions</h2></td></tr>
109<tr class="memitem:adeb6209a190d5004061266b1f8e31bae"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_selective_comparer_3_01_t_00_01false_01_4.xhtml#adeb6209a190d5004061266b1f8e31bae">Compare</a> (T a, T b)</td></tr>
110<tr class="separator:adeb6209a190d5004061266b1f8e31bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
111</table>
112<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
113<div class="textblock"><h3>template&lt;typename T&gt;<br />
114struct SelectiveComparer&lt; T, false &gt;</h3>
115
116
117<p class="definition">Definition at line <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00036">36</a> of file <a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>.</p>
118</div><h2 class="groupheader">Member Function Documentation</h2>
119<a id="adeb6209a190d5004061266b1f8e31bae"></a>
120<h2 class="memtitle"><span class="permalink"><a href="#adeb6209a190d5004061266b1f8e31bae">&#9670;&nbsp;</a></span>Compare()</h2>
121
122<div class="memitem">
123<div class="memproto">
124<table class="mlabels">
125 <tr>
126 <td class="mlabels-left">
127 <table class="memname">
128 <tr>
129 <td class="memname">static bool Compare </td>
130 <td>(</td>
131 <td class="paramtype">T&#160;</td>
132 <td class="paramname"><em>a</em>, </td>
133 </tr>
134 <tr>
135 <td class="paramkey"></td>
136 <td></td>
137 <td class="paramtype">T&#160;</td>
138 <td class="paramname"><em>b</em>&#160;</td>
139 </tr>
140 <tr>
141 <td></td>
142 <td>)</td>
143 <td></td><td></td>
144 </tr>
145 </table>
146 </td>
147 <td class="mlabels-right">
148<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
149 </tr>
150</table>
151</div><div class="memdoc">
152
153<p class="definition">Definition at line <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00038">38</a> of file <a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>.</p>
154
155<p class="reference">References <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00023">g_FloatCloseToZeroTolerance</a>.</p>
156<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// If a or b is zero, percent_tolerance does an exact match, so compare to a small, constant tolerance instead.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (a == 0.0f || b == 0.0f)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> std::abs(a - b) &lt;= <a class="code" href="_tensor_helpers_8hpp.xhtml#a1ed60e4e5a0ec57f6483904e11fbd781">g_FloatCloseToZeroTolerance</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">if</span> (std::isinf(a) &amp;&amp; a == b)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (std::isnan(a) &amp;&amp; std::isnan(b))</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// For unquantized floats we use a tolerance of 1%.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; boost::math::fpc::close_at_tolerance&lt;float&gt; comparer(boost::math::fpc::percent_tolerance(1.0f));</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> comparer(a, b);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="ttc" id="_tensor_helpers_8hpp_xhtml_a1ed60e4e5a0ec57f6483904e11fbd781"><div class="ttname"><a href="_tensor_helpers_8hpp.xhtml#a1ed60e4e5a0ec57f6483904e11fbd781">g_FloatCloseToZeroTolerance</a></div><div class="ttdeci">constexpr float g_FloatCloseToZeroTolerance</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_helpers_8hpp_source.xhtml#l00023">TensorHelpers.hpp:23</a></div></div>
157</div><!-- fragment -->
158</div>
159</div>
160<hr/>The documentation for this struct was generated from the following file:<ul>
161<li>src/armnn/test/<a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a></li>
162</ul>
163</div><!-- contents -->
164</div><!-- doc-content -->
165<!-- start footer part -->
166<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
167 <ul>
168 <li class="navelem"><a class="el" href="struct_selective_comparer_3_01_t_00_01false_01_4.xhtml">SelectiveComparer&lt; T, false &gt;</a></li>
169 <li class="footer">Generated on Fri Mar 13 2020 16:09:16 for ArmNN by
170 <a href="http://www.doxygen.org/index.html">
171 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
172 </ul>
173</div>
174</body>
175</html>