zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-27 03:11:16 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
6269c69d0e
mlx/docs/build/html/backend_2metal_2jit_2fft_8h.html
Awni Hannun 6269c69d0e docs update
2025-06-04 01:01:50 +00:00

241 lines
13 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/jit/fft.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>
<script type="text/javascript" src="clipboard.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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">MLX
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</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_4336740ec0075891704443b417fef6cb.html">jit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">fft.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="backend_2metal_2jit_2fft_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 id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a19e5f580e97a92ca879a804ebaa1087c" id="r_a19e5f580e97a92ca879a804ebaa1087c"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19e5f580e97a92ca879a804ebaa1087c">fft_kernel</a></td></tr>
<tr class="separator:a19e5f580e97a92ca879a804ebaa1087c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca1f201636b6f5a9912fc0502dbe83de" id="r_aca1f201636b6f5a9912fc0502dbe83de"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aca1f201636b6f5a9912fc0502dbe83de">rader_fft_kernel</a></td></tr>
<tr class="separator:aca1f201636b6f5a9912fc0502dbe83de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8252118504948e9781d8a3bf6d482081" id="r_a8252118504948e9781d8a3bf6d482081"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8252118504948e9781d8a3bf6d482081">bluestein_fft_kernel</a></td></tr>
<tr class="separator:a8252118504948e9781d8a3bf6d482081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeca5467dbf53c4324b73fe6ef18d3daf" id="r_aeca5467dbf53c4324b73fe6ef18d3daf"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeca5467dbf53c4324b73fe6ef18d3daf">four_step_fft_kernel</a></td></tr>
<tr class="separator:aeca5467dbf53c4324b73fe6ef18d3daf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a8252118504948e9781d8a3bf6d482081" name="a8252118504948e9781d8a3bf6d482081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8252118504948e9781d8a3bf6d482081">&#9670;&#160;</a></span>bluestein_fft_kernel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::string_view bluestein_fft_kernel</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= R<span class="stringliteral">&quot;(</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;{name}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">bluestein_fft&lt;{tg_mem_size}, {in_T}, {out_T}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {in_T}* in [[buffer(0)]],</span></div>
<div class="line"><span class="stringliteral"> device {out_T}* out [[buffer(1)]],</span></div>
<div class="line"><span class="stringliteral"> const device float2* w_q [[buffer(2)]],</span></div>
<div class="line"><span class="stringliteral"> const device float2* w_k [[buffer(3)]],</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; length,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; n,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; batch_size,</span></div>
<div class="line"><span class="stringliteral"> uint3 elem [[thread_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint3 grid [[threads_per_grid]]);</span></div>
<div class="line"><span class="stringliteral">)&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="a19e5f580e97a92ca879a804ebaa1087c" name="a19e5f580e97a92ca879a804ebaa1087c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19e5f580e97a92ca879a804ebaa1087c">&#9670;&#160;</a></span>fft_kernel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::string_view fft_kernel</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= R<span class="stringliteral">&quot;(</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;{name}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">fft&lt;{tg_mem_size}, {in_T}, {out_T}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {in_T}* in [[buffer(0)]],</span></div>
<div class="line"><span class="stringliteral"> device {out_T}* out [[buffer(1)]],</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; n,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; batch_size,</span></div>
<div class="line"><span class="stringliteral"> uint3 elem [[thread_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint3 grid [[threads_per_grid]]);</span></div>
<div class="line"><span class="stringliteral">)&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="aeca5467dbf53c4324b73fe6ef18d3daf" name="aeca5467dbf53c4324b73fe6ef18d3daf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeca5467dbf53c4324b73fe6ef18d3daf">&#9670;&#160;</a></span>four_step_fft_kernel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::string_view four_step_fft_kernel</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= R<span class="stringliteral">&quot;(</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;{name}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">four_step_fft&lt;{tg_mem_size}, {in_T}, {out_T}, {step}, {real}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {in_T}* in [[buffer(0)]],</span></div>
<div class="line"><span class="stringliteral"> device {out_T}* out [[buffer(1)]],</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; n1,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; n2,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; batch_size,</span></div>
<div class="line"><span class="stringliteral"> uint3 elem [[thread_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint3 grid [[threads_per_grid]]);</span></div>
<div class="line"><span class="stringliteral">)&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
<a id="aca1f201636b6f5a9912fc0502dbe83de" name="aca1f201636b6f5a9912fc0502dbe83de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca1f201636b6f5a9912fc0502dbe83de">&#9670;&#160;</a></span>rader_fft_kernel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr std::string_view rader_fft_kernel</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= R<span class="stringliteral">&quot;(</span></div>
<div class="line"><span class="stringliteral">template [[host_name(&quot;{name}&quot;)]] [[kernel]] void</span></div>
<div class="line"><span class="stringliteral">rader_fft&lt;{tg_mem_size}, {in_T}, {out_T}&gt;(</span></div>
<div class="line"><span class="stringliteral"> const device {in_T}* in [[buffer(0)]],</span></div>
<div class="line"><span class="stringliteral"> device {out_T}* out [[buffer(1)]],</span></div>
<div class="line"><span class="stringliteral"> const device float2* raders_b_q [[buffer(2)]],</span></div>
<div class="line"><span class="stringliteral"> const device short* raders_g_q [[buffer(3)]],</span></div>
<div class="line"><span class="stringliteral"> const device short* raders_g_minus_q [[buffer(4)]],</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; n,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; batch_size,</span></div>
<div class="line"><span class="stringliteral"> constant const int&amp; rader_n,</span></div>
<div class="line"><span class="stringliteral"> uint3 elem [[thread_position_in_grid]],</span></div>
<div class="line"><span class="stringliteral"> uint3 grid [[threads_per_grid]]);</span></div>
<div class="line"><span class="stringliteral">)&quot;</span></div>
</div><!-- fragment -->
</div>
</div>
</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.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink