diff options
author | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
---|---|---|
committer | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
commit | ae050524109f1ce827962665436ef7430f2ac479 (patch) | |
tree | a087fe0c77570971dd7979f2757426c24e91afc7 /23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml | |
parent | 8d2ca734165a068478df7cffa46185680b05cd20 (diff) | |
download | armnn-ae050524109f1ce827962665436ef7430f2ac479.tar.gz |
IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub.
* Updating Doxygen documentation for 23.02 release.
Signed-off-by: David Monahan <david.monahan@arm.com>
Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82
Diffstat (limited to '23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml')
-rw-r--r-- | 23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml | 56 |
1 files changed, 34 insertions, 22 deletions
diff --git a/23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml b/23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml index 9dd4fb9661..5bf44c7bf3 100644 --- a/23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml +++ b/23.02/classarmnn_1_1_q_a_symm8_encoder.xhtml @@ -8,7 +8,7 @@ <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="generator" content="Doxygen 1.8.17"/> <meta name="robots" content="NOINDEX, NOFOLLOW" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ArmNN: QASymm8Encoder Class Reference</title> @@ -19,9 +19,6 @@ <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> @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); -</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +</script> +<script type="text/javascript" async="async" 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> @@ -51,18 +49,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -76,7 +77,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('classarmnn_1_1_q_a_symm8_encoder.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classarmnn_1_1_q_a_symm8_encoder.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -112,8 +115,8 @@ Inheritance diagram for QASymm8Encoder:</div> <area href="classarmnn_1_1_typed_iterator.xhtml" alt="TypedIterator< uint8_t, Encoder< float > >" shape="rect" coords="0,112,253,136"/> <area href="classarmnn_1_1_encoder.xhtml" alt="Encoder< float >" shape="rect" coords="0,56,253,80"/> <area href="classarmnn_1_1_base_iterator.xhtml" alt="BaseIterator" shape="rect" coords="0,0,253,24"/> -</map> - </div></div> + </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> @@ -143,6 +146,8 @@ Public Member Functions</h2></td></tr> <tr class="separator:a4fa6adc41ee005f5915cabd54e9dc0d9 inherit pub_methods_classarmnn_1_1_encoder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a7d9ce14c0db46b3d1baaae0a7c13ba inherit pub_methods_classarmnn_1_1_encoder"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_encoder.xhtml#a2a7d9ce14c0db46b3d1baaae0a7c13ba">~Encoder</a> ()</td></tr> <tr class="separator:a2a7d9ce14c0db46b3d1baaae0a7c13ba inherit pub_methods_classarmnn_1_1_encoder"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac729108381e2340bea12877971713ecb inherit pub_methods_classarmnn_1_1_encoder"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_encoder.xhtml#ac729108381e2340bea12877971713ecb">Get</a> () const=0</td></tr> +<tr class="separator:ac729108381e2340bea12877971713ecb inherit pub_methods_classarmnn_1_1_encoder"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classarmnn_1_1_base_iterator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_base_iterator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1_base_iterator.xhtml">BaseIterator</a></td></tr> <tr class="memitem:a9be4690183bfdb2f5529a12583524eb5 inherit pub_methods_classarmnn_1_1_base_iterator"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_base_iterator.xhtml#a9be4690183bfdb2f5529a12583524eb5">BaseIterator</a> ()</td></tr> <tr class="separator:a9be4690183bfdb2f5529a12583524eb5 inherit pub_methods_classarmnn_1_1_base_iterator"><td class="memSeparator" colspan="2"> </td></tr> @@ -202,7 +207,7 @@ Additional Inherited Members</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_base_iterator_8hpp_source.xhtml#l00496">496</a> of file <a class="el" href="_base_iterator_8hpp_source.xhtml">BaseIterator.hpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  : <a class="code" href="classarmnn_1_1_typed_iterator.xhtml#a8dee1263b4be6006c84e75e1c61f838d">TypedIterator</a>(data), m_Scale(scale), m_Offset(offset) {}</div><div class="ttc" id="classarmnn_1_1_typed_iterator_xhtml_a8dee1263b4be6006c84e75e1c61f838d"><div class="ttname"><a href="classarmnn_1_1_typed_iterator.xhtml#a8dee1263b4be6006c84e75e1c61f838d">armnn::TypedIterator< uint8_t, Encoder< float > >::TypedIterator</a></div><div class="ttdeci">TypedIterator(uint8_t *data=nullptr)</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00072">BaseIterator.hpp:72</a></div></div> +<div class="fragment"><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  : <a class="code" href="classarmnn_1_1_typed_iterator.xhtml#a8dee1263b4be6006c84e75e1c61f838d">TypedIterator</a>(data), m_Scale(scale), m_Offset(offset) {}</div> </div><!-- fragment --> </div> </div> @@ -241,7 +246,7 @@ Additional Inherited Members</h2></td></tr> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_base_iterator_8hpp_source.xhtml#l00499">499</a> of file <a class="el" href="_base_iterator_8hpp_source.xhtml">BaseIterator.hpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  : <a class="code" href="classarmnn_1_1_q_a_symm8_encoder.xhtml#a079fc126dc41d80db1334c5c3ec1605f">QASymm8Encoder</a>(<span class="keyword">nullptr</span>, scale, offset) {}</div><div class="ttc" id="classarmnn_1_1_q_a_symm8_encoder_xhtml_a079fc126dc41d80db1334c5c3ec1605f"><div class="ttname"><a href="classarmnn_1_1_q_a_symm8_encoder.xhtml#a079fc126dc41d80db1334c5c3ec1605f">armnn::QASymm8Encoder::QASymm8Encoder</a></div><div class="ttdeci">QASymm8Encoder(uint8_t *data, const float scale, const int32_t offset)</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00496">BaseIterator.hpp:496</a></div></div> +<div class="fragment"><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  : <a class="code" href="classarmnn_1_1_q_a_symm8_encoder.xhtml#a079fc126dc41d80db1334c5c3ec1605f">QASymm8Encoder</a>(<span class="keyword">nullptr</span>, scale, offset) {}</div> </div><!-- fragment --> </div> </div> @@ -264,19 +269,18 @@ Additional Inherited Members</h2></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> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>Implements <a class="el" href="classarmnn_1_1_encoder.xhtml#ac729108381e2340bea12877971713ecb">Encoder< float ></a>.</p> - <p class="definition">Definition at line <a class="el" href="_base_iterator_8hpp_source.xhtml#l00507">507</a> of file <a class="el" href="_base_iterator_8hpp_source.xhtml">BaseIterator.hpp</a>.</p> - -<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a56943a0946e5f15e5e58054b8e7a04a4a9bc35e069257a508e14ed82965a8661d">armnn::Dequantize</a>.</p> -<div class="fragment"><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  {</div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#a56943a0946e5f15e5e58054b8e7a04a4a9bc35e069257a508e14ed82965a8661d">armnn::Dequantize</a>(*<a class="code" href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">m_Iterator</a>, m_Scale, m_Offset);</div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  }</div><div class="ttc" id="classarmnn_1_1_typed_iterator_xhtml_abb7c5ac687cb1779a8c73d24cb903cec"><div class="ttname"><a href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">armnn::TypedIterator< uint8_t, Encoder< float > >::m_Iterator</a></div><div class="ttdeci">uint8_t * m_Iterator</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00111">BaseIterator.hpp:111</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml_a56943a0946e5f15e5e58054b8e7a04a4a9bc35e069257a508e14ed82965a8661d"><div class="ttname"><a href="namespacearmnn.xhtml#a56943a0946e5f15e5e58054b8e7a04a4a9bc35e069257a508e14ed82965a8661d">armnn::LayerType::Dequantize</a></div></div> +<div class="fragment"><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  {</div> +<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#a855293b1be0581fb61ef6a1c5b027d0f">armnn::Dequantize</a>(*<a class="code" href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">m_Iterator</a>, m_Scale, m_Offset);</div> +<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  }</div> </div><!-- fragment --> +<p class="reference">References <a class="el" href="_types_utils_8cpp_source.xhtml#l00046">armnn::Dequantize()</a>, and <a class="el" href="_base_iterator_8hpp_source.xhtml#l00111">TypedIterator< uint8_t, Encoder< float > >::m_Iterator</a>.</p> + </div> </div> <a id="ad569be855c2197ce65f467105fcad003"></a> @@ -306,8 +310,12 @@ Additional Inherited Members</h2></td></tr> <p>Implements <a class="el" href="classarmnn_1_1_encoder.xhtml#ae3b62b846a9c239f332830b9e36030eb">Encoder< float ></a>.</p> <p class="definition">Definition at line <a class="el" href="_base_iterator_8hpp_source.xhtml#l00502">502</a> of file <a class="el" href="_base_iterator_8hpp_source.xhtml">BaseIterator.hpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  {</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  *<a class="code" href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">m_Iterator</a> = armnn::Quantize<uint8_t>(right, m_Scale, m_Offset);</div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  }</div><div class="ttc" id="classarmnn_1_1_typed_iterator_xhtml_abb7c5ac687cb1779a8c73d24cb903cec"><div class="ttname"><a href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">armnn::TypedIterator< uint8_t, Encoder< float > >::m_Iterator</a></div><div class="ttdeci">uint8_t * m_Iterator</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00111">BaseIterator.hpp:111</a></div></div> +<div class="fragment"><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  {</div> +<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  *<a class="code" href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">m_Iterator</a> = armnn::Quantize<uint8_t>(right, m_Scale, m_Offset);</div> +<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  }</div> </div><!-- fragment --> +<p class="reference">References <a class="el" href="_base_iterator_8hpp_source.xhtml#l00111">TypedIterator< uint8_t, Encoder< float > >::m_Iterator</a>.</p> + </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> @@ -315,13 +323,17 @@ Additional Inherited Members</h2></td></tr> </ul> </div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="aclassarmnn_1_1_typed_iterator_xhtml_abb7c5ac687cb1779a8c73d24cb903cec"><div class="ttname"><a href="classarmnn_1_1_typed_iterator.xhtml#abb7c5ac687cb1779a8c73d24cb903cec">armnn::TypedIterator< uint8_t, Encoder< float > >::m_Iterator</a></div><div class="ttdeci">uint8_t * m_Iterator</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00111">BaseIterator.hpp:111</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_q_a_symm8_encoder_xhtml_a079fc126dc41d80db1334c5c3ec1605f"><div class="ttname"><a href="classarmnn_1_1_q_a_symm8_encoder.xhtml#a079fc126dc41d80db1334c5c3ec1605f">armnn::QASymm8Encoder::QASymm8Encoder</a></div><div class="ttdeci">QASymm8Encoder(uint8_t *data, const float scale, const int32_t offset)</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00496">BaseIterator.hpp:496</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_typed_iterator_xhtml_a8dee1263b4be6006c84e75e1c61f838d"><div class="ttname"><a href="classarmnn_1_1_typed_iterator.xhtml#a8dee1263b4be6006c84e75e1c61f838d">armnn::TypedIterator< uint8_t, Encoder< float > >::TypedIterator</a></div><div class="ttdeci">TypedIterator(uint8_t *data=nullptr)</div><div class="ttdef"><b>Definition:</b> <a href="_base_iterator_8hpp_source.xhtml#l00072">BaseIterator.hpp:72</a></div></div> +<div class="ttc" id="anamespacearmnn_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#l00046">TypesUtils.cpp:46</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_q_a_symm8_encoder.xhtml">QASymm8Encoder</a></li> - <li class="footer">Generated on Fri Feb 24 2023 10:24:32 for ArmNN by + <li class="footer">Generated on Wed Mar 22 2023 15:53:07 for ArmNN by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |