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
c7080f89ca
mlx/docs/build/html/gather__axis_8h_source.html
CircleCI Docs c7080f89ca rebase
2025-06-04 01:01:55 +00:00

167 lines
13 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/gather_axis.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="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>
<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>
<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.13.2 -->
<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>
</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(){initNavTree('gather__axis_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">gather_axis.h</div></div>
</div><!--header-->
<div class="contents">
<a href="gather__axis_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 © 2025 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="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> IdxT, <span class="keyword">typename</span> LocT, <span class="keywordtype">bool</span> SrcC, <span class="keywordtype">bool</span> IdxC&gt;</div>
<div class="foldopen" id="foldopen00006" data-start="{" data-end="}">
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="gather__axis_8h.html#a0d7d3866afe2007e280781502dc767c6"> 6</a></span>[[kernel]] <span class="keywordtype">void</span> <a class="code hl_function" href="gather__axis_8h.html#a0d7d3866afe2007e280781502dc767c6">gather_axis</a>(</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">const</span> device T* src [[buffer(0)]],</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">const</span> device IdxT* indices [[buffer(1)]],</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> device T* out [[buffer(2)]],</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* shape [[buffer(3)]],</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">const</span> constant int64_t* src_strides [[buffer(4)]],</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> constant int64_t* idx_strides [[buffer(5)]],</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; ndim [[buffer(6)]],</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>&amp; axis [[buffer(7)]],</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>&amp; axis_size [[buffer(8)]],</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>&amp; src_ax_stride [[buffer(9)]],</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>&amp; idx_ax_stride [[buffer(10)]],</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> uint3 index [[thread_position_in_grid]],</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> uint3 grid_dim [[threads_per_grid]]) {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> LocT elem_idx = index.z * <span class="keyword">static_cast&lt;</span>LocT<span class="keyword">&gt;</span>(grid_dim.x);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> LocT out_idx = elem_idx * grid_dim.y + index.x;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> LocT idx_loc = index.y * <span class="keyword">static_cast&lt;</span>LocT<span class="keyword">&gt;</span>(idx_ax_stride);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">if</span> (IdxC) {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> idx_loc += out_idx;</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 += <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a">elem_to_loc&lt;LocT&gt;</a>(elem_idx + index.x, shape, idx_strides, ndim);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> }</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">auto</span> idx_val = indices[idx_loc];</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">if</span> (is_signed_v&lt;IdxT&gt;) {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> idx_val = (idx_val &lt; 0) ? idx_val + axis_size : idx_val;</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> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> LocT src_idx = idx_val * <span class="keyword">static_cast&lt;</span>LocT<span class="keyword">&gt;</span>(src_ax_stride);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">if</span> (SrcC) {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> src_idx += elem_idx * axis_size + index.x;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> src_idx += <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a">elem_to_loc&lt;LocT&gt;</a>(elem_idx + index.x, shape, src_strides, ndim);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> out_idx += index.y * <span class="keyword">static_cast&lt;</span>LocT<span class="keyword">&gt;</span>(grid_dim.x);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> out[out_idx] = src[src_idx];</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>}</div>
</div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a497dd9f1a00c8a4303d8782158a0812a"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a">elem_to_loc</a></div><div class="ttdeci">METAL_FUNC IdxT elem_to_loc(IdxT elem, constant const int *shape, constant const int64_t *strides, int ndim)</div><div class="ttdef"><b>Definition</b> utils.h:93</div></div>
<div class="ttc" id="agather__axis_8h_html_a0d7d3866afe2007e280781502dc767c6"><div class="ttname"><a href="gather__axis_8h.html#a0d7d3866afe2007e280781502dc767c6">gather_axis</a></div><div class="ttdeci">void gather_axis(const device T *src, const device IdxT *indices, device T *out, const constant int *shape, const constant int64_t *src_strides, const constant int64_t *idx_strides, const constant size_t &amp;ndim, const constant int &amp;axis, const constant int &amp;axis_size, const constant size_t &amp;src_ax_stride, const constant size_t &amp;idx_ax_stride, uint3 index, uint3 grid_dim)</div><div class="ttdef"><b>Definition</b> gather_axis.h:6</div></div>
</div><!-- fragment --></div><!-- contents -->
</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="gather__axis_8h.html">gather_axis.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.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink