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/_types_utils_8cpp_source.xhtml b/Documentation/_types_utils_8cpp_source.xhtml
new file mode 100644
index 0000000..535b532
--- /dev/null
+++ b/Documentation/_types_utils_8cpp_source.xhtml
@@ -0,0 +1,117 @@
+<!-- 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: src/armnn/TypesUtils.cpp 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">20.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('_types_utils_8cpp_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">TypesUtils.cpp</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="_types_utils_8cpp.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 © 2017 Arm Ltd. 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> <span class="preprocessor">#include <<a class="code" href="_types_utils_8hpp.xhtml">armnn/TypesUtils.hpp</a>></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <boost/assert.hpp></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <boost/numeric/conversion/cast.hpp></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace</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">/// Workaround for std:isnan() not being implemented correctly for integral types in MSVC.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/// https://stackoverflow.com/a/56356405</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/// @{</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span>template <typename T, typename std::enable_if<std::is_integral<T>::value, T>::type* = <span class="keyword">nullptr</span>></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> IsNan(T x)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// The spec defines integral types to be handled as if they were casted to doubles.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordflow">return</span> std::isnan(static_cast<double>(x));</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> template <typename T, typename std::enable_if<!std::is_integral<T>::value, T>::type * = <span class="keyword">nullptr</span>></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> IsNan(T x)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">return</span> std::isnan(x);</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">/// @}</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span>} <span class="comment">// namespace std</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> QuantizedType></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacearmnn.xhtml#ad773a034fb9983e15f3094b4c5c7c30c"> 31</a></span> QuantizedType <a class="code" href="namespacearmnn.xhtml#ad773a034fb9983e15f3094b4c5c7c30c">armnn::Quantize</a>(<span class="keywordtype">float</span> value, <span class="keywordtype">float</span> scale, int32_t offset)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  static_assert(IsQuantizedType<QuantizedType>(), <span class="stringliteral">"Not an integer type."</span>);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  constexpr QuantizedType max = std::numeric_limits<QuantizedType>::max();</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  constexpr QuantizedType min = std::numeric_limits<QuantizedType>::lowest();</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  BOOST_ASSERT(scale != 0.f);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  BOOST_ASSERT(!std::isnan(value));</div><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="keywordtype">float</span> clampedValue = std::min(std::max(static_cast<float>(round(value/scale) + offset), static_cast<float>(min)),</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  static_cast<float>(max));</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">auto</span> quantizedBits = <span class="keyword">static_cast<</span>QuantizedType<span class="keyword">></span>(clampedValue);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> quantizedBits;</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> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">template</span> <<span class="keyword">typename</span> QuantizedType></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespacearmnn.xhtml#a855293b1be0581fb61ef6a1c5b027d0f"> 47</a></span> <span class="keywordtype">float</span> <a class="code" href="namespacearmnn.xhtml#a855293b1be0581fb61ef6a1c5b027d0f">armnn::Dequantize</a>(QuantizedType value, <span class="keywordtype">float</span> scale, int32_t offset)</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>  static_assert(IsQuantizedType<QuantizedType>(), <span class="stringliteral">"Not an integer type."</span>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  BOOST_ASSERT(scale != 0.f);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  BOOST_ASSERT(!IsNan(value));</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">float</span> dequantized = <a class="code" href="namespacearmnn.xhtml#a37fa39012e90d568df7f774cd6d1e956">boost::numeric_cast</a><<span class="keywordtype">float</span>>(value - offset) * scale;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> dequantized;</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"></span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/// Explicit specialization of Quantize for int8_t</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> int8_t armnn::Quantize<int8_t>(<span class="keywordtype">float</span> value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/// Explicit specialization of Quantize for uint8_t</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> uint8_t armnn::Quantize<uint8_t>(<span class="keywordtype">float</span> value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/// Explicit specialization of Quantize for int16_t</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> int16_t armnn::Quantize<int16_t>(<span class="keywordtype">float</span> value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/// Explicit specialization of Quantize for int32_t</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> int32_t armnn::Quantize<int32_t>(<span class="keywordtype">float</span> value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/// Explicit specialization of Dequantize for int8_t</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">float</span> armnn::Dequantize<int8_t>(int8_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/// Explicit specialization of Dequantize for uint8_t</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">float</span> armnn::Dequantize<uint8_t>(uint8_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/// Explicit specialization of Dequantize for int16_t</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">float</span> armnn::Dequantize<int16_t>(int16_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/// Explicit specialization of Dequantize for int32_t</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span><span class="keyword">template</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">float</span> armnn::Dequantize<int32_t>(int32_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div><div class="ttc" id="namespacearmnn_xhtml_a855293b1be0581fb61ef6a1c5b027d0f"><div class="ttname"><a href="namespacearmnn.xhtml#a855293b1be0581fb61ef6a1c5b027d0f">armnn::Dequantize</a></div><div class="ttdeci">float Dequantize(QuantizedType value, float scale, int32_t offset)</div><div class="ttdoc">Dequantize an 8-bit data type into a floating point data type. </div><div class="ttdef"><b>Definition:</b> <a href="_types_utils_8cpp_source.xhtml#l00047">TypesUtils.cpp:47</a></div></div>
+<div class="ttc" id="_types_utils_8hpp_xhtml"><div class="ttname"><a href="_types_utils_8hpp.xhtml">TypesUtils.hpp</a></div></div>
+<div class="ttc" id="namespacearmnn_xhtml_ad773a034fb9983e15f3094b4c5c7c30c"><div class="ttname"><a href="namespacearmnn.xhtml#ad773a034fb9983e15f3094b4c5c7c30c">armnn::Quantize</a></div><div class="ttdeci">QuantizedType Quantize(float value, float scale, int32_t offset)</div><div class="ttdoc">Quantize a floating point data type into an 8-bit data type. </div><div class="ttdef"><b>Definition:</b> <a href="_types_utils_8cpp_source.xhtml#l00031">TypesUtils.cpp:31</a></div></div>
+<div class="ttc" id="namespacearmnn_xhtml_a37fa39012e90d568df7f774cd6d1e956"><div class="ttname"><a href="namespacearmnn.xhtml#a37fa39012e90d568df7f774cd6d1e956">armnn::numeric_cast</a></div><div class="ttdeci">std::enable_if_t< std::is_unsigned< Source >::value &&std::is_unsigned< Dest >::value, Dest > numeric_cast(Source source)</div><div class="ttdef"><b>Definition:</b> <a href="_numeric_cast_8hpp_source.xhtml#l00033">NumericCast.hpp:33</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_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.xhtml">armnn</a></li><li class="navelem"><a class="el" href="_types_utils_8cpp.xhtml">TypesUtils.cpp</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:09:09 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>