mirror of
https://github.com/ml-explore/mlx.git
synced 2025-11-04 10:38:10 +08:00
181 lines
19 KiB
HTML
181 lines
19 KiB
HTML
<!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/scatter.h Source File</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&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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="headertitle"><div class="title">scatter.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="scatter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright © 2024 Apple Inc.</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "<a class="code" href="kernels_2indexing_8h.html">mlx/backend/metal/kernels/indexing.h</a>"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> IdxT, <span class="keyword">typename</span> Op, <span class="keywordtype">int</span> NIDX></div>
|
|
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="scatter_8h.html#ac1fd901b5ef9f39be32316a17297781e"> 8</a></span>METAL_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="scatter_8h.html#ac1fd901b5ef9f39be32316a17297781e">scatter_1d_index_impl</a>(</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">const</span> device T* updates [[buffer(1)]],</div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> device <a class="code hl_struct" href="structmlx__atomic.html">mlx_atomic<T></a>* out [[buffer(2)]],</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* out_shape [[buffer(3)]],</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>* out_strides [[buffer(4)]],</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& out_ndim [[buffer(5)]],</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* upd_shape [[buffer(6)]],</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& upd_ndim [[buffer(7)]],</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& upd_size [[buffer(8)]],</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">const</span> thread array<const device IdxT*, NIDX>& idx_buffers,</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> uint2 gid [[thread_position_in_grid]]) {</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> Op <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>;</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> uint out_idx = 0;</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < NIDX; i++) {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">auto</span> idx_val = <a class="code hl_function" href="kernels_2indexing_8h.html#ab41167dc537c06fbdb4df100972393df">offset_neg_idx</a>(idx_buffers[i][gid.y], out_shape[i]);</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> out_idx += idx_val * out_strides[i];</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">if</span> (upd_ndim > 1) {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">auto</span> out_offset = <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a2e49fa7ab8f6348543455c6c45d7e2a9">elem_to_loc</a>(gid.x, upd_shape + 1, out_strides, out_ndim);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> out_idx += out_offset;</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> out_idx += gid.x;</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>.atomic_update(out, updates[gid.y * upd_size + gid.x], out_idx);</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> IdxT, <span class="keyword">typename</span> Op, <span class="keywordtype">int</span> NIDX></div>
|
|
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="scatter_8h.html#a75f61cc43682a72dd66a1da43a1809fe"> 38</a></span>METAL_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="scatter_8h.html#a75f61cc43682a72dd66a1da43a1809fe">scatter_impl</a>(</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> device T* updates [[buffer(1)]],</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> device <a class="code hl_struct" href="structmlx__atomic.html">mlx_atomic<T></a>* out [[buffer(2)]],</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* upd_shape [[buffer(3)]],</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>* upd_strides [[buffer(4)]],</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& upd_ndim [[buffer(5)]],</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& upd_size [[buffer(6)]],</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* out_shape [[buffer(7)]],</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>* out_strides [[buffer(8)]],</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>& out_ndim [[buffer(9)]],</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* axes [[buffer(10)]],</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">const</span> thread <a class="code hl_struct" href="struct_indices.html">Indices<IdxT, NIDX></a>& indices,</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> uint2 gid [[thread_position_in_grid]]) {</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> Op <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>;</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">auto</span> ind_idx = gid.y;</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">auto</span> ind_offset = gid.x;</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">size_t</span> out_idx = 0;</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < NIDX; ++i) {</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">auto</span> idx_loc = <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a2e49fa7ab8f6348543455c6c45d7e2a9">elem_to_loc</a>(</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> ind_idx,</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> &indices.shapes[indices.ndim * i],</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> &indices.strides[indices.ndim * i],</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> indices.ndim);</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">auto</span> ax = axes[i];</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">auto</span> idx_val = <a class="code hl_function" href="kernels_2indexing_8h.html#ab41167dc537c06fbdb4df100972393df">offset_neg_idx</a>(indices.buffers[i][idx_loc], out_shape[ax]);</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> out_idx += idx_val * out_strides[ax];</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> }</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">if</span> (upd_size > 1) {</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">auto</span> out_offset = <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a2e49fa7ab8f6348543455c6c45d7e2a9">elem_to_loc</a>(</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> ind_offset, upd_shape + indices.ndim, out_strides, out_ndim);</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> out_idx += out_offset;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">auto</span> upd_idx =</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a2e49fa7ab8f6348543455c6c45d7e2a9">elem_to_loc</a>(gid.y * upd_size + gid.x, upd_shape, upd_strides, upd_ndim);</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_variable" href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a>.atomic_update(out, updates[upd_idx], out_idx);</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
|
|
</div>
|
|
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a2e49fa7ab8f6348543455c6c45d7e2a9"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a2e49fa7ab8f6348543455c6c45d7e2a9">elem_to_loc</a></div><div class="ttdeci">METAL_FUNC stride_t elem_to_loc(uint elem, device const int *shape, device const stride_t *strides, int ndim)</div><div class="ttdef"><b>Definition</b> utils.h:77</div></div>
|
|
<div class="ttc" id="acommon_2binary_8h_html_a70228731d29946574b238d21fb4b360c"><div class="ttname"><a href="common_2binary_8h.html#a70228731d29946574b238d21fb4b360c">op</a></div><div class="ttdeci">Op op</div><div class="ttdef"><b>Definition</b> binary.h:141</div></div>
|
|
<div class="ttc" id="akernels_2indexing_8h_html"><div class="ttname"><a href="kernels_2indexing_8h.html">indexing.h</a></div></div>
|
|
<div class="ttc" id="akernels_2indexing_8h_html_ab41167dc537c06fbdb4df100972393df"><div class="ttname"><a href="kernels_2indexing_8h.html#ab41167dc537c06fbdb4df100972393df">offset_neg_idx</a></div><div class="ttdeci">METAL_FUNC size_t offset_neg_idx(IdxT idx, size_t size)</div><div class="ttdef"><b>Definition</b> indexing.h:16</div></div>
|
|
<div class="ttc" id="ascatter_8h_html_a75f61cc43682a72dd66a1da43a1809fe"><div class="ttname"><a href="scatter_8h.html#a75f61cc43682a72dd66a1da43a1809fe">scatter_impl</a></div><div class="ttdeci">METAL_FUNC void scatter_impl(const device T *updates, device mlx_atomic< T > *out, const constant int *upd_shape, const constant size_t *upd_strides, const constant size_t &upd_ndim, const constant size_t &upd_size, const constant int *out_shape, const constant size_t *out_strides, const constant size_t &out_ndim, const constant int *axes, const thread Indices< IdxT, NIDX > &indices, uint2 gid)</div><div class="ttdef"><b>Definition</b> scatter.h:38</div></div>
|
|
<div class="ttc" id="ascatter_8h_html_ac1fd901b5ef9f39be32316a17297781e"><div class="ttname"><a href="scatter_8h.html#ac1fd901b5ef9f39be32316a17297781e">scatter_1d_index_impl</a></div><div class="ttdeci">METAL_FUNC void scatter_1d_index_impl(const device T *updates, device mlx_atomic< T > *out, const constant int *out_shape, const constant size_t *out_strides, const constant size_t &out_ndim, const constant int *upd_shape, const constant size_t &upd_ndim, const constant size_t &upd_size, const thread array< const device IdxT *, NIDX > &idx_buffers, uint2 gid)</div><div class="ttdef"><b>Definition</b> scatter.h:8</div></div>
|
|
<div class="ttc" id="astruct_indices_html"><div class="ttname"><a href="struct_indices.html">Indices</a></div><div class="ttdef"><b>Definition</b> indexing.h:8</div></div>
|
|
<div class="ttc" id="astructmlx__atomic_html"><div class="ttname"><a href="structmlx__atomic.html">mlx_atomic</a></div><div class="ttdef"><b>Definition</b> atomic.h:25</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|