mirror of
				https://github.com/ml-explore/mlx.git
				synced 2025-11-04 02:28:13 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			183 lines
		
	
	
		
			18 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			183 lines
		
	
	
		
			18 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!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.10.0"/>
 | 
						|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
 | 
						|
<title>MLX: mlx/backend/metal/kernels/reduction/reduce_inst.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>
 | 
						|
<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.10.0 -->
 | 
						|
<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" src="menudata.js"></script>
 | 
						|
<script type="text/javascript" src="menu.js"></script>
 | 
						|
<script type="text/javascript">
 | 
						|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
 | 
						|
$(function() {
 | 
						|
  initMenu('',true,false,'search.php','Search');
 | 
						|
  $(function() { init_search(); });
 | 
						|
});
 | 
						|
/* @license-end */
 | 
						|
</script>
 | 
						|
<div id="main-nav"></div>
 | 
						|
<script type="text/javascript">
 | 
						|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
 | 
						|
$(function() { codefold.init(0); });
 | 
						|
/* @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><li class="navelem"><a class="el" href="dir_f60cd69d27fd3faa641c79056fff0e2d.html">reduction</a></li>  </ul>
 | 
						|
</div>
 | 
						|
</div><!-- top -->
 | 
						|
<div class="header">
 | 
						|
  <div class="headertitle"><div class="title">reduce_inst.h</div></div>
 | 
						|
</div><!--header-->
 | 
						|
<div class="contents">
 | 
						|
<a href="reduce__inst_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 <metal_atomic></span></div>
 | 
						|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="preprocessor">#include <metal_simdgroup></span></div>
 | 
						|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span> </div>
 | 
						|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#include "<a class="code" href="defines_8h.html">mlx/backend/metal/kernels/defines.h</a>"</span></div>
 | 
						|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include "<a class="code" href="backend_2metal_2kernels_2reduction_2ops_8h.html">mlx/backend/metal/kernels/reduction/ops.h</a>"</span></div>
 | 
						|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
 | 
						|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">// clang-format off</span></div>
 | 
						|
<div class="foldopen" id="foldopen00012" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#a5294673da0e734544c8444e8af87c764">   12</a></span><span class="preprocessor">#define instantiate_reduce_helper_floats(inst_f, name, op)         \</span></div>
 | 
						|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">  inst_f(name, float16, half, op) inst_f(name, float32, float, op) \</span></div>
 | 
						|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">  inst_f(name, bfloat16, bfloat16_t, op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00016" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#a8f0294fcedd9f4ae582a49d2c6b2539d">   16</a></span><span class="preprocessor">#define instantiate_reduce_helper_uints(inst_f, name, op)             \</span></div>
 | 
						|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="preprocessor">  inst_f(name, uint8, uint8_t, op) inst_f(name, uint16, uint16_t, op) \</span></div>
 | 
						|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="preprocessor">  inst_f(name, uint32, uint32_t, op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00020" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#a3b665b5cd2a4bffab618143b736bd722">   20</a></span><span class="preprocessor">#define instantiate_reduce_helper_ints(inst_f, name, op)          \</span></div>
 | 
						|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">  inst_f(name, int8, int8_t, op) inst_f(name, int16, int16_t, op) \</span></div>
 | 
						|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">  inst_f(name, int32, int32_t, op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00024" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#aaf5acbc6baa20c2422f8864771bd046f">   24</a></span><span class="preprocessor">#define instantiate_reduce_helper_64b(inst_f, name, op) \</span></div>
 | 
						|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">  inst_f(name, int64, int64_t, op) inst_f(name, uint64, uint64_t, op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00027" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#acc929f2a0f9c70d46d8723ede3020f37">   27</a></span><span class="preprocessor">#define instantiate_reduce_helper_types(inst_f, name, op) \</span></div>
 | 
						|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">  instantiate_reduce_helper_floats(inst_f, name, op)      \</span></div>
 | 
						|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">  instantiate_reduce_helper_uints(inst_f, name, op)   \</span></div>
 | 
						|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">  instantiate_reduce_helper_ints(inst_f, name, op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00032" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#a1f005addb1d2895cfdaa015b1e332dd4">   32</a></span><span class="preprocessor">#define instantiate_reduce_ops(inst_f, type_f)        \</span></div>
 | 
						|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">  type_f(inst_f, sum, Sum) type_f(inst_f, prod, Prod) \</span></div>
 | 
						|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="preprocessor">  type_f(inst_f, min_, Min) type_f(inst_f, max_, Max)</span></div>
 | 
						|
</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="comment">// Special case for bool reductions</span></div>
 | 
						|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#a3ec546a1689f8f3af2d94877a4d19aa3">   37</a></span><span class="preprocessor">#define instantiate_reduce_from_types_helper( \</span></div>
 | 
						|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="preprocessor">    inst_f, name, tname, itype, otype, op)    \</span></div>
 | 
						|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="preprocessor">    inst_f(name##tname, itype, otype, op)</span></div>
 | 
						|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
 | 
						|
<div class="foldopen" id="foldopen00041" data-start="" data-end="">
 | 
						|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="reduce__inst_8h.html#ad84ee425af547740b942caf64f2369ae">   41</a></span><span class="preprocessor">#define instantiate_reduce_from_types(inst_f, name, otype, op)  \</span></div>
 | 
						|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="preprocessor">    inst_f, name, bool_, bool, otype, op)                       \</span></div>
 | 
						|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">    inst_f, name, uint8, uint8_t, otype, op)                    \</span></div>
 | 
						|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">    inst_f, name, uint16, uint16_t, otype, op)                  \</span></div>
 | 
						|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">    inst_f, name, uint32, uint32_t, otype, op)                  \</span></div>
 | 
						|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="preprocessor">    inst_f, name, int8, int8_t, otype, op)                      \</span></div>
 | 
						|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">    inst_f, name, int16, int16_t, otype, op)                    \</span></div>
 | 
						|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="preprocessor">    inst_f, name, int32, int32_t, otype, op)                    \</span></div>
 | 
						|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="preprocessor">    inst_f, name, int64, int64_t, otype, op)                    \</span></div>
 | 
						|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="preprocessor">    inst_f, name, float16, half, otype, op)                     \</span></div>
 | 
						|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="preprocessor">    inst_f,                                                     \</span></div>
 | 
						|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">    name,                                                       \</span></div>
 | 
						|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">    float32,                                                    \</span></div>
 | 
						|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="preprocessor">    float,                                                      \</span></div>
 | 
						|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">    otype,                                                      \</span></div>
 | 
						|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">    op)                                                         \</span></div>
 | 
						|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="preprocessor">  instantiate_reduce_from_types_helper(                         \</span></div>
 | 
						|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="preprocessor">    inst_f,                                                     \</span></div>
 | 
						|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="preprocessor">    name,                                                       \</span></div>
 | 
						|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="preprocessor">    bfloat16,                                                   \</span></div>
 | 
						|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="preprocessor">    bfloat16_t,                                                 \</span></div>
 | 
						|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="preprocessor">    otype,                                                      \</span></div>
 | 
						|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="preprocessor">    op)</span></div>
 | 
						|
</div>
 | 
						|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">// clang-format on</span></div>
 | 
						|
<div class="ttc" id="abackend_2metal_2kernels_2reduction_2ops_8h_html"><div class="ttname"><a href="backend_2metal_2kernels_2reduction_2ops_8h.html">ops.h</a></div></div>
 | 
						|
<div class="ttc" id="adefines_8h_html"><div class="ttname"><a href="defines_8h.html">defines.h</a></div></div>
 | 
						|
</div><!-- fragment --></div><!-- contents -->
 | 
						|
<!-- start footer part -->
 | 
						|
<hr class="footer"/><address class="footer"><small>
 | 
						|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
 | 
						|
</small></address>
 | 
						|
</body>
 | 
						|
</html>
 |