2024-10-19 03:13:44 +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-19 03:13:44 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > MLX: mlx/backend/metal/kernels/sdpa_vector.h File Reference< / 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-19 03:13:44 +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-19 03:13:44 +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-19 03:13:44 +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-19 03:13:44 +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-19 03:13:44 +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('sdpa__vector_8h.html',''); initResizable(true); });
2024-10-19 03:13:44 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-19 03:13:44 +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 = "summary" >
2025-01-10 05:56:20 +08:00
< a href = "#func-members" > Functions< / a > |
< a href = "#var-members" > Variables< / a > < / div >
2024-10-19 03:13:44 +08:00
< div class = "headertitle" > < div class = "title" > sdpa_vector.h File Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < code > #include < metal_simdgroup> < / code > < br / >
< / div >
< p > < a href = "sdpa__vector_8h_source.html" > Go to the source code of this file.< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2025-02-07 04:16:29 +08:00
< tr class = "memitem:a826f7a3c7ab843abc0842241db3e57b3" id = "r_a826f7a3c7ab843abc0842241db3e57b3" > < td class = "memTemplParams" colspan = "2" > template< typename T, int D, int V = D> < / td > < / tr >
< tr class = "memitem:a826f7a3c7ab843abc0842241db3e57b3" > < td class = "memTemplItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memTemplItemRight" valign = "bottom" > < a class = "el" href = "#a826f7a3c7ab843abc0842241db3e57b3" > sdpa_vector< / a > (const device T *queries, const device T *keys, const device T *values, device T *out, const constant int & gqa_factor, const constant int & N, const constant size_t & k_stride, const constant size_t & v_stride, const constant float & scale, const device bool *mask, const constant int & mask_seq_stride, const constant int & mask_head_stride, uint3 tid, uint simd_gid, uint simd_lid)< / td > < / tr >
< tr class = "separator:a826f7a3c7ab843abc0842241db3e57b3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aae1a2f23b03e24734805b08ebc5c1a59" id = "r_aae1a2f23b03e24734805b08ebc5c1a59" > < td class = "memTemplParams" colspan = "2" > template< typename T, int D, int V = D> < / td > < / tr >
< tr class = "memitem:aae1a2f23b03e24734805b08ebc5c1a59" > < td class = "memTemplItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memTemplItemRight" valign = "bottom" > < a class = "el" href = "#aae1a2f23b03e24734805b08ebc5c1a59" > sdpa_vector_2pass_1< / a > (const device T *queries, const device T *keys, const device T *values, device float *out, device float *sums, device float *maxs, const constant int & gqa_factor, const constant int & N, const constant size_t & k_stride, const constant size_t & v_stride, const constant float & scale, const device bool *mask, const constant int & mask_seq_stride, const constant int & mask_head_stride, uint3 tid, uint simd_gid, uint simd_lid)< / td > < / tr >
< tr class = "separator:aae1a2f23b03e24734805b08ebc5c1a59" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-01-10 05:56:20 +08:00
< tr class = "memitem:a1368cf3618a4e03dbf743b3463205efe" id = "r_a1368cf3618a4e03dbf743b3463205efe" > < td class = "memTemplParams" colspan = "2" > template< typename T, int D> < / td > < / tr >
2024-11-23 04:24:16 +08:00
< tr class = "memitem:a1368cf3618a4e03dbf743b3463205efe" > < td class = "memTemplItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memTemplItemRight" valign = "bottom" > < a class = "el" href = "#a1368cf3618a4e03dbf743b3463205efe" > sdpa_vector_2pass_2< / a > (const device float *partials, const device float *sums, const device float *maxs, device T *out, uint3 tid, uint simd_gid, uint simd_lid)< / td > < / tr >
< tr class = "separator:a1368cf3618a4e03dbf743b3463205efe" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-01-10 05:56:20 +08:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "var-members" name = "var-members" > < / a >
Variables< / h2 > < / td > < / tr >
< tr class = "memitem:a6ed0dd113fe7d471fc0b869b8c028c81" id = "r_a6ed0dd113fe7d471fc0b869b8c028c81" > < td class = "memItemLeft" align = "right" valign = "top" > constant bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a6ed0dd113fe7d471fc0b869b8c028c81" > has_mask< / a > < / td > < / tr >
< tr class = "separator:a6ed0dd113fe7d471fc0b869b8c028c81" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-10-19 03:13:44 +08:00
< / table >
< h2 class = "groupheader" > Function Documentation< / h2 >
2025-02-07 04:16:29 +08:00
< a id = "a826f7a3c7ab843abc0842241db3e57b3" name = "a826f7a3c7ab843abc0842241db3e57b3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a826f7a3c7ab843abc0842241db3e57b3" > ◆   < / a > < / span > sdpa_vector()< / h2 >
2024-10-19 03:13:44 +08:00
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
2025-02-07 04:16:29 +08:00
template< typename T, int D, int V = D> < / div >
2024-10-19 03:13:44 +08:00
< table class = "memname" >
< tr >
< td class = "memname" > void sdpa_vector < / td >
< td > (< / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > queries< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > keys< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > values< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > out< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > gqa_factor< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > N< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant size_t & < / td > < td class = "paramname" > < span class = "paramname" > < em > k_stride< / em > < / span > , < / td >
< / tr >
2024-11-06 03:54:16 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant size_t & < / td > < td class = "paramname" > < span class = "paramname" > < em > v_stride< / em > < / span > , < / td >
< / tr >
2024-10-19 03:13:44 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant float & < / td > < td class = "paramname" > < span class = "paramname" > < em > scale< / em > < / span > , < / td >
< / tr >
2025-01-10 05:56:20 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device bool *< / td > < td class = "paramname" > < span class = "paramname" > < em > mask< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > mask_seq_stride< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > mask_head_stride< / em > < / span > , < / td >
< / tr >
2024-11-23 04:24:16 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint3< / td > < td class = "paramname" > < span class = "paramname" > < em > tid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_gid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_lid< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
2025-02-07 04:16:29 +08:00
< a id = "aae1a2f23b03e24734805b08ebc5c1a59" name = "aae1a2f23b03e24734805b08ebc5c1a59" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aae1a2f23b03e24734805b08ebc5c1a59" > ◆   < / a > < / span > sdpa_vector_2pass_1()< / h2 >
2024-11-23 04:24:16 +08:00
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
2025-02-07 04:16:29 +08:00
template< typename T, int D, int V = D> < / div >
2024-11-23 04:24:16 +08:00
< table class = "memname" >
< tr >
< td class = "memname" > void sdpa_vector_2pass_1 < / td >
< td > (< / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > queries< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > keys< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > values< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > out< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > sums< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > maxs< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > gqa_factor< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > N< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant size_t & < / td > < td class = "paramname" > < span class = "paramname" > < em > k_stride< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant size_t & < / td > < td class = "paramname" > < span class = "paramname" > < em > v_stride< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant float & < / td > < td class = "paramname" > < span class = "paramname" > < em > scale< / em > < / span > , < / td >
< / tr >
2025-01-10 05:56:20 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device bool *< / td > < td class = "paramname" > < span class = "paramname" > < em > mask< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > mask_seq_stride< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const constant int & < / td > < td class = "paramname" > < span class = "paramname" > < em > mask_head_stride< / em > < / span > , < / td >
< / tr >
2024-11-23 04:24:16 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint3< / td > < td class = "paramname" > < span class = "paramname" > < em > tid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_gid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_lid< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "a1368cf3618a4e03dbf743b3463205efe" name = "a1368cf3618a4e03dbf743b3463205efe" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1368cf3618a4e03dbf743b3463205efe" > ◆   < / a > < / span > sdpa_vector_2pass_2()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< div class = "memtemplate" >
2025-01-10 05:56:20 +08:00
template< typename T, int D> < / div >
2024-11-23 04:24:16 +08:00
< table class = "memname" >
< tr >
< td class = "memname" > void sdpa_vector_2pass_2 < / td >
< td > (< / td >
< td class = "paramtype" > const device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > partials< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > sums< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const device float *< / td > < td class = "paramname" > < span class = "paramname" > < em > maxs< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > device T *< / td > < td class = "paramname" > < span class = "paramname" > < em > out< / em > < / span > , < / td >
< / tr >
2024-10-19 03:13:44 +08:00
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint3< / td > < td class = "paramname" > < span class = "paramname" > < em > tid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_gid< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint< / td > < td class = "paramname" > < span class = "paramname" > < em > simd_lid< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2025-01-10 05:56:20 +08:00
< / div >
< / div >
< h2 class = "groupheader" > Variable Documentation< / h2 >
< a id = "a6ed0dd113fe7d471fc0b869b8c028c81" name = "a6ed0dd113fe7d471fc0b869b8c028c81" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6ed0dd113fe7d471fc0b869b8c028c81" > ◆   < / a > < / span > has_mask< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > constant bool has_mask< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-10-19 03:13:44 +08:00
< / div >
< / div >
< / 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 = "sdpa__vector_8h.html" > sdpa_vector.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-19 03:13:44 +08:00
< / body >
< / html >
