IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/structarmnn_1_1_q_asymm_s8_quantization_scheme.html b/Documentation/structarmnn_1_1_q_asymm_s8_quantization_scheme.html
new file mode 100644
index 0000000..3f8e8b8
--- /dev/null
+++ b/Documentation/structarmnn_1_1_q_asymm_s8_quantization_scheme.html
@@ -0,0 +1,237 @@
+<!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="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: QAsymmS8QuantizationScheme Struct 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>
+<link href="doxygen.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;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</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('structarmnn_1_1_q_asymm_s8_quantization_scheme.html','');});
+</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-methods">Public Member Functions</a> |
+<a href="structarmnn_1_1_q_asymm_s8_quantization_scheme-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">QAsymmS8QuantizationScheme Struct Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>></code></p>
+<div class="dynheader">
+Inheritance diagram for QAsymmS8QuantizationScheme:</div>
+<div class="dyncontent">
+ <div class="center">
+ <img src="structarmnn_1_1_q_asymm_s8_quantization_scheme.png" usemap="#QAsymmS8QuantizationScheme_map" alt=""/>
+ <map id="QAsymmS8QuantizationScheme_map" name="QAsymmS8QuantizationScheme_map">
+<area href="structarmnn_1_1_i_quantization_scheme.html" alt="IQuantizationScheme" shape="rect" coords="0,0,192,24"/>
+</map>
+ </div></div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a9fb07d8d7554a1502e732b8afa92040a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a9fb07d8d7554a1502e732b8afa92040a">ComputeScheme</a> (double min, double max) const override</td></tr>
+<tr class="separator:a9fb07d8d7554a1502e732b8afa92040a"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a> () const override</td></tr>
+<tr class="separator:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a57d67416d97cb7138e43656b43feb797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a57d67416d97cb7138e43656b43feb797">GetDataType</a> () const override</td></tr>
+<tr class="separator:a57d67416d97cb7138e43656b43feb797"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="inherit_header pub_methods_structarmnn_1_1_i_quantization_scheme"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_i_quantization_scheme')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structarmnn_1_1_i_quantization_scheme.html">IQuantizationScheme</a></td></tr>
+<tr class="memitem:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_quantization_scheme.html#ac7ce71800ca0ebb1222958717a834c9a">~IQuantizationScheme</a> ()</td></tr>
+<tr class="separator:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00064">64</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="a9fb07d8d7554a1502e732b8afa92040a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9fb07d8d7554a1502e732b8afa92040a">◆ </a></span>ComputeScheme()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="namespacearmnn.html#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> ComputeScheme </td>
+ <td>(</td>
+ <td class="paramtype">double </td>
+ <td class="paramname"><em>min</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">double </td>
+ <td class="paramname"><em>max</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td> const</td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a6a5561395e9693f02258b49dfcc009b4">IQuantizationScheme</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00066">66</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
+
+<p class="reference">References <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme::NumBits()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">if</span> (min > max)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">throw</span> InvalidArgumentException(<span class="stringliteral">"min > max will result in invalid quantization."</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">double</span> highest = (1 << <a class="code" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a>()) - 1;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  min = std::min(0.0, min); <span class="comment">// min <= 0.0</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  max = std::max(0.0, max); <span class="comment">// max >= 0.0</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// To avoid dividing by zero when quantizing a zero filled tensor</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">if</span> (min == 0.0 && max == 0.0)</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  max = 1.0;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// Assumes quantization range [0-255]</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">double</span> scale = (max-min) / highest ;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">double</span> offset = - min / scale;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">//Clamp 0 to Highest</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  offset = std::max(0.0, std::min(highest, offset));</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">//-128 on offset to cast to signed range</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> std::make_pair(static_cast<float>(scale), static_cast<int>(std::round(offset)-128));</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="ttc" id="structarmnn_1_1_q_asymm_s8_quantization_scheme_html_a1046eb36ff708a1b84f9a6bf0103fbc7"><div class="ttname"><a href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">armnn::QAsymmS8QuantizationScheme::NumBits</a></div><div class="ttdeci">int NumBits() const override</div><div class="ttdef"><b>Definition:</b> <a href="_network_quantization_scheme_8hpp_source.html#l00095">NetworkQuantizationScheme.hpp:95</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a57d67416d97cb7138e43656b43feb797"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a57d67416d97cb7138e43656b43feb797">◆ </a></span>GetDataType()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> GetDataType </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#ad23181f9f8fcc85758f62c49fc7ca23f">IQuantizationScheme</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00097">97</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
+
+<p class="reference">References <a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">armnn::QAsymmS8</a>.</p>
+<div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> { <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">DataType::QAsymmS8</a>; }</div><div class="ttc" id="namespacearmnn_html_ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d"><div class="ttname"><a href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">armnn::DataType::QAsymmS8</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="a1046eb36ff708a1b84f9a6bf0103fbc7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1046eb36ff708a1b84f9a6bf0103fbc7">◆ </a></span>NumBits()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">int NumBits </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td> const</td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme</a>.</p>
+
+<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00095">95</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
+<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> { <span class="keywordflow">return</span> 8; }</div></div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li>src/armnn/<a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.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="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html">QAsymmS8QuantizationScheme</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:07:04 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>