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

389 lines
20 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/kernels/scan.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_70a37effa88bcbd6b791977fa1e64356.html">kernels</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">scan.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="kernels_2scan_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="nested-classes" name="nested-classes"></a>
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_cum_sum.html">CumSum&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.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="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>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_cum_min.html">CumMin&lt; U &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="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"><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"><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"><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"><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:a1f9c197dc09641f3fbb2e886c85b0675" id="r_a1f9c197dc09641f3fbb2e886c85b0675"><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:a1f9c197dc09641f3fbb2e886c85b0675"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1f9c197dc09641f3fbb2e886c85b0675">contiguous_scan</a> (const device T *in, device U *out, const constant size_t &amp;axis_size, uint gid, uint lid, uint lsize, uint <a class="el" href="backend_2metal_2kernels_2reduction_2ops_8h.html#a515b75d563a93d3c09ee677948dc83e3">simd_size</a>, uint simd_lane_id, uint simd_group_id)</td></tr>
<tr class="separator:a1f9c197dc09641f3fbb2e886c85b0675"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef54ac73154fb9024eda760a9dfde607" id="r_aef54ac73154fb9024eda760a9dfde607"><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:aef54ac73154fb9024eda760a9dfde607"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aef54ac73154fb9024eda760a9dfde607">strided_scan</a> (const device T *in, device U *out, const constant size_t &amp;axis_size, const constant size_t &amp;stride, uint2 gid, uint2 lid, uint2 lsize, uint <a class="el" href="backend_2metal_2kernels_2reduction_2ops_8h.html#a515b75d563a93d3c09ee677948dc83e3">simd_size</a>)</td></tr>
<tr class="separator:aef54ac73154fb9024eda760a9dfde607"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1f9c197dc09641f3fbb2e886c85b0675" name="a1f9c197dc09641f3fbb2e886c85b0675"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f9c197dc09641f3fbb2e886c85b0675">&#9670;&#160;</a></span>contiguous_scan()</h2>
<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>
<table class="memname">
<tr>
<td class="memname">void contiguous_scan </td>
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>in</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device U *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t &amp;</td> <td class="paramname"><span class="paramname"><em>axis_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>gid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>lid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>lsize</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_lane_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_group_id</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae8eb101e538b85f8a4bcf451489ae0ac" name="ae8eb101e538b85f8a4bcf451489ae0ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8eb101e538b85f8a4bcf451489ae0ac">&#9670;&#160;</a></span>load_safe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void load_safe </td>
<td>(</td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>values</em>[N_READS], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>input</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>start</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>total</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>init</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9c415d07921f3961bad0a00a34f4a9a3" name="a9c415d07921f3961bad0a00a34f4a9a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c415d07921f3961bad0a00a34f4a9a3">&#9670;&#160;</a></span>load_unsafe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename U , int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void load_unsafe </td>
<td>(</td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>values</em>[N_READS], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>input</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aef54ac73154fb9024eda760a9dfde607" name="aef54ac73154fb9024eda760a9dfde607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef54ac73154fb9024eda760a9dfde607">&#9670;&#160;</a></span>strided_scan()</h2>
<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>
<table class="memname">
<tr>
<td class="memname">void strided_scan </td>
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>in</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device U *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t &amp;</td> <td class="paramname"><span class="paramname"><em>axis_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t &amp;</td> <td class="paramname"><span class="paramname"><em>stride</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>gid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>lid</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>lsize</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_size</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae86aef08e5ebc8790031eb51eefa754c" name="ae86aef08e5ebc8790031eb51eefa754c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae86aef08e5ebc8790031eb51eefa754c">&#9670;&#160;</a></span>write_safe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U , int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void write_safe </td>
<td>(</td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>values</em>[N_READS], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device U *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>start</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>total</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8010e7bdf7a72cbd35ce7cd7ecb08e32" name="a8010e7bdf7a72cbd35ce7cd7ecb08e32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8010e7bdf7a72cbd35ce7cd7ecb08e32">&#9670;&#160;</a></span>write_unsafe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U , int N_READS, bool reverse&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void write_unsafe </td>
<td>(</td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>values</em>[N_READS], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device U *</td> <td class="paramname"><span class="paramname"><em>out</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</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