blob: c24105eaed827f892c1f803dcc87a3a4346cc358 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/3rdparty/mshadow/mshadow/bfloat.h File 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="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>
<link href="doxygen.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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</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&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_3e48ced36faa4eaa1b41f6d960bf0edb.html">mshadow</a></li><li class="navelem"><a class="el" href="dir_00b035bb2ad81894e6ad291054ea5f82.html">mshadow</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">bfloat.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>definition of bfloat type.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h_source.html">./base.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for bfloat.h:</div>
<div class="dyncontent">
<div class="center"><img src="bfloat_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2mshadow_2mshadow_2bfloat_8h" alt=""/></div>
<!-- MAP 0 -->
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="bfloat_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2mshadow_2mshadow_2bfloat_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="bfloat_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemshadow"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemshadow.html">mshadow</a></td></tr>
<tr class="memdesc:namespacemshadow"><td class="mdescLeft">&#160;</td><td class="mdescRight">overloaded + operator between half_t and bf16_t <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemshadow_1_1bfloat"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemshadow_1_1bfloat.html">mshadow::bfloat</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:af49a3d746bfd937f41d012e8b2cc86bc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#af49a3d746bfd937f41d012e8b2cc86bc">MSHADOW_BF16_OPERATOR_TYPE</a>(RTYPE, ITYPE, OP)</td></tr>
<tr class="separator:af49a3d746bfd937f41d012e8b2cc86bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e06c066528729936c79459e40137073"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#a3e06c066528729936c79459e40137073">MSHADOW_BF16_OPERATOR</a>(RTYPE, OP)</td></tr>
<tr class="separator:a3e06c066528729936c79459e40137073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a490630e7073dde324b3c2d34f6bd5b2a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#a490630e7073dde324b3c2d34f6bd5b2a">MSHADOW_BF16_ASSIGNOP</a>(AOP, OP)</td></tr>
<tr class="separator:a490630e7073dde324b3c2d34f6bd5b2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebaf8e8a04017fc6fcb987956dddb8fc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#aebaf8e8a04017fc6fcb987956dddb8fc">MSHADOW_BF16_CONVERSIONOP</a>(T)</td></tr>
<tr class="separator:aebaf8e8a04017fc6fcb987956dddb8fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab31d5d1e2e21e0fc5dd6f40e276fdd43"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#ab31d5d1e2e21e0fc5dd6f40e276fdd43">MSHADOW_BF16_MIN</a>&#160;&#160;&#160;mshadow::bfloat::bf16_t::Binary(0xFF7F);</td></tr>
<tr class="memdesc:ab31d5d1e2e21e0fc5dd6f40e276fdd43"><td class="mdescLeft">&#160;</td><td class="mdescRight">overloaded + operator for bf16_t <a href="bfloat_8h.html#ab31d5d1e2e21e0fc5dd6f40e276fdd43">More...</a><br /></td></tr>
<tr class="separator:ab31d5d1e2e21e0fc5dd6f40e276fdd43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d5d63ecb7104078d465a0074f9d9059"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#a3d5d63ecb7104078d465a0074f9d9059">MSHADOW_BF16_MAX</a>&#160;&#160;&#160;mshadow::bfloat::bf16_t::Binary(0x7F7F);</td></tr>
<tr class="separator:a3d5d63ecb7104078d465a0074f9d9059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ec28a1a9aa829211bb9963eb967c245"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#a9ec28a1a9aa829211bb9963eb967c245">MSHADOW_BF16_SIGN_BIT</a>&#160;&#160;&#160;0x8000</td></tr>
<tr class="separator:a9ec28a1a9aa829211bb9963eb967c245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3e1c33244a89e2dd8a1f5697c10ff7b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bfloat_8h.html#ad3e1c33244a89e2dd8a1f5697c10ff7b">MSHADOW_BF16_EXPONENT_BITS</a>&#160;&#160;&#160;0x7f80</td></tr>
<tr class="separator:ad3e1c33244a89e2dd8a1f5697c10ff7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a30cf4b49f675c62509c5a9eb802da5ff"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemshadow_1_1bfloat.html#a30cf4b49f675c62509c5a9eb802da5ff">mshadow::bfloat::MSHADOW_ALIGNED</a> (2) bf16_t</td></tr>
<tr class="separator:a30cf4b49f675c62509c5a9eb802da5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>definition of bfloat type. </p>
<dl class="section author"><dt>Author</dt><dd>Zhennan Qin </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a490630e7073dde324b3c2d34f6bd5b2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a490630e7073dde324b3c2d34f6bd5b2a">&#9670;&nbsp;</a></span>MSHADOW_BF16_ASSIGNOP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_ASSIGNOP</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">AOP, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">OP&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; \</div>
<div class="line"> MSHADOW_XINLINE bf16_t <span class="keyword">operator</span> AOP (<span class="keyword">const</span> T&amp; a) { \</div>
<div class="line"> return *<span class="keyword">this</span> = bf16_t(<span class="keywordtype">float</span>(*<span class="keyword">this</span>) OP <span class="keywordtype">float</span>(a)); <span class="comment">/* NOLINT(*)*/</span> \</div>
<div class="line"> } \</div>
<div class="line"> template&lt;typename T&gt; \</div>
<div class="line"> MSHADOW_XINLINE bf16_t <span class="keyword">operator</span> AOP (<span class="keyword">const</span> <span class="keyword">volatile</span> T&amp; a)<span class="keyword"> volatile </span>{ \</div>
<div class="line"> return *<span class="keyword">this</span> = bf16_t(<span class="keywordtype">float</span>(*<span class="keyword">this</span>) OP <span class="keywordtype">float</span>(a)); <span class="comment">/* NOLINT(*)*/</span> \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="aebaf8e8a04017fc6fcb987956dddb8fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebaf8e8a04017fc6fcb987956dddb8fc">&#9670;&nbsp;</a></span>MSHADOW_BF16_CONVERSIONOP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_CONVERSIONOP</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">T</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <span class="keyword">operator</span> T()<span class="keyword"> const </span>{ \</div>
<div class="line"> return T(BF16ToFloat(bf16_)); <span class="comment">/* NOLINT(*)*/</span> \</div>
<div class="line"> } \</div>
<div class="line"> MSHADOW_XINLINE <span class="keyword">operator</span> T()<span class="keyword"> const volatile </span>{ \</div>
<div class="line"> return T(BF16ToFloat(bf16_)); <span class="comment">/* NOLINT(*)*/</span> \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="ad3e1c33244a89e2dd8a1f5697c10ff7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3e1c33244a89e2dd8a1f5697c10ff7b">&#9670;&nbsp;</a></span>MSHADOW_BF16_EXPONENT_BITS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_EXPONENT_BITS&#160;&#160;&#160;0x7f80</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3d5d63ecb7104078d465a0074f9d9059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d5d63ecb7104078d465a0074f9d9059">&#9670;&nbsp;</a></span>MSHADOW_BF16_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_MAX&#160;&#160;&#160;mshadow::bfloat::bf16_t::Binary(0x7F7F);</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab31d5d1e2e21e0fc5dd6f40e276fdd43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab31d5d1e2e21e0fc5dd6f40e276fdd43">&#9670;&nbsp;</a></span>MSHADOW_BF16_MIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_MIN&#160;&#160;&#160;mshadow::bfloat::bf16_t::Binary(0xFF7F);</td>
</tr>
</table>
</div><div class="memdoc">
<p>overloaded + operator for bf16_t </p>
<p>overloaded - operator for bf16_t</p>
<p>overloaded * operator for bf16_t</p>
<p>overloaded / operator for bf16_t</p>
<p>overloaded &gt; operator for bf16_t</p>
<p>overloaded &lt; operator for bf16_t</p>
<p>overloaded &gt;= operator for bf16_t</p>
<p>overloaded &lt;= operator for bf16_t </p>
</div>
</div>
<a id="a3e06c066528729936c79459e40137073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e06c066528729936c79459e40137073">&#9670;&nbsp;</a></span>MSHADOW_BF16_OPERATOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_OPERATOR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">RTYPE, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">OP&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> RTYPE <span class="keyword">operator</span> OP (bf16_t a, bf16_t b) { \</div>
<div class="line"> return RTYPE(<span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(a) OP <span class="keywordtype">float</span>(b)); <span class="comment">/* NOLINT(*) */</span> \</div>
<div class="line"> } \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, <span class="keywordtype">float</span>, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">double</span>, <span class="keywordtype">double</span>, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, int8_t, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, uint8_t, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, int32_t, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, uint32_t, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, int64_t, OP) \</div>
<div class="line"> MSHADOW_BF16_OPERATOR_TYPE(<span class="keywordtype">float</span>, uint64_t, OP)</div>
</div><!-- fragment -->
</div>
</div>
<a id="af49a3d746bfd937f41d012e8b2cc86bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49a3d746bfd937f41d012e8b2cc86bc">&#9670;&nbsp;</a></span>MSHADOW_BF16_OPERATOR_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_OPERATOR_TYPE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">RTYPE, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">ITYPE, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">OP&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> RTYPE <span class="keyword">operator</span> OP (ITYPE a, bf16_t b) { \</div>
<div class="line"> return RTYPE(a OP <span class="keywordtype">float</span>(b)); <span class="comment">/* NOLINT(*) */</span> \</div>
<div class="line"> } \</div>
<div class="line"> MSHADOW_XINLINE RTYPE <span class="keyword">operator</span> OP (bf16_t a, ITYPE b) { \</div>
<div class="line"> return RTYPE(<span class="keywordtype">float</span>(a) OP b); <span class="comment">/* NOLINT(*) */</span> \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a9ec28a1a9aa829211bb9963eb967c245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ec28a1a9aa829211bb9963eb967c245">&#9670;&nbsp;</a></span>MSHADOW_BF16_SIGN_BIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSHADOW_BF16_SIGN_BIT&#160;&#160;&#160;0x8000</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="a3rdparty_2mshadow_2mshadow_2base_8h_html_af205b8ab4d8733133d590df7d2639d69"><div class="ttname"><a href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a></div><div class="ttdeci">#define MSHADOW_XINLINE</div><div class="ttdef"><b>Definition:</b> base.h:228</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>