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" / >
2025-02-07 04:16:29 +08:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 23:12:17 +08:00
< 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 >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 23:12:17 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / 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 >
2024-10-15 23:12:17 +08:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
< 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" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< / 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 >
2024-10-15 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('scatter_8h_source.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-15 23:12:17 +08:00
<!-- 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" > 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 >
2024-10-31 11:00:19 +08:00
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "keyword" > template< / span > < < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "keyword" > typename< / span > T,< / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "keyword" > typename< / span > IdxT,< / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "keyword" > typename< / span > Op,< / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "keywordtype" > int< / span > NIDX,< / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < span class = "keywordtype" > bool< / span > UPD_ROW_CONTIG,< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "keywordtype" > int< / span > NWORK,< / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "keyword" > typename< / span > LocT> < / div >
< div class = "foldopen" id = "foldopen00015" data-start = "{" data-end = "}" >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > < a class = "line" href = "scatter_8h.html#ab72d4fe1dbd4ae4dc529ee2ec8164fa4" > 15< / a > < / span > METAL_FUNC < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "scatter_8h.html#ab72d4fe1dbd4ae4dc529ee2ec8164fa4" > scatter_impl< / a > (< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "keyword" > const< / span > device T* updates,< / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > 17< / span > device < a class = "code hl_struct" href = "structmlx__atomic.html" > mlx_atomic< T> < / a > * out,< / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > int< / span > * upd_shape,< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < span class = "keyword" > const< / span > constant int64_t* upd_strides,< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > size_t< / span > & upd_ndim,< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > size_t< / span > & upd_size,< / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > int< / span > * out_shape,< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "keyword" > const< / span > constant int64_t* out_strides,< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > size_t< / span > & out_ndim,< / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > int< / span > * axes,< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < span class = "keyword" > const< / span > constant < span class = "keywordtype" > size_t< / span > & idx_size,< / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / 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 = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > uint2 gid [[thread_position_in_grid]]) {< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > Op op;< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > 30< / span > < / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < span class = "keyword" > auto< / span > ind_idx = gid.y * NWORK;< / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > LocT out_offset = 0;< / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "keywordflow" > if< / span > (upd_size > 1) {< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > out_offset = < a class = "code hl_function" href = "backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a" > elem_to_loc< LocT> < / a > (< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > gid.x, upd_shape + indices.ndim, out_strides, out_ndim);< / 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 > < / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < span class = "keywordflow" > for< / span > (< span class = "keywordtype" > int< / span > j = 0; j < NWORK & & ind_idx < idx_size; ++j, ind_idx++) {< / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > LocT out_idx = out_offset;< / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < span class = "keywordflow" > for< / span > (< span class = "keywordtype" > int< / span > i = 0; i < NIDX; ++i) {< / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "keyword" > auto< / span > idx_loc = indices.row_contiguous[i]< / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > ? ind_idx< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > : < a class = "code hl_function" href = "backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a" > elem_to_loc< LocT> < / a > (< / div >
2024-11-23 04:24:16 +08:00
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > ind_idx,< / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > 45< / span > & indices.shapes[indices.ndim * i],< / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > 46< / span > & indices.strides[indices.ndim * i],< / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > 47< / span > indices.ndim);< / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > 48< / span > < span class = "keyword" > auto< / span > ax = axes[i];< / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > 49< / span > < span class = "keyword" > auto< / span > idx_val = < a class = "code hl_function" href = "kernels_2indexing_8h.html#a58a65ea6215999cd4ccb4fe757cc2dc8" > offset_neg_idx< / a > (indices.buffers[i][idx_loc], out_shape[ax]);< / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > 50< / span > out_idx +=< / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > < span class = "keyword" > static_cast< < / span > LocT< span class = "keyword" > > < / span > (idx_val) * < span class = "keyword" > static_cast< < / span > LocT< span class = "keyword" > > < / span > (out_strides[ax]);< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > }< / div >
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > < span class = "keyword" > auto< / span > upd_idx = ind_idx * < span class = "keyword" > static_cast< < / span > LocT< span class = "keyword" > > < / span > (upd_size) + gid.x;< / div >
< div class = "line" > < a id = "l00054" name = "l00054" > < / a > < span class = "lineno" > 54< / span > < span class = "keywordflow" > if< / span > < span class = "keyword" > constexpr< / span > (!UPD_ROW_CONTIG) {< / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00055" name = "l00055" > < / a > < span class = "lineno" > 55< / span > upd_idx = < a class = "code hl_function" href = "backend_2metal_2kernels_2utils_8h.html#a497dd9f1a00c8a4303d8782158a0812a" > elem_to_loc< LocT> < / a > (upd_idx, upd_shape, upd_strides, upd_ndim);< / div >
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > 56< / span > }< / div >
< div class = "line" > < a id = "l00057" name = "l00057" > < / a > < span class = "lineno" > 57< / span > op.atomic_update(out, updates[upd_idx], out_idx);< / div >
< div class = "line" > < a id = "l00058" name = "l00058" > < / a > < span class = "lineno" > 58< / span > }< / div >
< div class = "line" > < a id = "l00059" name = "l00059" > < / a > < span class = "lineno" > 59< / span > }< / div >
2024-10-15 23:12:17 +08:00
< / div >
2025-01-10 05:56:20 +08:00
< 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 >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "akernels_2indexing_8h_html" > < div class = "ttname" > < a href = "kernels_2indexing_8h.html" > indexing.h< / a > < / div > < / div >
2024-11-23 04:24:16 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "ascatter_8h_html_ab72d4fe1dbd4ae4dc529ee2ec8164fa4" > < div class = "ttname" > < a href = "scatter_8h.html#ab72d4fe1dbd4ae4dc529ee2ec8164fa4" > 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 int64_t *upd_strides, const constant size_t & upd_ndim, const constant size_t & upd_size, const constant int *out_shape, const constant int64_t *out_strides, const constant size_t & out_ndim, const constant int *axes, const constant size_t & idx_size, const thread Indices< IdxT, NIDX > & indices, uint2 gid)< / div > < div class = "ttdef" > < b > Definition< / b > scatter.h:15< / div > < / div >
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 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 -->
< / div > <!-- doc - content -->
2025-01-10 05:56:20 +08:00
<!-- 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 = "scatter_8h.html" > scatter.h< / a > < / li >
2025-02-07 04:16:29 +08:00
< 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 >
2025-01-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
