This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
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/gather.h Source File</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('gather_8h_source.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="headertitle"><div class="title">gather.h</div></div>
</div><!--header-->
@@ -99,11 +113,11 @@ $(function(){ initResizable(false); });
<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, <span class="keyword">typename</span> LocT&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#a767d7c5be6f2f649101f581449af5599"> 8</a></span>METAL_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="gather_8h.html#a767d7c5be6f2f649101f581449af5599">gather_impl</a>(</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="gather_8h.html#a5cf4ff9849edd2d99ff24ab4a6c9cd5d"> 8</a></span>METAL_FUNC <span class="keywordtype">void</span> <a class="code hl_function" href="gather_8h.html#a5cf4ff9849edd2d99ff24ab4a6c9cd5d">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="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">const</span> constant int64_t* 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>
@@ -121,7 +135,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> idx_loc = index.x * <span class="keyword">static_cast&lt;</span>LocT<span class="keyword">&gt;</span>(indices.strides[indices.ndim * i]);</div>
<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#a22eaa505dbc7dd2a63a895f2e16712f5">elem_to_loc&lt;size_t, LocT&gt;</a>(</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#a497dd9f1a00c8a4303d8782158a0812a">elem_to_loc&lt;LocT&gt;</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>
@@ -133,7 +147,7 @@ $(function(){ initResizable(false); });
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</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> <span class="keyword">auto</span> src_offset =</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a22eaa505dbc7dd2a63a895f2e16712f5">elem_to_loc&lt;size_t, LocT&gt;</a>(index.z, slice_sizes, src_strides, src_ndim);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_function" href="backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a">elem_to_loc&lt;LocT&gt;</a>(index.z, slice_sizes, src_strides, src_ndim);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> LocT out_idx = index.z;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">if</span> (IDX_NDIM == 1) {</div>
@@ -144,16 +158,19 @@ $(function(){ initResizable(false); });
<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>
</div>
<div class="ttc" id="abackend_2metal_2kernels_2utils_8h_html_a22eaa505dbc7dd2a63a895f2e16712f5"><div class="ttname"><a href="backend_2metal_2kernels_2utils_8h.html#a22eaa505dbc7dd2a63a895f2e16712f5">elem_to_loc</a></div><div class="ttdeci">METAL_FUNC IdxT elem_to_loc(uint elem, constant const int *shape, constant const StrideT *strides, int ndim)</div><div class="ttdef"><b>Definition</b> utils.h:93</div></div>
<div class="ttc" id="agather_8h_html_a767d7c5be6f2f649101f581449af5599"><div class="ttname"><a href="gather_8h.html#a767d7c5be6f2f649101f581449af5599">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="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_8h_html_a5cf4ff9849edd2d99ff24ab4a6c9cd5d"><div class="ttname"><a href="gather_8h.html#a5cf4ff9849edd2d99ff24ab4a6c9cd5d">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 int64_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>
<div class="ttc" id="akernels_2indexing_8h_html_a58a65ea6215999cd4ccb4fe757cc2dc8"><div class="ttname"><a href="kernels_2indexing_8h.html#a58a65ea6215999cd4ccb4fe757cc2dc8">offset_neg_idx</a></div><div class="ttdeci">METAL_FUNC size_t offset_neg_idx(IdxT idx, int size)</div><div class="ttdef"><b>Definition</b> indexing.h:17</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><!-- 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 -->
<!-- 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_8h.html">gather.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>