zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-25 18:11:15 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
a950c2e684
mlx/docs/build/html/gather_8h_source.html

160 lines
14 KiB
HTML
Raw Normal View History

rebase
2024-10-15 23:12:17 +08:00
<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/gather.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<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>
<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.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',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); });
/* @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 id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">gather.h</div></div>
</div><!--header-->
<div class="contents">
<a href="gather_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 &quot;<a class="code" href="kernels_2indexing_8h.html">mlx/backend/metal/kernels/indexing.h</a>&quot;</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> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> IdxT, <span class="keywordtype">int</span> NIDX, <span class="keywordtype">int</span> IDX_NDIM&gt;</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="gather_8h.html#abdec470e1af0109563ddae3e85e6526c"> 8</a></span>METAL_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="gather_8h.html#abdec470e1af0109563ddae3e85e6526c">gather_impl</a>(</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">const</span> device T* src [[buffer(0)]],</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> device T* out [[buffer(1)]],</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>* src_shape [[buffer(2)]],</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>* src_strides [[buffer(3)]],</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>&amp; src_ndim [[buffer(4)]],</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>* slice_sizes [[buffer(5)]],</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* axes [[buffer(6)]],</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">const</span> thread <a class="code hl_struct" href="struct_indices.html">Indices&lt;IdxT, NIDX&gt;</a>&amp; indices,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> uint3 index [[thread_position_in_grid]],</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> uint3 grid_dim [[threads_per_grid]]) {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">size_t</span> src_idx = 0;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; NIDX; ++i) {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">size_t</span> idx_loc;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">if</span> (IDX_NDIM == 0) {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> idx_loc = 0;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (IDX_NDIM == 1) {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> idx_loc = index.x * indices.strides[indices.ndim * i];</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> idx_loc = index.x * indices.strides[indices.ndim * i];</div>
rebase
2024-10-31 11:00:19 +08:00
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> idx_loc += indices.row_contiguous[i]</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ? index.y</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> : <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a8fd0c8fc6058e650fc99bca8b6acd7d1">elem_to_loc</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> index.y,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> &amp;indices.shapes[indices.ndim * i + 1],</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> &amp;indices.strides[indices.ndim * i + 1],</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> indices.ndim - 1);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">auto</span> ax = axes[i];</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</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], src_shape[ax]);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> src_idx += idx_val * src_strides[ax];</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
rebase
2024-10-15 23:12:17 +08:00
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
rebase
2024-10-31 11:00:19 +08:00
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">auto</span> src_offset = <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a8fd0c8fc6058e650fc99bca8b6acd7d1">elem_to_loc</a>(index.z, slice_sizes, src_strides, src_ndim);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">size_t</span> out_idx = index.z;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">if</span> (IDX_NDIM == 1) {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> out_idx += <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(grid_dim.z) * index.x;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (IDX_NDIM &gt;= 2) {</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> out_idx +=</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> grid_dim.z * (index.x * <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(grid_dim.y) + index.y);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> out[out_idx] = src[src_offset + src_idx];</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>}</div>
rebase
2024-10-15 23:12:17 +08:00
</div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a8fd0c8fc6058e650fc99bca8b6acd7d1"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a8fd0c8fc6058e650fc99bca8b6acd7d1">elem_to_loc</a></div><div class="ttdeci">METAL_FUNC stride_t elem_to_loc(uint elem, constant const int *shape, constant const stride_t *strides, int ndim)</div><div class="ttdef"><b>Definition</b> utils.h:87</div></div>
<div class="ttc" id="agather_8h_html_abdec470e1af0109563ddae3e85e6526c"><div class="ttname"><a href="gather_8h.html#abdec470e1af0109563ddae3e85e6526c">gather_impl</a></div><div class="ttdeci">METAL_FUNC void gather_impl(const device T *src, device T *out, const constant int *src_shape, const constant size_t *src_strides, const constant size_t &amp;src_ndim, const constant int *slice_sizes, const constant int *axes, const thread Indices&lt; IdxT, NIDX &gt; &amp;indices, uint3 index, uint3 grid_dim)</div><div class="ttdef"><b>Definition</b> gather.h:8</div></div>
<div class="ttc" id="akernels_2indexing_8h_html"><div class="ttname"><a href="kernels_2indexing_8h.html">indexing.h</a></div></div>
rebase
2024-10-31 11:00:19 +08:00
<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:17</div></div>
rebase
2024-10-15 23:12:17 +08:00
<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><!-- fragment --></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 -->
</body>
</html>
Reference in New Issue Copy Permalink