This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 830f99716d
commit 231caa94a6
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/sort.h File Reference</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('sort_8h.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="summary">
<a href="#nested-classes">Classes</a> &#124;
@@ -121,22 +135,22 @@ Macros</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6e8c2da4975a8001fd5ddf211a3058b7" id="r_a6e8c2da4975a8001fd5ddf211a3058b7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a6e8c2da4975a8001fd5ddf211a3058b7" id="r_a6e8c2da4975a8001fd5ddf211a3058b7"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:a6e8c2da4975a8001fd5ddf211a3058b7"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6e8c2da4975a8001fd5ddf211a3058b7">thread_swap</a> (thread T &amp;a, thread T &amp;b)</td></tr>
<tr class="separator:a6e8c2da4975a8001fd5ddf211a3058b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93f14092416169c4449141043ac45ffd" id="r_a93f14092416169c4449141043ac45ffd"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a93f14092416169c4449141043ac45ffd" id="r_a93f14092416169c4449141043ac45ffd"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a93f14092416169c4449141043ac45ffd"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a93f14092416169c4449141043ac45ffd">block_sort</a> (const device T *inp, device U *out, const constant int &amp;size_sorted_axis, const constant int &amp;in_stride_sorted_axis, const constant int &amp;out_stride_sorted_axis, const constant int &amp;in_stride_segment_axis, const constant int &amp;out_stride_segment_axis, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:a93f14092416169c4449141043ac45ffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ee3de195a6f9c33aa91ac52461808ad" id="r_a4ee3de195a6f9c33aa91ac52461808ad"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a4ee3de195a6f9c33aa91ac52461808ad"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4ee3de195a6f9c33aa91ac52461808ad">block_sort_nc</a> (const device T *inp, device U *out, const constant int &amp;size_sorted_axis, const constant int &amp;in_stride_sorted_axis, const constant int &amp;out_stride_sorted_axis, const constant int &amp;nc_dim, const constant int *nc_shape, const constant size_t *in_nc_strides, const constant size_t *out_nc_strides, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:a4ee3de195a6f9c33aa91ac52461808ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa48ff1aff1e9dc1301b6781aa0721d6b" id="r_aa48ff1aff1e9dc1301b6781aa0721d6b"><td class="memTemplParams" colspan="2">template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:aa48ff1aff1e9dc1301b6781aa0721d6b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa48ff1aff1e9dc1301b6781aa0721d6b">mb_block_sort</a> (const device val_t *inp, device val_t *out_vals, device idx_t *out_idxs, const constant int &amp;size_sorted_axis, const constant int &amp;stride_sorted_axis, const constant int &amp;nc_dim, const constant int *nc_shape, const constant size_t *nc_strides, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:aa48ff1aff1e9dc1301b6781aa0721d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32cbe4163b8b0f5cb2c97b256119a4b2" id="r_a32cbe4163b8b0f5cb2c97b256119a4b2"><td class="memTemplParams" colspan="2">template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:ad272ef4422c75565a79b7f5e751bb247" id="r_ad272ef4422c75565a79b7f5e751bb247"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:ad272ef4422c75565a79b7f5e751bb247"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad272ef4422c75565a79b7f5e751bb247">block_sort_nc</a> (const device T *inp, device U *out, const constant int &amp;size_sorted_axis, const constant int &amp;in_stride_sorted_axis, const constant int &amp;out_stride_sorted_axis, const constant int &amp;nc_dim, const constant int *nc_shape, const constant int64_t *in_nc_strides, const constant int64_t *out_nc_strides, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:ad272ef4422c75565a79b7f5e751bb247"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b5b1180af2b8c6ab814eadd701ce4ba" id="r_a7b5b1180af2b8c6ab814eadd701ce4ba"><td class="memTemplParams" colspan="2">template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a7b5b1180af2b8c6ab814eadd701ce4ba"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7b5b1180af2b8c6ab814eadd701ce4ba">mb_block_sort</a> (const device val_t *inp, device val_t *out_vals, device idx_t *out_idxs, const constant int &amp;size_sorted_axis, const constant int &amp;stride_sorted_axis, const constant int &amp;nc_dim, const constant int *nc_shape, const constant int64_t *nc_strides, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:a7b5b1180af2b8c6ab814eadd701ce4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32cbe4163b8b0f5cb2c97b256119a4b2" id="r_a32cbe4163b8b0f5cb2c97b256119a4b2"><td class="memTemplParams" colspan="2">template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a32cbe4163b8b0f5cb2c97b256119a4b2"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a32cbe4163b8b0f5cb2c97b256119a4b2">mb_block_partition</a> (device idx_t *block_partitions, const device val_t *dev_vals, const device idx_t *dev_idxs, const constant int &amp;size_sorted_axis, const constant int &amp;merge_tiles, const constant int &amp;n_blocks, uint3 tid, uint3 lid, uint3 tgp_dims)</td></tr>
<tr class="separator:a32cbe4163b8b0f5cb2c97b256119a4b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab381cd57f344bc7304ab580bfdc78807" id="r_ab381cd57f344bc7304ab580bfdc78807"><td class="memTemplParams" colspan="2">template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;val_t&gt;&gt; </td></tr>
<tr class="memitem:ab381cd57f344bc7304ab580bfdc78807" id="r_ab381cd57f344bc7304ab580bfdc78807"><td class="memTemplParams" colspan="2">template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;val_t&gt;&gt; </td></tr>
<tr class="memitem:ab381cd57f344bc7304ab580bfdc78807"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab381cd57f344bc7304ab580bfdc78807">mb_block_merge</a> (const device idx_t *block_partitions, const device val_t *dev_vals_in, const device idx_t *dev_idxs_in, device val_t *dev_vals_out, device idx_t *dev_idxs_out, const constant int &amp;size_sorted_axis, const constant int &amp;merge_tiles, const constant int &amp;num_tiles, uint3 tid, uint3 lid)</td></tr>
<tr class="separator:ab381cd57f344bc7304ab580bfdc78807"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
@@ -181,7 +195,7 @@ Variables</h2></td></tr>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
template&lt;typename T, typename U, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void block_sort </td>
@@ -233,13 +247,13 @@ template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short
</div>
</div>
<a id="a4ee3de195a6f9c33aa91ac52461808ad" name="a4ee3de195a6f9c33aa91ac52461808ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ee3de195a6f9c33aa91ac52461808ad">&#9670;&#160;</a></span>block_sort_nc()</h2>
<a id="ad272ef4422c75565a79b7f5e751bb247" name="ad272ef4422c75565a79b7f5e751bb247"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad272ef4422c75565a79b7f5e751bb247">&#9670;&#160;</a></span>block_sort_nc()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
template&lt;typename T, typename U, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void block_sort_nc </td>
@@ -279,12 +293,12 @@ template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t *</td> <td class="paramname"><span class="paramname"><em>in_nc_strides</em></span>, </td>
<td class="paramtype">const constant int64_t *</td> <td class="paramname"><span class="paramname"><em>in_nc_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t *</td> <td class="paramname"><span class="paramname"><em>out_nc_strides</em></span>, </td>
<td class="paramtype">const constant int64_t *</td> <td class="paramname"><span class="paramname"><em>out_nc_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -307,7 +321,7 @@ template&lt;typename T , typename U , bool ARG_SORT, short BLOCK_THREADS, short
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;val_t&gt;&gt; </div>
template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;val_t&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_merge </td>
@@ -370,7 +384,7 @@ template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_partition </td>
@@ -422,13 +436,13 @@ template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS
</div>
</div>
<a id="aa48ff1aff1e9dc1301b6781aa0721d6b" name="aa48ff1aff1e9dc1301b6781aa0721d6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa48ff1aff1e9dc1301b6781aa0721d6b">&#9670;&#160;</a></span>mb_block_sort()</h2>
<a id="a7b5b1180af2b8c6ab814eadd701ce4ba" name="a7b5b1180af2b8c6ab814eadd701ce4ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b5b1180af2b8c6ab814eadd701ce4ba">&#9670;&#160;</a></span>mb_block_sort()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_sort </td>
@@ -468,7 +482,7 @@ template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t *</td> <td class="paramname"><span class="paramname"><em>nc_strides</em></span>, </td>
<td class="paramtype">const constant int64_t *</td> <td class="paramname"><span class="paramname"><em>nc_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -491,7 +505,7 @@ template&lt;typename val_t , typename idx_t , bool ARG_SORT, short BLOCK_THREADS
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
template&lt;typename T&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void thread_swap </td>
@@ -524,7 +538,7 @@ template&lt;typename T &gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
<span class="mlabels"><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -532,10 +546,13 @@ template&lt;typename T &gt; </div>
</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.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="sort_8h.html">sort.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>