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/scan.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('scan_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;
@@ -104,7 +118,7 @@ Classes</h2></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_cum_prod.html">CumProd&lt; U &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_cum_prod_3_01bool_01_4.html">CumProd&lt; bool &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_cum_prod.html">CumProd&lt; bool &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_cum_max.html">CumMax&lt; U &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -120,22 +134,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:a9c415d07921f3961bad0a00a34f4a9a3" id="r_a9c415d07921f3961bad0a00a34f4a9a3"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:a9c415d07921f3961bad0a00a34f4a9a3" id="r_a9c415d07921f3961bad0a00a34f4a9a3"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:a9c415d07921f3961bad0a00a34f4a9a3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9c415d07921f3961bad0a00a34f4a9a3">load_unsafe</a> (U values[N_READS], const device T *input)</td></tr>
<tr class="separator:a9c415d07921f3961bad0a00a34f4a9a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8eb101e538b85f8a4bcf451489ae0ac" id="r_ae8eb101e538b85f8a4bcf451489ae0ac"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:ae8eb101e538b85f8a4bcf451489ae0ac" id="r_ae8eb101e538b85f8a4bcf451489ae0ac"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:ae8eb101e538b85f8a4bcf451489ae0ac"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae8eb101e538b85f8a4bcf451489ae0ac">load_safe</a> (U values[N_READS], const device T *input, int start, int total, U init)</td></tr>
<tr class="separator:ae8eb101e538b85f8a4bcf451489ae0ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8010e7bdf7a72cbd35ce7cd7ecb08e32" id="r_a8010e7bdf7a72cbd35ce7cd7ecb08e32"><td class="memTemplParams" colspan="2">template&lt;typename U , int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:a8010e7bdf7a72cbd35ce7cd7ecb08e32" id="r_a8010e7bdf7a72cbd35ce7cd7ecb08e32"><td class="memTemplParams" colspan="2">template&lt;typename U, int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:a8010e7bdf7a72cbd35ce7cd7ecb08e32"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8010e7bdf7a72cbd35ce7cd7ecb08e32">write_unsafe</a> (U values[N_READS], device U *out)</td></tr>
<tr class="separator:a8010e7bdf7a72cbd35ce7cd7ecb08e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae86aef08e5ebc8790031eb51eefa754c" id="r_ae86aef08e5ebc8790031eb51eefa754c"><td class="memTemplParams" colspan="2">template&lt;typename U , int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:ae86aef08e5ebc8790031eb51eefa754c" id="r_ae86aef08e5ebc8790031eb51eefa754c"><td class="memTemplParams" colspan="2">template&lt;typename U, int N_READS, bool reverse&gt; </td></tr>
<tr class="memitem:ae86aef08e5ebc8790031eb51eefa754c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae86aef08e5ebc8790031eb51eefa754c">write_safe</a> (U values[N_READS], device U *out, int start, int total)</td></tr>
<tr class="separator:ae86aef08e5ebc8790031eb51eefa754c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60d279b9add7d56639bb209408f09d79" id="r_a60d279b9add7d56639bb209408f09d79"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive, bool reverse&gt; </td></tr>
<tr class="memitem:a60d279b9add7d56639bb209408f09d79" id="r_a60d279b9add7d56639bb209408f09d79"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, typename Op, int N_READS, bool inclusive, bool reverse&gt; </td></tr>
<tr class="memitem:a60d279b9add7d56639bb209408f09d79"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a60d279b9add7d56639bb209408f09d79">contiguous_scan</a> (const device T *in, device U *out, const constant size_t &amp;axis_size, uint3 gid, uint3 gsize, uint3 lid, uint3 lsize, uint simd_lane_id, uint simd_group_id)</td></tr>
<tr class="separator:a60d279b9add7d56639bb209408f09d79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7abb6ffb6c3b96b88c2a63cd4cc2f7ae" id="r_a7abb6ffb6c3b96b88c2a63cd4cc2f7ae"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive, bool reverse&gt; </td></tr>
<tr class="memitem:a7abb6ffb6c3b96b88c2a63cd4cc2f7ae" id="r_a7abb6ffb6c3b96b88c2a63cd4cc2f7ae"><td class="memTemplParams" colspan="2">template&lt;typename T, typename U, typename Op, int N_READS, bool inclusive, bool reverse&gt; </td></tr>
<tr class="memitem:a7abb6ffb6c3b96b88c2a63cd4cc2f7ae"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7abb6ffb6c3b96b88c2a63cd4cc2f7ae">strided_scan</a> (const device T *in, device U *out, const constant size_t &amp;axis_size, const constant size_t &amp;stride, const constant size_t &amp;stride_blocks, uint3 gid, uint3 gsize, uint3 lid, uint simd_lane_id, uint simd_group_id)</td></tr>
<tr class="separator:a7abb6ffb6c3b96b88c2a63cd4cc2f7ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -164,7 +178,7 @@ Functions</h2></td></tr>
<div class="line"> val = simd_scan(val); \</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a5862d5ea154c9b76cf56a630cf6385b4">simd_shuffle_and_fill_up</a>(val, init, 1); \</div>
<div class="line"> }</div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a5862d5ea154c9b76cf56a630cf6385b4"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a5862d5ea154c9b76cf56a630cf6385b4">simd_shuffle_and_fill_up</a></div><div class="ttdeci">uint64_t simd_shuffle_and_fill_up(uint64_t data, uint64_t filling, uint16_t delta)</div><div class="ttdef"><b>Definition</b> utils.h:383</div></div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a5862d5ea154c9b76cf56a630cf6385b4"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a5862d5ea154c9b76cf56a630cf6385b4">simd_shuffle_and_fill_up</a></div><div class="ttdeci">uint64_t simd_shuffle_and_fill_up(uint64_t data, uint64_t filling, uint16_t delta)</div><div class="ttdef"><b>Definition</b> utils.h:372</div></div>
</div><!-- fragment -->
</div>
</div>
@@ -204,7 +218,7 @@ Functions</h2></td></tr>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive, bool reverse&gt; </div>
template&lt;typename T, typename U, typename Op, int N_READS, bool inclusive, bool reverse&gt; </div>
<table class="memname">
<tr>
<td class="memname">void contiguous_scan </td>
@@ -262,7 +276,7 @@ template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive,
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
template&lt;typename T, typename U, int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -295,7 +309,7 @@ template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -308,7 +322,7 @@ template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
template&lt;typename T, typename U, int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -326,7 +340,7 @@ template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -339,7 +353,7 @@ template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive, bool reverse&gt; </div>
template&lt;typename T, typename U, typename Op, int N_READS, bool inclusive, bool reverse&gt; </div>
<table class="memname">
<tr>
<td class="memname">void strided_scan </td>
@@ -402,7 +416,7 @@ template&lt;typename T , typename U , typename Op , int N_READS, bool inclusive,
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U , int N_READS, bool reverse&gt; </div>
template&lt;typename U, int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -430,7 +444,7 @@ template&lt;typename U , int N_READS, bool reverse&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -443,7 +457,7 @@ template&lt;typename U , int N_READS, bool reverse&gt; </div>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U , int N_READS, bool reverse&gt; </div>
template&lt;typename U, int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -461,7 +475,7 @@ template&lt;typename U , int N_READS, bool reverse&gt; </div>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -469,10 +483,13 @@ template&lt;typename U , int N_READS, bool reverse&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="scan_8h.html">scan.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>