diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
| commit | 8efb48a6847c5cd166c561127ae6611150963ce3 (patch) | |
| tree | f4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/classarmnn_utils_1_1_floating_point_converter.xhtml | |
| parent | 023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff) | |
| download | armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz | |
Update Doxygen docu for 23.05
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe
Diffstat (limited to '23.05/classarmnn_utils_1_1_floating_point_converter.xhtml')
| -rw-r--r-- | 23.05/classarmnn_utils_1_1_floating_point_converter.xhtml | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/23.05/classarmnn_utils_1_1_floating_point_converter.xhtml b/23.05/classarmnn_utils_1_1_floating_point_converter.xhtml new file mode 100644 index 0000000000..3ca7a4aafc --- /dev/null +++ b/23.05/classarmnn_utils_1_1_floating_point_converter.xhtml @@ -0,0 +1,349 @@ +<!-- 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.17"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: FloatingPointConverter Class 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> +<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" 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> +<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">23.05</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- 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(); }); +}); +/* @license-end */</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"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classarmnn_utils_1_1_floating_point_converter.xhtml',''); initResizable(); }); +/* @license-end */ +</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="classarmnn_utils_1_1_floating_point_converter-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">FloatingPointConverter Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_floating_point_converter_8hpp_source.xhtml">FloatingPointConverter.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:af0fdbfb53596052d571cb73899f9da2b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_floating_point_converter.xhtml#af0fdbfb53596052d571cb73899f9da2b">ConvertFloat32To16</a> (const float *srcFloat32Buffer, size_t numElements, void *dstFloat16Buffer)</td></tr> +<tr class="memdesc:af0fdbfb53596052d571cb73899f9da2b"><td class="mdescLeft"> </td><td class="mdescRight">Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer. <a href="classarmnn_utils_1_1_floating_point_converter.xhtml#af0fdbfb53596052d571cb73899f9da2b">More...</a><br /></td></tr> +<tr class="separator:af0fdbfb53596052d571cb73899f9da2b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac1f1568f02163a68906a0030e0ba9871"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_floating_point_converter.xhtml#ac1f1568f02163a68906a0030e0ba9871">ConvertFloat16To32</a> (const void *srcFloat16Buffer, size_t numElements, float *dstFloat32Buffer)</td></tr> +<tr class="separator:ac1f1568f02163a68906a0030e0ba9871"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a33e468bc160c2b83f049424104c0f420"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_floating_point_converter.xhtml#a33e468bc160c2b83f049424104c0f420">ConvertFloat32ToBFloat16</a> (const float *srcFloat32Buffer, size_t numElements, void *dstBFloat16Buffer)</td></tr> +<tr class="separator:a33e468bc160c2b83f049424104c0f420"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a762e047d7c3baf6acd77b775b3aac70d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_utils_1_1_floating_point_converter.xhtml#a762e047d7c3baf6acd77b775b3aac70d">ConvertBFloat16ToFloat32</a> (const void *srcBFloat16Buffer, size_t numElements, float *dstFloat32Buffer)</td></tr> +<tr class="separator:a762e047d7c3baf6acd77b775b3aac70d"><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="_floating_point_converter_8hpp_source.xhtml#l00013">13</a> of file <a class="el" href="_floating_point_converter_8hpp_source.xhtml">FloatingPointConverter.hpp</a>.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a762e047d7c3baf6acd77b775b3aac70d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a762e047d7c3baf6acd77b775b3aac70d">◆ </a></span>ConvertBFloat16ToFloat32()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void ConvertBFloat16ToFloat32 </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>srcBFloat16Buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>numElements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float * </td> + <td class="paramname"><em>dstFloat32Buffer</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">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ac1f1568f02163a68906a0030e0ba9871"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac1f1568f02163a68906a0030e0ba9871">◆ </a></span>ConvertFloat16To32()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void ConvertFloat16To32 </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>srcFloat16Buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>numElements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float * </td> + <td class="paramname"><em>dstFloat32Buffer</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">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_floating_point_converter_8cpp_source.xhtml#l00031">31</a> of file <a class="el" href="_floating_point_converter_8cpp_source.xhtml">FloatingPointConverter.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(srcFloat16Buffer != <span class="keyword">nullptr</span>);</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(dstFloat32Buffer != <span class="keyword">nullptr</span>);</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="keyword">const</span> <a class="code" href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a>* pHalf = <span class="keyword">static_cast<</span><span class="keyword">const </span><a class="code" href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a>*<span class="keyword">></span>(srcFloat16Buffer);</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < numElements; i++)</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>  dstFloat32Buffer[i] = pHalf[i];</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><!-- fragment --> +<p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00014">ARMNN_ASSERT</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_network_8cpp_source.xhtml#l00808">armnn::AttemptBackendAssignment()</a>, <a class="el" href="_base_iterator_8hpp_source.xhtml#l00278">Float16Decoder::DecodeTensor()</a>, <a class="el" href="_neon_convert_fp16_to_fp32_workload_8cpp_source.xhtml#l00051">NeonConvertFp16ToFp32Workload::Execute()</a>, <a class="el" href="_convert_constants_8hpp_source.xhtml#l00023">Float16ToFloat32::Func()</a>, <a class="el" href="_base_iterator_8hpp_source.xhtml#l00272">Float16Decoder::Get()</a>, and <a class="el" href="_base_iterator_8hpp_source.xhtml#l00603">Float16Encoder::Get()</a>.</p> + +</div> +</div> +<a id="af0fdbfb53596052d571cb73899f9da2b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af0fdbfb53596052d571cb73899f9da2b">◆ </a></span>ConvertFloat32To16()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void ConvertFloat32To16 </td> + <td>(</td> + <td class="paramtype">const float * </td> + <td class="paramname"><em>srcFloat32Buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>numElements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>dstFloat16Buffer</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">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer. </p> +<p>dstFloat16Buffer should be (numElements * 2) in size </p> + +<p class="definition">Definition at line <a class="el" href="_floating_point_converter_8cpp_source.xhtml#l00016">16</a> of file <a class="el" href="_floating_point_converter_8cpp_source.xhtml">FloatingPointConverter.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(srcFloat32Buffer != <span class="keyword">nullptr</span>);</div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(dstFloat16Buffer != <span class="keyword">nullptr</span>);</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a>* pHalf = <span class="keyword">static_cast<</span><a class="code" href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a>*<span class="keyword">></span>(dstFloat16Buffer);</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">for</span> (<span class="keywordtype">size_t</span> i = 0; i < numElements; i++)</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  pHalf[i] = <a class="code" href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a>(srcFloat32Buffer[i]);</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> }</div> +</div><!-- fragment --> +<p class="reference">References <a class="el" href="_assert_8hpp_source.xhtml#l00014">ARMNN_ASSERT</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_neon_convert_fp32_to_fp16_workload_8cpp_source.xhtml#l00053">NeonConvertFp32ToFp16Workload::Execute()</a>, <a class="el" href="_convert_constants_8hpp_source.xhtml#l00044">Float32ToFloat16::Func()</a>, and <a class="el" href="_base_iterator_8hpp_source.xhtml#l00598">Float16Encoder::Set()</a>.</p> + +</div> +</div> +<a id="a33e468bc160c2b83f049424104c0f420"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a33e468bc160c2b83f049424104c0f420">◆ </a></span>ConvertFloat32ToBFloat16()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static void ConvertFloat32ToBFloat16 </td> + <td>(</td> + <td class="paramtype">const float * </td> + <td class="paramname"><em>srcFloat32Buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>numElements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>dstBFloat16Buffer</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">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/armnnUtils/<a class="el" href="_floating_point_converter_8hpp_source.xhtml">FloatingPointConverter.hpp</a></li> +<li>src/armnnUtils/<a class="el" href="_floating_point_converter_8cpp_source.xhtml">FloatingPointConverter.cpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<div class="ttc" id="anamespacearmnn_xhtml_a0b49aa352b84d572942185ce72cef751"><div class="ttname"><a href="namespacearmnn.xhtml#a0b49aa352b84d572942185ce72cef751">armnn::Half</a></div><div class="ttdeci">half_float::half Half</div><div class="ttdef"><b>Definition:</b> <a href="_half_8hpp_source.xhtml#l00022">Half.hpp:22</a></div></div> +<div class="ttc" id="a_assert_8hpp_xhtml_a5698be69cbd5dfe6c28fcd9867e8cbed"><div class="ttname"><a href="_assert_8hpp.xhtml#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a></div><div class="ttdeci">#define ARMNN_ASSERT(COND)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.xhtml#l00014">Assert.hpp:14</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_utils.xhtml">armnnUtils</a></li><li class="navelem"><a class="el" href="classarmnn_utils_1_1_floating_point_converter.xhtml">FloatingPointConverter</a></li> + <li class="footer">Generated on Thu May 18 2023 10:35:51 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> + </ul> +</div> +</body> +</html> |