diff options
author | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 17:44:00 +0000 |
---|---|---|
committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 18:27:49 +0000 |
commit | fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf (patch) | |
tree | eb4bc8f9b411f30c7655616142b5a4bdd3a1acd0 /21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml | |
parent | fb14ebbd68e04876809145296af96f6f41857418 (diff) | |
download | armnn-fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf.tar.gz |
IVGCVSW-5687 Update Doxygen Docu
* Update Doxygen Documentation for 21.02 release
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5
Diffstat (limited to '21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml')
-rw-r--r-- | 21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml | 176 |
1 files changed, 176 insertions, 0 deletions
diff --git a/21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml b/21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml new file mode 100644 index 0000000000..9e48cb118c --- /dev/null +++ b/21.02/struct_selective_comparer_3_01_t_00_01false_01_4.xhtml @@ -0,0 +1,176 @@ +<!-- 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: SelectiveComparer< T, false > Struct Template Reference</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('struct_selective_comparer_3_01_t_00_01false_01_4.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="summary"> +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="struct_selective_comparer_3_01_t_00_01false_01_4-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">SelectiveComparer< T, false > Struct Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:adeb6209a190d5004061266b1f8e31bae"><td class="memItemLeft" align="right" valign="top">static bool </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> +<tr class="separator:adeb6209a190d5004061266b1f8e31bae"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><h3>template<typename T><br /> +struct SelectiveComparer< T, false ></h3> + + +<p class="definition">Definition at line <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00035">35</a> of file <a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="adeb6209a190d5004061266b1f8e31bae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adeb6209a190d5004061266b1f8e31bae">◆ </a></span>Compare()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static bool Compare </td> + <td>(</td> + <td class="paramtype">T </td> + <td class="paramname"><em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">T </td> + <td class="paramname"><em>b</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00037">37</a> of file <a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_tensor_helpers_8hpp_source.xhtml#l00022">g_FloatCloseToZeroTolerance</a>, and <a class="el" href="_floating_point_comparison_8hpp_source.xhtml#l00020">armnnUtils::within_percentage_tolerance()</a>.</p> +<div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <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="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> (a == 0.0f || b == 0.0f)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> std::abs(a - b) <= <a class="code" href="_tensor_helpers_8hpp.xhtml#a1ed60e4e5a0ec57f6483904e11fbd781">g_FloatCloseToZeroTolerance</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"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">if</span> (std::isinf(a) && a == b)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">if</span> (std::isnan(a) && std::isnan(b))</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// For unquantized floats we use a tolerance of 1%.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn_utils.xhtml#a56b0e17341e000fa1d4561890294520c">armnnUtils::within_percentage_tolerance</a>(a, b);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</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#l00022">TensorHelpers.hpp:22</a></div></div> +<div class="ttc" id="namespacearmnn_utils_xhtml_a56b0e17341e000fa1d4561890294520c"><div class="ttname"><a href="namespacearmnn_utils.xhtml#a56b0e17341e000fa1d4561890294520c">armnnUtils::within_percentage_tolerance</a></div><div class="ttdeci">bool within_percentage_tolerance(float a, float b, float tolerancePercent=1.0f)</div><div class="ttdoc">Compare two floats and return true if their values are within a specified tolerance of each other...</div><div class="ttdef"><b>Definition:</b> <a href="_floating_point_comparison_8hpp_source.xhtml#l00020">FloatingPointComparison.hpp:20</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>src/armnn/test/<a class="el" href="_tensor_helpers_8hpp_source.xhtml">TensorHelpers.hpp</a></li> +</ul> +</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="struct_selective_comparer_3_01_t_00_01false_01_4.xhtml">SelectiveComparer< T, false ></a></li> + <li class="footer">Generated on Thu Feb 25 2021 17:27:56 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> |