This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/bf16_math.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -28,12 +35,24 @@
<div id="projectname">MLX
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,22 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
$(function(){initNavTree('bf16__math_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -81,12 +101,6 @@ $(function(){ initResizable(false); });
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="dir_1d446c9bd3c99228254c9484e0bc5c06.html">backend</a></li><li class="navelem"><a class="el" href="dir_d0c977ea65824390717cdb7efc36c157.html">metal</a></li><li class="navelem"><a class="el" href="dir_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">bf16_math.h</div></div>
</div><!--header-->
@@ -94,7 +108,7 @@ $(function(){ initResizable(false); });
<a href="bf16__math_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright © 2023 Apple Inc.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// Metal math for bfloat16</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">/*</span></div>
@@ -320,17 +334,17 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="namespacemetal.html"> 226</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemetal.html">metal</a> {</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span><a class="code hl_define" href="bf16__math_8h.html#a9e9f0fdd6e304522bc88acd22c576842">instantiate_metal_math_funcs</a>(</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keywordtype">float</span>,</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"><a class="line" href="namespacemetal.html#a87c5122c60f9a12afceb9925a5b78ffb"> 232</a></span> __METAL_MAYBE_FAST_MATH__);</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="foldopen" id="foldopen00234" data-start="{" data-end="}">
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="namespacemetal_1_1fast.html"> 234</a></span><span class="keyword">namespace </span>fast {</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="namespacemetal_1_1fast.html"> 234</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemetal_1_1fast.html">fast</a> {</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span><a class="code hl_define" href="bf16__math_8h.html#a9e9f0fdd6e304522bc88acd22c576842">instantiate_metal_math_funcs</a>(</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keywordtype">float</span>,</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="namespacemetal_1_1fast.html#a90d2973f71f83180e7f02e38d11c7a8f"> 240</a></span> __METAL_FAST_MATH__);</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
@@ -338,11 +352,11 @@ $(function(){ initResizable(false); });
</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="foldopen" id="foldopen00244" data-start="{" data-end="}">
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"><a class="line" href="namespacemetal_1_1precise.html"> 244</a></span><span class="keyword">namespace </span>precise {</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"><a class="line" href="namespacemetal_1_1precise.html"> 244</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemetal_1_1precise.html">precise</a> {</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span><a class="code hl_define" href="bf16__math_8h.html#a9e9f0fdd6e304522bc88acd22c576842">instantiate_metal_math_funcs</a>(</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> <span class="keywordtype">float</span>,</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"><a class="line" href="namespacemetal_1_1precise.html#a99f2b2746e813b9ca7b4249afbaf2a14"> 250</a></span> __METAL_PRECISE_MATH__);</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> </div>
@@ -351,7 +365,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span>} <span class="comment">// namespace metal</span></div>
</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span><span class="comment">// Metal simd for bfloat16</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> </div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"><a class="line" href="bf16__math_8h.html#aecc11cb898846d01bfc9faa109fcf791"> 260</a></span><span class="preprocessor">#define instantiate_metal_simd_comm_funcs( \</span></div>
@@ -469,26 +483,31 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemetal.html">metal</a> {</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span> </div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"> 372</span><a class="code hl_define" href="bf16__math_8h.html#aecc11cb898846d01bfc9faa109fcf791">instantiate_metal_simd_comm_funcs</a>(</div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>,</div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>,</div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> uint16_t,</div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> <a class="code hl_function" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a1420e191fa60d707dce327d0938e3088">bfloat16_to_uint16</a>,</div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno"><a class="line" href="namespacemetal.html#a498f1e85107eb5f01ba4435977f8efe0"> 377</a></span> <a class="code hl_function" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a8d066e48cf3e2a0583c71816fa40f7f4">uint16_to_bfloat16</a>);</div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno"><a class="line" href="namespacemetal.html#a048cad0aca52cb737ebf103e76bd1c49"> 378</a></span><a class="code hl_define" href="bf16__math_8h.html#a51688bc24fc9292aaec5f54a58eaa2d0">instantiate_metal_simd_reduction_funcs</a>(<a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>, <a class="code hl_struct" href="struct___m_l_x___b_float16.html">bfloat16_t</a>, <span class="keywordtype">float</span>);</div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno"><a class="line" href="namespacemetal.html#a048cad0aca52cb737ebf103e76bd1c49"> 378</a></span><a class="code hl_define" href="bf16__math_8h.html#a51688bc24fc9292aaec5f54a58eaa2d0">instantiate_metal_simd_reduction_funcs</a>(<a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>, <a class="code hl_typedef" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a>, <span class="keywordtype">float</span>);</div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span> </div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span>} <span class="comment">// namespace metal</span></div>
<div class="ttc" id="abackend_2metal_2kernels_2metal__3__0_2bf16_8h_html_a1420e191fa60d707dce327d0938e3088"><div class="ttname"><a href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a1420e191fa60d707dce327d0938e3088">bfloat16_to_uint16</a></div><div class="ttdeci">uint16_t bfloat16_to_uint16(const bfloat16_t x)</div><div class="ttdef"><b>Definition</b> bf16.h:308</div></div>
<div class="ttc" id="abackend_2metal_2kernels_2metal__3__0_2bf16_8h_html_a7782de82393104dd4ad754ce3b316e82"><div class="ttname"><a href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7782de82393104dd4ad754ce3b316e82">bfloat16_t</a></div><div class="ttdeci">struct _MLX_BFloat16 bfloat16_t</div><div class="ttdef"><b>Definition</b> bf16.h:251</div></div>
<div class="ttc" id="abackend_2metal_2kernels_2metal__3__0_2bf16_8h_html_a8d066e48cf3e2a0583c71816fa40f7f4"><div class="ttname"><a href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a8d066e48cf3e2a0583c71816fa40f7f4">uint16_to_bfloat16</a></div><div class="ttdeci">bfloat16_t uint16_to_bfloat16(const uint16_t x)</div><div class="ttdef"><b>Definition</b> bf16.h:312</div></div>
<div class="ttc" id="abf16__math_8h_html_a51688bc24fc9292aaec5f54a58eaa2d0"><div class="ttname"><a href="bf16__math_8h.html#a51688bc24fc9292aaec5f54a58eaa2d0">instantiate_metal_simd_reduction_funcs</a></div><div class="ttdeci">#define instantiate_metal_simd_reduction_funcs(itype, otype, ctype)</div><div class="ttdef"><b>Definition</b> bf16_math.h:328</div></div>
<div class="ttc" id="abf16__math_8h_html_a9e9f0fdd6e304522bc88acd22c576842"><div class="ttname"><a href="bf16__math_8h.html#a9e9f0fdd6e304522bc88acd22c576842">instantiate_metal_math_funcs</a></div><div class="ttdeci">#define instantiate_metal_math_funcs(itype, otype, ctype, mfast)</div><div class="ttdef"><b>Definition</b> bf16_math.h:33</div></div>
<div class="ttc" id="abf16__math_8h_html_aecc11cb898846d01bfc9faa109fcf791"><div class="ttname"><a href="bf16__math_8h.html#aecc11cb898846d01bfc9faa109fcf791">instantiate_metal_simd_comm_funcs</a></div><div class="ttdeci">#define instantiate_metal_simd_comm_funcs( itype, otype, ctype, itype_to_ctype, ctype_to_otype)</div><div class="ttdef"><b>Definition</b> bf16_math.h:260</div></div>
<div class="ttc" id="anamespacemetal_1_1fast_html"><div class="ttname"><a href="namespacemetal_1_1fast.html">metal::fast</a></div><div class="ttdef"><b>Definition</b> bf16_math.h:234</div></div>
<div class="ttc" id="anamespacemetal_1_1precise_html"><div class="ttname"><a href="namespacemetal_1_1precise.html">metal::precise</a></div><div class="ttdef"><b>Definition</b> bf16_math.h:244</div></div>
<div class="ttc" id="anamespacemetal_html"><div class="ttname"><a href="namespacemetal.html">metal</a></div><div class="ttdef"><b>Definition</b> bf16_math.h:226</div></div>
<div class="ttc" id="astruct___m_l_x___b_float16_html"><div class="ttname"><a href="struct___m_l_x___b_float16.html">_MLX_BFloat16</a></div><div class="ttdef"><b>Definition</b> bf16.h:48</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="dir_1d446c9bd3c99228254c9484e0bc5c06.html">backend</a></li><li class="navelem"><a class="el" href="dir_d0c977ea65824390717cdb7efc36c157.html">metal</a></li><li class="navelem"><a class="el" href="dir_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li><li class="navelem"><a class="el" href="bf16__math_8h.html">bf16_math.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
</ul>
</div>
</body>
</html>