blob: fe3beb048677b6af75ac9ba11890eddf4f2fbc6e [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: BFloat16 Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_b_float16.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
98<a href="classarmnn_1_1_b_float16-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">BFloat16 Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>&gt;</code></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
107Public Member Functions</h2></td></tr>
108<tr class="memitem:a8f4fc25560afea5a7a45cdbf20fc30ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">BFloat16</a> ()</td></tr>
109<tr class="separator:a8f4fc25560afea5a7a45cdbf20fc30ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a2448669b496e643b34aef839c124cf92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a2448669b496e643b34aef839c124cf92">BFloat16</a> (const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;v)=default</td></tr>
111<tr class="separator:a2448669b496e643b34aef839c124cf92"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:a58f28952f1e43061905be5f1789cccfe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a58f28952f1e43061905be5f1789cccfe">BFloat16</a> (uint16_t v)</td></tr>
113<tr class="separator:a58f28952f1e43061905be5f1789cccfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:ac5c86c8ca117ed170c80f74e98b55d9b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#ac5c86c8ca117ed170c80f74e98b55d9b">BFloat16</a> (float v)</td></tr>
115<tr class="separator:ac5c86c8ca117ed170c80f74e98b55d9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:abc4ec9f715112697477f2f425122ce21"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#abc4ec9f715112697477f2f425122ce21">operator float</a> () const</td></tr>
117<tr class="separator:abc4ec9f715112697477f2f425122ce21"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:ad84d47768f03c3e34cff6e82fcc62b5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#ad84d47768f03c3e34cff6e82fcc62b5c">operator=</a> (const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;other)=default</td></tr>
119<tr class="separator:ad84d47768f03c3e34cff6e82fcc62b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a2cb077e0d34d52b8c3a5552533c4600f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a2cb077e0d34d52b8c3a5552533c4600f">operator=</a> (float v)</td></tr>
121<tr class="separator:a2cb077e0d34d52b8c3a5552533c4600f"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:aecfc3fae6930caee98c9fc8b973068a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#aecfc3fae6930caee98c9fc8b973068a8">operator==</a> (const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;r) const</td></tr>
123<tr class="separator:aecfc3fae6930caee98c9fc8b973068a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:afe0f15d338fde36113a613f6e165b0e9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#afe0f15d338fde36113a613f6e165b0e9">ToFloat32</a> () const</td></tr>
125<tr class="separator:afe0f15d338fde36113a613f6e165b0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:afbd0d2d6540777e3898d125b79f6a5bc"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#afbd0d2d6540777e3898d125b79f6a5bc">Val</a> () const</td></tr>
127<tr class="separator:afbd0d2d6540777e3898d125b79f6a5bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table><table class="memberdecls">
129<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
130Static Public Member Functions</h2></td></tr>
131<tr class="memitem:a3ff08d61c8f7403c9f790e2b96d91a9d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a3ff08d61c8f7403c9f790e2b96d91a9d">Float32ToBFloat16</a> (const float v)</td></tr>
132<tr class="separator:a3ff08d61c8f7403c9f790e2b96d91a9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a62b171b39ea69724817f5fe08169ca7d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#a62b171b39ea69724817f5fe08169ca7d">Max</a> ()</td></tr>
134<tr class="separator:a62b171b39ea69724817f5fe08169ca7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:ae80b11dd8875fbf6e76cb054764ca6fb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#ae80b11dd8875fbf6e76cb054764ca6fb">Nan</a> ()</td></tr>
136<tr class="separator:ae80b11dd8875fbf6e76cb054764ca6fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:ae5b250d59f169e00a39ad3ec787db22a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_b_float16.html#ae5b250d59f169e00a39ad3ec787db22a">Inf</a> ()</td></tr>
138<tr class="separator:ae5b250d59f169e00a39ad3ec787db22a"><td class="memSeparator" colspan="2">&#160;</td></tr>
139</table>
140<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141<div class="textblock">
142<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00015">15</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
143</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
144<a id="a8f4fc25560afea5a7a45cdbf20fc30ca"></a>
145<h2 class="memtitle"><span class="permalink"><a href="#a8f4fc25560afea5a7a45cdbf20fc30ca">&#9670;&nbsp;</a></span>BFloat16() <span class="overload">[1/4]</span></h2>
146
147<div class="memitem">
148<div class="memproto">
149<table class="mlabels">
150 <tr>
151 <td class="mlabels-left">
152 <table class="memname">
153 <tr>
154 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> </td>
155 <td>(</td>
156 <td class="paramname"></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160 </td>
161 <td class="mlabels-right">
162<span class="mlabels"><span class="mlabel">inline</span></span> </td>
163 </tr>
164</table>
165</div><div class="memdoc">
166
167<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00018">18</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
168<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; : m_Value(0)</div>
169<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; {}</div>
170</div><!-- fragment -->
171<p class="reference">Referenced by <a class="el" href="_b_float16_8hpp_source.html#l00112">BFloat16::Inf()</a>, <a class="el" href="_b_float16_8hpp_source.html#l00100">BFloat16::Max()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00106">BFloat16::Nan()</a>.</p>
172
173</div>
174</div>
175<a id="a2448669b496e643b34aef839c124cf92"></a>
176<h2 class="memtitle"><span class="permalink"><a href="#a2448669b496e643b34aef839c124cf92">&#9670;&nbsp;</a></span>BFloat16() <span class="overload">[2/4]</span></h2>
177
178<div class="memitem">
179<div class="memproto">
180<table class="mlabels">
181 <tr>
182 <td class="mlabels-left">
183 <table class="memname">
184 <tr>
185 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> </td>
186 <td>(</td>
187 <td class="paramtype">const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;&#160;</td>
188 <td class="paramname"><em>v</em></td><td>)</td>
189 <td></td>
190 </tr>
191 </table>
192 </td>
193 <td class="mlabels-right">
194<span class="mlabels"><span class="mlabel">default</span></span> </td>
195 </tr>
196</table>
197</div><div class="memdoc">
198
199</div>
200</div>
201<a id="a58f28952f1e43061905be5f1789cccfe"></a>
202<h2 class="memtitle"><span class="permalink"><a href="#a58f28952f1e43061905be5f1789cccfe">&#9670;&nbsp;</a></span>BFloat16() <span class="overload">[3/4]</span></h2>
203
204<div class="memitem">
205<div class="memproto">
206<table class="mlabels">
207 <tr>
208 <td class="mlabels-left">
209 <table class="memname">
210 <tr>
211 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> </td>
212 <td>(</td>
213 <td class="paramtype">uint16_t&#160;</td>
214 <td class="paramname"><em>v</em></td><td>)</td>
215 <td></td>
216 </tr>
217 </table>
218 </td>
219 <td class="mlabels-right">
220<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
221 </tr>
222</table>
223</div><div class="memdoc">
224
225<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00024">24</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
226<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; : m_Value(v)</div>
227<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {}</div>
228</div><!-- fragment -->
229</div>
230</div>
231<a id="ac5c86c8ca117ed170c80f74e98b55d9b"></a>
232<h2 class="memtitle"><span class="permalink"><a href="#ac5c86c8ca117ed170c80f74e98b55d9b">&#9670;&nbsp;</a></span>BFloat16() <span class="overload">[4/4]</span></h2>
233
234<div class="memitem">
235<div class="memproto">
236<table class="mlabels">
237 <tr>
238 <td class="mlabels-left">
239 <table class="memname">
240 <tr>
241 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> </td>
242 <td>(</td>
243 <td class="paramtype">float&#160;</td>
244 <td class="paramname"><em>v</em></td><td>)</td>
245 <td></td>
246 </tr>
247 </table>
248 </td>
249 <td class="mlabels-right">
250<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
251 </tr>
252</table>
253</div><div class="memdoc">
254
255<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00028">28</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
256<div class="fragment"><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div>
257<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; m_Value = <a class="code" href="classarmnn_1_1_b_float16.html#a3ff08d61c8f7403c9f790e2b96d91a9d">Float32ToBFloat16</a>(v).<a class="code" href="classarmnn_1_1_b_float16.html#afbd0d2d6540777e3898d125b79f6a5bc">Val</a>();</div>
258<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div>
259</div><!-- fragment -->
260<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00051">BFloat16::Float32ToBFloat16()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00095">BFloat16::Val()</a>.</p>
261
262</div>
263</div>
264<h2 class="groupheader">Member Function Documentation</h2>
265<a id="a3ff08d61c8f7403c9f790e2b96d91a9d"></a>
266<h2 class="memtitle"><span class="permalink"><a href="#a3ff08d61c8f7403c9f790e2b96d91a9d">&#9670;&nbsp;</a></span>Float32ToBFloat16()</h2>
267
268<div class="memitem">
269<div class="memproto">
270<table class="mlabels">
271 <tr>
272 <td class="mlabels-left">
273 <table class="memname">
274 <tr>
275 <td class="memname">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> Float32ToBFloat16 </td>
276 <td>(</td>
277 <td class="paramtype">const float&#160;</td>
278 <td class="paramname"><em>v</em></td><td>)</td>
279 <td></td>
280 </tr>
281 </table>
282 </td>
283 <td class="mlabels-right">
284<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
285 </tr>
286</table>
287</div><div class="memdoc">
288
289<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00051">51</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
290<div class="fragment"><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div>
291<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">if</span> (std::isnan(v))</div>
292<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; {</div>
293<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_b_float16.html#ae80b11dd8875fbf6e76cb054764ca6fb">Nan</a>();</div>
294<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
295<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">else</span></div>
296<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div>
297<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Round value to the nearest even</span></div>
298<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// Float32</span></div>
299<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// S EEEEEEEE MMMMMMLRMMMMMMMMMMMMMMM</span></div>
300<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// BFloat16</span></div>
301<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// S EEEEEEEE MMMMMML</span></div>
302<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">// LSB (L): Least significat bit of BFloat16 (last bit of the Mantissa of BFloat16)</span></div>
303<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// R: Rounding bit</span></div>
304<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// LSB = 0, R = 0 -&gt; round down</span></div>
305<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// LSB = 1, R = 0 -&gt; round down</span></div>
306<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// LSB = 0, R = 1, all the rest = 0 -&gt; round down</span></div>
307<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">// LSB = 1, R = 1 -&gt; round up</span></div>
308<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// LSB = 0, R = 1 -&gt; round up</span></div>
309<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> uint32_t* u32 = <span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>uint32_t*<span class="keyword">&gt;</span>(&amp;v);</div>
310<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint16_t u16 = <span class="keyword">static_cast&lt;</span>uint16_t<span class="keyword">&gt;</span>(*u32 &gt;&gt; 16u);</div>
311<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">// Mark the LSB</span></div>
312<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">const</span> uint16_t lsb = u16 &amp; 0x0001;</div>
313<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">// Mark the error to be truncate (the rest of 16 bits of FP32)</span></div>
314<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">const</span> uint16_t <a class="code" href="namespacearmnn.html#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">error</a> = <span class="keyword">static_cast&lt;</span>uint16_t<span class="keyword">&gt;</span>((*u32 &amp; 0x0000FFFF));</div>
315<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">if</span> ((error &gt; 0x8000 || (error == 0x8000 &amp;&amp; lsb == 1)))</div>
316<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; {</div>
317<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; u16++;</div>
318<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div>
319<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">BFloat16</a> b(u16);</div>
320<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> b;</div>
321<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div>
322<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div>
323</div><!-- fragment -->
324<p class="reference">References <a class="el" href="namespacearmnn.html#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::error</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00106">BFloat16::Nan()</a>.</p>
325
326<p class="reference">Referenced by <a class="el" href="_b_float16_8hpp_source.html#l00028">BFloat16::BFloat16()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00040">BFloat16::operator=()</a>.</p>
327
328</div>
329</div>
330<a id="ae5b250d59f169e00a39ad3ec787db22a"></a>
331<h2 class="memtitle"><span class="permalink"><a href="#ae5b250d59f169e00a39ad3ec787db22a">&#9670;&nbsp;</a></span>Inf()</h2>
332
333<div class="memitem">
334<div class="memproto">
335<table class="mlabels">
336 <tr>
337 <td class="mlabels-left">
338 <table class="memname">
339 <tr>
340 <td class="memname">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> Inf </td>
341 <td>(</td>
342 <td class="paramname"></td><td>)</td>
343 <td></td>
344 </tr>
345 </table>
346 </td>
347 <td class="mlabels-right">
348<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
349 </tr>
350</table>
351</div><div class="memdoc">
352
353<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00112">112</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
354<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; {</div>
355<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; uint16_t infVal = 0x7F80;</div>
356<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">BFloat16</a>(infVal);</div>
357<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
358</div><!-- fragment -->
359<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00018">BFloat16::BFloat16()</a>.</p>
360
361</div>
362</div>
363<a id="a62b171b39ea69724817f5fe08169ca7d"></a>
364<h2 class="memtitle"><span class="permalink"><a href="#a62b171b39ea69724817f5fe08169ca7d">&#9670;&nbsp;</a></span>Max()</h2>
365
366<div class="memitem">
367<div class="memproto">
368<table class="mlabels">
369 <tr>
370 <td class="mlabels-left">
371 <table class="memname">
372 <tr>
373 <td class="memname">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> Max </td>
374 <td>(</td>
375 <td class="paramname"></td><td>)</td>
376 <td></td>
377 </tr>
378 </table>
379 </td>
380 <td class="mlabels-right">
381<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
382 </tr>
383</table>
384</div><div class="memdoc">
385
386<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00100">100</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
387<div class="fragment"><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div>
388<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; uint16_t max = 0x7F7F;</div>
389<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">BFloat16</a>(max);</div>
390<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div>
391</div><!-- fragment -->
392<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00018">BFloat16::BFloat16()</a>.</p>
393
394</div>
395</div>
396<a id="ae80b11dd8875fbf6e76cb054764ca6fb"></a>
397<h2 class="memtitle"><span class="permalink"><a href="#ae80b11dd8875fbf6e76cb054764ca6fb">&#9670;&nbsp;</a></span>Nan()</h2>
398
399<div class="memitem">
400<div class="memproto">
401<table class="mlabels">
402 <tr>
403 <td class="mlabels-left">
404 <table class="memname">
405 <tr>
406 <td class="memname">static <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> Nan </td>
407 <td>(</td>
408 <td class="paramname"></td><td>)</td>
409 <td></td>
410 </tr>
411 </table>
412 </td>
413 <td class="mlabels-right">
414<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
415 </tr>
416</table>
417</div><div class="memdoc">
418
419<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00106">106</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
420<div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
421<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; uint16_t nan = 0x7FC0;</div>
422<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">BFloat16</a>(nan);</div>
423<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div>
424</div><!-- fragment -->
425<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00018">BFloat16::BFloat16()</a>.</p>
426
427<p class="reference">Referenced by <a class="el" href="_b_float16_8hpp_source.html#l00051">BFloat16::Float32ToBFloat16()</a>.</p>
428
429</div>
430</div>
431<a id="abc4ec9f715112697477f2f425122ce21"></a>
432<h2 class="memtitle"><span class="permalink"><a href="#abc4ec9f715112697477f2f425122ce21">&#9670;&nbsp;</a></span>operator float()</h2>
433
434<div class="memitem">
435<div class="memproto">
436<table class="mlabels">
437 <tr>
438 <td class="mlabels-left">
439 <table class="memname">
440 <tr>
441 <td class="memname">operator float </td>
442 <td>(</td>
443 <td class="paramname"></td><td>)</td>
444 <td> const</td>
445 </tr>
446 </table>
447 </td>
448 <td class="mlabels-right">
449<span class="mlabels"><span class="mlabel">inline</span></span> </td>
450 </tr>
451</table>
452</div><div class="memdoc">
453
454<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00033">33</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
455<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
456<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarmnn_1_1_b_float16.html#afe0f15d338fde36113a613f6e165b0e9">ToFloat32</a>();</div>
457<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
458</div><!-- fragment -->
459<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00086">BFloat16::ToFloat32()</a>.</p>
460
461</div>
462</div>
463<a id="ad84d47768f03c3e34cff6e82fcc62b5c"></a>
464<h2 class="memtitle"><span class="permalink"><a href="#ad84d47768f03c3e34cff6e82fcc62b5c">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
465
466<div class="memitem">
467<div class="memproto">
468<table class="mlabels">
469 <tr>
470 <td class="mlabels-left">
471 <table class="memname">
472 <tr>
473 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&amp; operator= </td>
474 <td>(</td>
475 <td class="paramtype">const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;&#160;</td>
476 <td class="paramname"><em>other</em></td><td>)</td>
477 <td></td>
478 </tr>
479 </table>
480 </td>
481 <td class="mlabels-right">
482<span class="mlabels"><span class="mlabel">default</span></span> </td>
483 </tr>
484</table>
485</div><div class="memdoc">
486
487</div>
488</div>
489<a id="a2cb077e0d34d52b8c3a5552533c4600f"></a>
490<h2 class="memtitle"><span class="permalink"><a href="#a2cb077e0d34d52b8c3a5552533c4600f">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
491
492<div class="memitem">
493<div class="memproto">
494<table class="mlabels">
495 <tr>
496 <td class="mlabels-left">
497 <table class="memname">
498 <tr>
499 <td class="memname"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a>&amp; operator= </td>
500 <td>(</td>
501 <td class="paramtype">float&#160;</td>
502 <td class="paramname"><em>v</em></td><td>)</td>
503 <td></td>
504 </tr>
505 </table>
506 </td>
507 <td class="mlabels-right">
508<span class="mlabels"><span class="mlabel">inline</span></span> </td>
509 </tr>
510</table>
511</div><div class="memdoc">
512
513<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00040">40</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
514<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div>
515<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; m_Value = <a class="code" href="classarmnn_1_1_b_float16.html#a3ff08d61c8f7403c9f790e2b96d91a9d">Float32ToBFloat16</a>(v).<a class="code" href="classarmnn_1_1_b_float16.html#afbd0d2d6540777e3898d125b79f6a5bc">Val</a>();</div>
516<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
517<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
518</div><!-- fragment -->
519<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00051">BFloat16::Float32ToBFloat16()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00095">BFloat16::Val()</a>.</p>
520
521</div>
522</div>
523<a id="aecfc3fae6930caee98c9fc8b973068a8"></a>
524<h2 class="memtitle"><span class="permalink"><a href="#aecfc3fae6930caee98c9fc8b973068a8">&#9670;&nbsp;</a></span>operator==()</h2>
525
526<div class="memitem">
527<div class="memproto">
528<table class="mlabels">
529 <tr>
530 <td class="mlabels-left">
531 <table class="memname">
532 <tr>
533 <td class="memname">bool operator== </td>
534 <td>(</td>
535 <td class="paramtype">const <a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a> &amp;&#160;</td>
536 <td class="paramname"><em>r</em></td><td>)</td>
537 <td> const</td>
538 </tr>
539 </table>
540 </td>
541 <td class="mlabels-right">
542<span class="mlabels"><span class="mlabel">inline</span></span> </td>
543 </tr>
544</table>
545</div><div class="memdoc">
546
547<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00046">46</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
548<div class="fragment"><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
549<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> m_Value == r.Val();</div>
550<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
551</div><!-- fragment -->
552<p class="reference">References <a class="el" href="_b_float16_8hpp_source.html#l00095">BFloat16::Val()</a>.</p>
553
554</div>
555</div>
556<a id="afe0f15d338fde36113a613f6e165b0e9"></a>
557<h2 class="memtitle"><span class="permalink"><a href="#afe0f15d338fde36113a613f6e165b0e9">&#9670;&nbsp;</a></span>ToFloat32()</h2>
558
559<div class="memitem">
560<div class="memproto">
561<table class="mlabels">
562 <tr>
563 <td class="mlabels-left">
564 <table class="memname">
565 <tr>
566 <td class="memname">float ToFloat32 </td>
567 <td>(</td>
568 <td class="paramname"></td><td>)</td>
569 <td> const</td>
570 </tr>
571 </table>
572 </td>
573 <td class="mlabels-right">
574<span class="mlabels"><span class="mlabel">inline</span></span> </td>
575 </tr>
576</table>
577</div><div class="memdoc">
578
579<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00086">86</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
580<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
581<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">const</span> uint32_t u32 = <span class="keyword">static_cast&lt;</span>uint32_t<span class="keyword">&gt;</span>(m_Value &lt;&lt; 16u);</div>
582<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">float</span> f32;</div>
583<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; static_assert(<span class="keyword">sizeof</span> u32 == <span class="keyword">sizeof</span> f32, <span class="stringliteral">&quot;&quot;</span>);</div>
584<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; std::memcpy(&amp;f32, &amp;u32, <span class="keyword">sizeof</span> u32);</div>
585<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> f32;</div>
586<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div>
587</div><!-- fragment -->
588<p class="reference">Referenced by <a class="el" href="_b_float16_8hpp_source.html#l00033">BFloat16::operator float()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00122">armnn::operator&lt;&lt;()</a>.</p>
589
590</div>
591</div>
592<a id="afbd0d2d6540777e3898d125b79f6a5bc"></a>
593<h2 class="memtitle"><span class="permalink"><a href="#afbd0d2d6540777e3898d125b79f6a5bc">&#9670;&nbsp;</a></span>Val()</h2>
594
595<div class="memitem">
596<div class="memproto">
597<table class="mlabels">
598 <tr>
599 <td class="mlabels-left">
600 <table class="memname">
601 <tr>
602 <td class="memname">uint16_t Val </td>
603 <td>(</td>
604 <td class="paramname"></td><td>)</td>
605 <td> const</td>
606 </tr>
607 </table>
608 </td>
609 <td class="mlabels-right">
610<span class="mlabels"><span class="mlabel">inline</span></span> </td>
611 </tr>
612</table>
613</div><div class="memdoc">
614
615<p class="definition">Definition at line <a class="el" href="_b_float16_8hpp_source.html#l00095">95</a> of file <a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a>.</p>
616<div class="fragment"><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; {</div>
617<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> m_Value;</div>
618<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div>
619</div><!-- fragment -->
620<p class="reference">Referenced by <a class="el" href="_b_float16_8hpp_source.html#l00028">BFloat16::BFloat16()</a>, <a class="el" href="_b_float16_8hpp_source.html#l00122">armnn::operator&lt;&lt;()</a>, <a class="el" href="_b_float16_8hpp_source.html#l00040">BFloat16::operator=()</a>, and <a class="el" href="_b_float16_8hpp_source.html#l00046">BFloat16::operator==()</a>.</p>
621
622</div>
623</div>
624<hr/>The documentation for this class was generated from the following file:<ul>
625<li>src/armnnUtils/<a class="el" href="_b_float16_8hpp_source.html">BFloat16.hpp</a></li>
626</ul>
627</div><!-- contents -->
628</div><!-- doc-content -->
629<div class="ttc" id="aclassarmnn_1_1_b_float16_html_afe0f15d338fde36113a613f6e165b0e9"><div class="ttname"><a href="classarmnn_1_1_b_float16.html#afe0f15d338fde36113a613f6e165b0e9">armnn::BFloat16::ToFloat32</a></div><div class="ttdeci">float ToFloat32() const</div><div class="ttdef"><b>Definition:</b> <a href="_b_float16_8hpp_source.html#l00086">BFloat16.hpp:86</a></div></div>
630<div class="ttc" id="aclassarmnn_1_1_b_float16_html_a8f4fc25560afea5a7a45cdbf20fc30ca"><div class="ttname"><a href="classarmnn_1_1_b_float16.html#a8f4fc25560afea5a7a45cdbf20fc30ca">armnn::BFloat16::BFloat16</a></div><div class="ttdeci">BFloat16()</div><div class="ttdef"><b>Definition:</b> <a href="_b_float16_8hpp_source.html#l00018">BFloat16.hpp:18</a></div></div>
631<div class="ttc" id="anamespacearmnn_html_a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282"><div class="ttname"><a href="namespacearmnn.html#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::BoostLogSeverityMapping::error</a></div><div class="ttdeci">@ error</div></div>
632<div class="ttc" id="aclassarmnn_1_1_b_float16_html_afbd0d2d6540777e3898d125b79f6a5bc"><div class="ttname"><a href="classarmnn_1_1_b_float16.html#afbd0d2d6540777e3898d125b79f6a5bc">armnn::BFloat16::Val</a></div><div class="ttdeci">uint16_t Val() const</div><div class="ttdef"><b>Definition:</b> <a href="_b_float16_8hpp_source.html#l00095">BFloat16.hpp:95</a></div></div>
633<div class="ttc" id="aclassarmnn_1_1_b_float16_html_ae80b11dd8875fbf6e76cb054764ca6fb"><div class="ttname"><a href="classarmnn_1_1_b_float16.html#ae80b11dd8875fbf6e76cb054764ca6fb">armnn::BFloat16::Nan</a></div><div class="ttdeci">static BFloat16 Nan()</div><div class="ttdef"><b>Definition:</b> <a href="_b_float16_8hpp_source.html#l00106">BFloat16.hpp:106</a></div></div>
634<div class="ttc" id="aclassarmnn_1_1_b_float16_html_a3ff08d61c8f7403c9f790e2b96d91a9d"><div class="ttname"><a href="classarmnn_1_1_b_float16.html#a3ff08d61c8f7403c9f790e2b96d91a9d">armnn::BFloat16::Float32ToBFloat16</a></div><div class="ttdeci">static BFloat16 Float32ToBFloat16(const float v)</div><div class="ttdef"><b>Definition:</b> <a href="_b_float16_8hpp_source.html#l00051">BFloat16.hpp:51</a></div></div>
635<!-- start footer part -->
636<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
637 <ul>
638 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_b_float16.html">BFloat16</a></li>
639 <li class="footer">Generated on Thu May 16 2024 09:31:54 for Arm NN by
640 <a href="http://www.doxygen.org/index.html">
641 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
642 </ul>
643</div>
644</body>
645</html>