This commit is contained in:
CircleCI Docs
2025-02-06 20:16:29 +00:00
parent 231caa94a6
commit 3bac79c1d6
2299 changed files with 64934 additions and 28640 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.13.1"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<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"/>
@@ -52,7 +52,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.1 -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -117,13 +117,13 @@ $(function(){initNavTree('sort_8h.html',''); initResizable(true); });
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_less_than.html">LessThan&lt; T &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_thread_sort.html">ThreadSort&lt; val_t, idx_t, ARG_SORT, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_thread_sort.html">ThreadSort&lt; ValT, IdxT, ARG_SORT, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_merge_sort.html">BlockMergeSort&lt; val_t, idx_t, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_merge_sort.html">BlockMergeSort&lt; ValT, IdxT, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_kernel_merge_sort.html">KernelMergeSort&lt; T, U, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_kernel_multi_block_merge_sort.html">KernelMultiBlockMergeSort&lt; val_t, idx_t, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_kernel_multi_block_merge_sort.html">KernelMultiBlockMergeSort&lt; ValT, IdxT, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</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 id="define-members" name="define-members"></a>
@@ -144,15 +144,15 @@ Functions</h2></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"><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>
<tr class="memitem:ad1ebc6ed8452f970c37c8aad5414551f" id="r_ad1ebc6ed8452f970c37c8aad5414551f"><td class="memTemplParams" colspan="2">template&lt;typename ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:ad1ebc6ed8452f970c37c8aad5414551f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad1ebc6ed8452f970c37c8aad5414551f">mb_block_sort</a> (const device ValT *inp, device ValT *out_vals, device IdxT *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:ad1ebc6ed8452f970c37c8aad5414551f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a812f19ed1db562026edc24e29185fe8c" id="r_a812f19ed1db562026edc24e29185fe8c"><td class="memTemplParams" colspan="2">template&lt;typename ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </td></tr>
<tr class="memitem:a812f19ed1db562026edc24e29185fe8c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a812f19ed1db562026edc24e29185fe8c">mb_block_partition</a> (device IdxT *block_partitions, const device ValT *dev_vals, const device IdxT *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:a812f19ed1db562026edc24e29185fe8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cd2751d251acde874a95330d35fac5f" id="r_a9cd2751d251acde874a95330d35fac5f"><td class="memTemplParams" colspan="2">template&lt;typename ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;ValT&gt;&gt; </td></tr>
<tr class="memitem:a9cd2751d251acde874a95330d35fac5f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9cd2751d251acde874a95330d35fac5f">mb_block_merge</a> (const device IdxT *block_partitions, const device ValT *dev_vals_in, const device IdxT *dev_idxs_in, device ValT *dev_vals_out, device IdxT *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:a9cd2751d251acde874a95330d35fac5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
@@ -315,38 +315,38 @@ template&lt;typename T, typename U, bool ARG_SORT, short BLOCK_THREADS, short N_
</div>
</div>
<a id="ab381cd57f344bc7304ab580bfdc78807" name="ab381cd57f344bc7304ab580bfdc78807"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab381cd57f344bc7304ab580bfdc78807">&#9670;&#160;</a></span>mb_block_merge()</h2>
<a id="a9cd2751d251acde874a95330d35fac5f" name="a9cd2751d251acde874a95330d35fac5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cd2751d251acde874a95330d35fac5f">&#9670;&#160;</a></span>mb_block_merge()</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, typename CompareOp = LessThan&lt;val_t&gt;&gt; </div>
template&lt;typename ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD, typename CompareOp = LessThan&lt;ValT&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_merge </td>
<td>(</td>
<td class="paramtype">const device idx_t *</td> <td class="paramname"><span class="paramname"><em>block_partitions</em></span>, </td>
<td class="paramtype">const device IdxT *</td> <td class="paramname"><span class="paramname"><em>block_partitions</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device val_t *</td> <td class="paramname"><span class="paramname"><em>dev_vals_in</em></span>, </td>
<td class="paramtype">const device ValT *</td> <td class="paramname"><span class="paramname"><em>dev_vals_in</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device idx_t *</td> <td class="paramname"><span class="paramname"><em>dev_idxs_in</em></span>, </td>
<td class="paramtype">const device IdxT *</td> <td class="paramname"><span class="paramname"><em>dev_idxs_in</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device val_t *</td> <td class="paramname"><span class="paramname"><em>dev_vals_out</em></span>, </td>
<td class="paramtype">device ValT *</td> <td class="paramname"><span class="paramname"><em>dev_vals_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device idx_t *</td> <td class="paramname"><span class="paramname"><em>dev_idxs_out</em></span>, </td>
<td class="paramtype">device IdxT *</td> <td class="paramname"><span class="paramname"><em>dev_idxs_out</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -378,28 +378,28 @@ template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS,
</div>
</div>
<a id="a32cbe4163b8b0f5cb2c97b256119a4b2" name="a32cbe4163b8b0f5cb2c97b256119a4b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32cbe4163b8b0f5cb2c97b256119a4b2">&#9670;&#160;</a></span>mb_block_partition()</h2>
<a id="a812f19ed1db562026edc24e29185fe8c" name="a812f19ed1db562026edc24e29185fe8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a812f19ed1db562026edc24e29185fe8c">&#9670;&#160;</a></span>mb_block_partition()</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 ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_partition </td>
<td>(</td>
<td class="paramtype">device idx_t *</td> <td class="paramname"><span class="paramname"><em>block_partitions</em></span>, </td>
<td class="paramtype">device IdxT *</td> <td class="paramname"><span class="paramname"><em>block_partitions</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device val_t *</td> <td class="paramname"><span class="paramname"><em>dev_vals</em></span>, </td>
<td class="paramtype">const device ValT *</td> <td class="paramname"><span class="paramname"><em>dev_vals</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device idx_t *</td> <td class="paramname"><span class="paramname"><em>dev_idxs</em></span>, </td>
<td class="paramtype">const device IdxT *</td> <td class="paramname"><span class="paramname"><em>dev_idxs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -436,28 +436,28 @@ template&lt;typename val_t, typename idx_t, bool ARG_SORT, short BLOCK_THREADS,
</div>
</div>
<a id="a7b5b1180af2b8c6ab814eadd701ce4ba" name="a7b5b1180af2b8c6ab814eadd701ce4ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b5b1180af2b8c6ab814eadd701ce4ba">&#9670;&#160;</a></span>mb_block_sort()</h2>
<a id="ad1ebc6ed8452f970c37c8aad5414551f" name="ad1ebc6ed8452f970c37c8aad5414551f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1ebc6ed8452f970c37c8aad5414551f">&#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 ValT, typename IdxT, bool ARG_SORT, short BLOCK_THREADS, short N_PER_THREAD&gt; </div>
<table class="memname">
<tr>
<td class="memname">void mb_block_sort </td>
<td>(</td>
<td class="paramtype">const device val_t *</td> <td class="paramname"><span class="paramname"><em>inp</em></span>, </td>
<td class="paramtype">const device ValT *</td> <td class="paramname"><span class="paramname"><em>inp</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device val_t *</td> <td class="paramname"><span class="paramname"><em>out_vals</em></span>, </td>
<td class="paramtype">device ValT *</td> <td class="paramname"><span class="paramname"><em>out_vals</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device idx_t *</td> <td class="paramname"><span class="paramname"><em>out_idxs</em></span>, </td>
<td class="paramtype">device IdxT *</td> <td class="paramname"><span class="paramname"><em>out_idxs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -551,7 +551,7 @@ template&lt;typename T&gt; </div>
<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>
<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.2 </li>
</ul>
</div>
</body>