diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2023-11-22 11:41:15 +0000 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-11-22 11:41:15 +0000 |
commit | 6f92c8e9f8bb38dcf5dccf8deeff5112ecd8e37c (patch) | |
tree | 0c076149c03ac45c2617f5e02a77b79287ff5a0f /latest/_types_utils_8cpp_source.html | |
parent | 03c7ff3f6188240baaeaeb405a357a0c58195fec (diff) | |
download | armnn-6f92c8e9f8bb38dcf5dccf8deeff5112ecd8e37c.tar.gz |
Update Doxygen for 23.11
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I47cd933f5002cb94a73aa97689d7b3d9c93cb849
Diffstat (limited to 'latest/_types_utils_8cpp_source.html')
-rw-r--r-- | latest/_types_utils_8cpp_source.html | 104 |
1 files changed, 58 insertions, 46 deletions
diff --git a/latest/_types_utils_8cpp_source.html b/latest/_types_utils_8cpp_source.html index 756d8324e6..f703a2c995 100644 --- a/latest/_types_utils_8cpp_source.html +++ b/latest/_types_utils_8cpp_source.html @@ -36,7 +36,7 @@ <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/> <td id="projectalign" style="padding-left: 0.9em;"> <div id="projectname"> -  <span id="projectnumber">23.08</span> +  <span id="projectnumber">23.11</span> </div> </td> </tr> @@ -130,73 +130,85 @@ $(document).ready(function(){initNavTree('_types_utils_8cpp_source.html',''); in <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  static_assert(IsQuantizedType<QuantizedType>(), <span class="stringliteral">"Not an integer type."</span>);</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  constexpr QuantizedType max = std::numeric_limits<QuantizedType>::max();</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  constexpr QuantizedType min = std::numeric_limits<QuantizedType>::lowest();</div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(scale != 0.f);</div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(!std::isnan(value));</div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">float</span> clampedValue = std::min(std::max((<span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(offset) + <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(round(value/scale))),</div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(min)), <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(max));</div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</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="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> quantizedBits;</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="keyword">template</span> <<span class="keyword">typename</span> QuantizedType></div> -<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacearmnn.html#a855293b1be0581fb61ef6a1c5b027d0f"> 46</a></span> <span class="keywordtype">float</span> <a class="code" href="namespacearmnn.html#a855293b1be0581fb61ef6a1c5b027d0f">armnn::Dequantize</a>(QuantizedType value, <span class="keywordtype">float</span> scale, int32_t offset)</div> -<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  static_assert(IsQuantizedType<QuantizedType>(), <span class="stringliteral">"Not an integer type."</span>);</div> -<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(scale != 0.f);</div> -<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(!IsNan(value));</div> -<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> (armnn::numeric_cast<float>(value - offset)) * scale;</div> -<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div> -<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div> -<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/// Explicit specialization of Quantize for int8_t</span></div> -<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00056"></a><span class="lineno"> 56</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="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span> </div> -<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/// Explicit specialization of Quantize for uint8_t</span></div> -<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00060"></a><span class="lineno"> 60</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="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> </div> -<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/// Explicit specialization of Quantize for int16_t</span></div> -<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</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="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">if</span> (scale == 0.f)</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(<span class="stringliteral">"Quantize: Scale cannot be 0.f"</span>);</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="keywordflow">if</span> (std::isnan(value))</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(<span class="stringliteral">"Quantize: Value is NaN"</span>);</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>  </div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">float</span> clampedValue = std::min(std::max((<span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(offset) + <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(round(value/scale))),</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(min)), <span class="keyword">static_cast<</span><span class="keywordtype">float</span><span class="keyword">></span>(max));</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</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="l00047"></a><span class="lineno"> 47</span>  </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> quantizedBits;</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>  </div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span> <<span class="keyword">typename</span> QuantizedType></div> +<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="namespacearmnn.html#a855293b1be0581fb61ef6a1c5b027d0f"> 52</a></span> <span class="keywordtype">float</span> <a class="code" href="namespacearmnn.html#a855293b1be0581fb61ef6a1c5b027d0f">armnn::Dequantize</a>(QuantizedType value, <span class="keywordtype">float</span> scale, int32_t offset)</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>  static_assert(IsQuantizedType<QuantizedType>(), <span class="stringliteral">"Not an integer type."</span>);</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">if</span> (scale == 0.f)</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(<span class="stringliteral">"Dequantize: Scale cannot be 0.f"</span>);</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">if</span> (std::isnan(value))</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a>(<span class="stringliteral">"Dequantize: Value is NaN"</span>);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> (armnn::numeric_cast<float>(value - offset)) * scale;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> }</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> </div> -<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/// Explicit specialization of Quantize for int32_t</span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/// Explicit specialization of Quantize for int8_t</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00068"></a><span class="lineno"> 68</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="l00068"></a><span class="lineno"> 68</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="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> </div> -<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/// Explicit specialization of Dequantize for int8_t</span></div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/// Explicit specialization of Quantize for uint8_t</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00072"></a><span class="lineno"> 72</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="l00072"></a><span class="lineno"> 72</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="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> </div> -<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/// Explicit specialization of Dequantize for uint8_t</span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/// Explicit specialization of Quantize for int16_t</span></div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00076"></a><span class="lineno"> 76</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="l00076"></a><span class="lineno"> 76</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="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span> </div> -<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/// Explicit specialization of Dequantize for int16_t</span></div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/// Explicit specialization of Quantize for int32_t</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00080"></a><span class="lineno"> 80</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="l00080"></a><span class="lineno"> 80</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="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> </div> -<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/// Explicit specialization of Dequantize for int32_t</span></div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/// Explicit specialization of Dequantize for int8_t</span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00084"></a><span class="lineno"> 84</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="line"><a name="l00084"></a><span class="lineno"> 84</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="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span> </div> -<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// Explicit specialization of Dequantize for int64_t</span></div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/// Explicit specialization of Dequantize for uint8_t</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span><span class="keyword">template</span></div> -<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">float</span> armnn::Dequantize<int64_t>(int64_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> </div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/// Explicit specialization of Dequantize for int16_t</span></div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span><span class="keyword">template</span></div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</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="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> </div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/// Explicit specialization of Dequantize for int32_t</span></div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span><span class="keyword">template</span></div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</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="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span> </div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/// Explicit specialization of Dequantize for int64_t</span></div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span><span class="keyword">template</span></div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">float</span> armnn::Dequantize<int64_t>(int64_t value, <span class="keywordtype">float</span> scale, int32_t offset);</div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> -<div class="ttc" id="a_assert_8hpp_html_a5698be69cbd5dfe6c28fcd9867e8cbed"><div class="ttname"><a href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a></div><div class="ttdeci">#define ARMNN_ASSERT(COND)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.html#l00014">Assert.hpp:14</a></div></div> <div class="ttc" id="a_types_utils_8hpp_html"><div class="ttname"><a href="_types_utils_8hpp.html">TypesUtils.hpp</a></div></div> <div class="ttc" id="a_numeric_cast_8hpp_html"><div class="ttname"><a href="_numeric_cast_8hpp.html">NumericCast.hpp</a></div></div> <div class="ttc" id="a_assert_8hpp_html"><div class="ttname"><a href="_assert_8hpp.html">Assert.hpp</a></div></div> -<div class="ttc" id="anamespacearmnn_html_a855293b1be0581fb61ef6a1c5b027d0f"><div class="ttname"><a href="namespacearmnn.html#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.html#l00046">TypesUtils.cpp:46</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_invalid_argument_exception_html"><div class="ttname"><a href="classarmnn_1_1_invalid_argument_exception.html">armnn::InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00080">Exceptions.hpp:80</a></div></div> +<div class="ttc" id="anamespacearmnn_html_a855293b1be0581fb61ef6a1c5b027d0f"><div class="ttname"><a href="namespacearmnn.html#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.html#l00052">TypesUtils.cpp:52</a></div></div> <div class="ttc" id="anamespacearmnn_html_ad773a034fb9983e15f3094b4c5c7c30c"><div class="ttname"><a href="namespacearmnn.html#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.html#l00030">TypesUtils.cpp:30</a></div></div> <!-- 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.html">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.html">armnn</a></li><li class="navelem"><a class="el" href="_types_utils_8cpp.html">TypesUtils.cpp</a></li> - <li class="footer">Generated on Tue Aug 22 2023 11:36:58 for Arm NN by + <li class="footer">Generated on Wed Nov 22 2023 10:57:06 for Arm NN by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> |