mirror of
				https://github.com/ml-explore/mlx.git
				synced 2025-11-04 18:48:15 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			649 lines
		
	
	
		
			34 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			649 lines
		
	
	
		
			34 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.13.2"/>
 | 
						|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
 | 
						|
<title>MLX: mlx/backend/metal/kernels/reduction/reduce_row.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"/>
 | 
						|
<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&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()"> </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&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>
 | 
						|
</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&dn=expat.txt MIT */
 | 
						|
$(function(){initNavTree('reduce__row_8h.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="summary">
 | 
						|
<a href="#func-members">Functions</a>  </div>
 | 
						|
  <div class="headertitle"><div class="title">reduce_row.h File Reference</div></div>
 | 
						|
</div><!--header-->
 | 
						|
<div class="contents">
 | 
						|
 | 
						|
<p><a href="reduce__row_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>
 | 
						|
<tr class="memitem:a9d5e0049a2276f43702fc6907e74a35f" id="r_a9d5e0049a2276f43702fc6907e74a35f"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </td></tr>
 | 
						|
<tr class="memitem:a9d5e0049a2276f43702fc6907e74a35f"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9d5e0049a2276f43702fc6907e74a35f">per_thread_row_reduce</a> (thread U totals[N_WRITES], const device T *inputs[N_WRITES], int blocks, int extra, uint lsize_x, uint lid_x)</td></tr>
 | 
						|
<tr class="memdesc:a9d5e0049a2276f43702fc6907e74a35f"><td class="mdescLeft"> </td><td class="mdescRight">The thread group collaboratively reduces across the rows with bounds checking.  <br /></td></tr>
 | 
						|
<tr class="separator:a9d5e0049a2276f43702fc6907e74a35f"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:a045ec34228e77c79ec67d11c39ff097a" id="r_a045ec34228e77c79ec67d11c39ff097a"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </td></tr>
 | 
						|
<tr class="memitem:a045ec34228e77c79ec67d11c39ff097a"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a045ec34228e77c79ec67d11c39ff097a">per_thread_row_reduce</a> (thread U totals[N_WRITES], const device T *in, const constant size_t &reduction_size, int blocks, int extra, uint lsize_x, uint lid_x)</td></tr>
 | 
						|
<tr class="memdesc:a045ec34228e77c79ec67d11c39ff097a"><td class="mdescLeft"> </td><td class="mdescRight">Consecutive rows in a contiguous array.  <br /></td></tr>
 | 
						|
<tr class="separator:a045ec34228e77c79ec67d11c39ff097a"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:aee3cf6c55bc9a6d0046030f7dfd26e6b" id="r_aee3cf6c55bc9a6d0046030f7dfd26e6b"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </td></tr>
 | 
						|
<tr class="memitem:aee3cf6c55bc9a6d0046030f7dfd26e6b"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aee3cf6c55bc9a6d0046030f7dfd26e6b">per_thread_row_reduce</a> (thread U totals[N_WRITES], const device T *in, const int64_t row_idx, int blocks, int extra, const constant int *shape, const constant int64_t *strides, const constant int &ndim, uint lsize_x, uint lid_x)</td></tr>
 | 
						|
<tr class="memdesc:aee3cf6c55bc9a6d0046030f7dfd26e6b"><td class="mdescLeft"> </td><td class="mdescRight">Consecutive rows in an arbitrarily ordered array.  <br /></td></tr>
 | 
						|
<tr class="separator:aee3cf6c55bc9a6d0046030f7dfd26e6b"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:aa146bb611069fd2892f03714fd1cc3cf" id="r_aa146bb611069fd2892f03714fd1cc3cf"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </td></tr>
 | 
						|
<tr class="memitem:aa146bb611069fd2892f03714fd1cc3cf"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa146bb611069fd2892f03714fd1cc3cf">threadgroup_reduce</a> (thread U totals[N_WRITES], threadgroup U *shared_vals, uint3 lid, uint simd_lane_id, uint simd_per_group, uint simd_group_id)</td></tr>
 | 
						|
<tr class="memdesc:aa146bb611069fd2892f03714fd1cc3cf"><td class="mdescLeft"> </td><td class="mdescRight">Reduce within the threadgroup.  <br /></td></tr>
 | 
						|
<tr class="separator:aa146bb611069fd2892f03714fd1cc3cf"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:afd80a25fa84e6cc884dcc8698859ade1" id="r_afd80a25fa84e6cc884dcc8698859ade1"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS> </td></tr>
 | 
						|
<tr class="memitem:afd80a25fa84e6cc884dcc8698859ade1"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#afd80a25fa84e6cc884dcc8698859ade1">thread_reduce</a> (thread U &total, const device T *row, int blocks, int extra)</td></tr>
 | 
						|
<tr class="separator:afd80a25fa84e6cc884dcc8698859ade1"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:a1e1b59fa73d2b0be978494a759f2c6ee" id="r_a1e1b59fa73d2b0be978494a759f2c6ee"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, typename IdxT, int NDIMS, int N_READS = REDUCE_N_READS> </td></tr>
 | 
						|
<tr class="memitem:a1e1b59fa73d2b0be978494a759f2c6ee"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1e1b59fa73d2b0be978494a759f2c6ee">row_reduce_small</a> (const device T *in, device U *out, const constant int64_t &row_size, const constant int64_t &non_row_reductions, const constant int *shape, const constant int64_t *strides, const constant int &ndim, const constant int *reduce_shape, const constant int64_t *reduce_strides, const constant int &reduce_ndim, uint simd_lane_id, uint3 gid, uint3 gsize, uint3 tid, uint3 tsize)</td></tr>
 | 
						|
<tr class="separator:a1e1b59fa73d2b0be978494a759f2c6ee"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:a7dbd7cc81b1ce5a4271d56b99ce595d4" id="r_a7dbd7cc81b1ce5a4271d56b99ce595d4"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, typename IdxT = int64_t, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </td></tr>
 | 
						|
<tr class="memitem:a7dbd7cc81b1ce5a4271d56b99ce595d4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7dbd7cc81b1ce5a4271d56b99ce595d4">row_reduce_simple</a> (const device T *in, device U *out, const constant size_t &reduction_size, const constant int64_t &out_size, uint3 gid, uint3 gsize, uint3 lid, uint3 lsize, uint simd_lane_id, uint simd_per_group, uint simd_group_id)</td></tr>
 | 
						|
<tr class="separator:a7dbd7cc81b1ce5a4271d56b99ce595d4"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
<tr class="memitem:a72611b8006ae5642b69f4d250d69865b" id="r_a72611b8006ae5642b69f4d250d69865b"><td class="memTemplParams" colspan="2">template<typename T, typename U, typename Op, typename IdxT, int NDIMS, int N_READS = REDUCE_N_READS> </td></tr>
 | 
						|
<tr class="memitem:a72611b8006ae5642b69f4d250d69865b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a72611b8006ae5642b69f4d250d69865b">row_reduce_looped</a> (const device T *in, device U *out, const constant int64_t &row_size, const constant int64_t &non_row_reductions, const constant int *shape, const constant int64_t *strides, const constant int &ndim, const constant int *reduce_shape, const constant int64_t *reduce_strides, const constant int &reduce_ndim, uint3 gid, uint3 gsize, uint3 lid, uint3 lsize, uint simd_lane_id, uint simd_per_group, uint simd_group_id)</td></tr>
 | 
						|
<tr class="separator:a72611b8006ae5642b69f4d250d69865b"><td class="memSeparator" colspan="2"> </td></tr>
 | 
						|
</table>
 | 
						|
<h2 class="groupheader">Function Documentation</h2>
 | 
						|
<a id="a045ec34228e77c79ec67d11c39ff097a" name="a045ec34228e77c79ec67d11c39ff097a"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#a045ec34228e77c79ec67d11c39ff097a">◆ </a></span>per_thread_row_reduce() <span class="overload">[1/3]</span></h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">METAL_FUNC void per_thread_row_reduce </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">thread U</td>          <td class="paramname"><span class="paramname"><em>totals</em></span>[N_WRITES], </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>in</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>reduction_size</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>blocks</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>extra</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lsize_x</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lid_x</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
<p>Consecutive rows in a contiguous array. </p>
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="aee3cf6c55bc9a6d0046030f7dfd26e6b" name="aee3cf6c55bc9a6d0046030f7dfd26e6b"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#aee3cf6c55bc9a6d0046030f7dfd26e6b">◆ </a></span>per_thread_row_reduce() <span class="overload">[2/3]</span></h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">METAL_FUNC void per_thread_row_reduce </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">thread U</td>          <td class="paramname"><span class="paramname"><em>totals</em></span>[N_WRITES], </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>in</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const int64_t</td>          <td class="paramname"><span class="paramname"><em>row_idx</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>blocks</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>extra</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>shape</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t *</td>          <td class="paramname"><span class="paramname"><em>strides</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>ndim</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lsize_x</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lid_x</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
<p>Consecutive rows in an arbitrarily ordered array. </p>
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="a9d5e0049a2276f43702fc6907e74a35f" name="a9d5e0049a2276f43702fc6907e74a35f"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#a9d5e0049a2276f43702fc6907e74a35f">◆ </a></span>per_thread_row_reduce() <span class="overload">[3/3]</span></h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">METAL_FUNC void per_thread_row_reduce </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">thread U</td>          <td class="paramname"><span class="paramname"><em>totals</em></span>[N_WRITES], </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>inputs</em></span>[N_WRITES], </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>blocks</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>extra</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lsize_x</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>lid_x</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
<p>The thread group collaboratively reduces across the rows with bounds checking. </p>
 | 
						|
<p>In the end each thread holds a part of the reduction. </p>
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="a72611b8006ae5642b69f4d250d69865b" name="a72611b8006ae5642b69f4d250d69865b"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#a72611b8006ae5642b69f4d250d69865b">◆ </a></span>row_reduce_looped()</h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, typename IdxT, int NDIMS, int N_READS = REDUCE_N_READS> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">void row_reduce_looped </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>in</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">device U *</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 int64_t &</td>          <td class="paramname"><span class="paramname"><em>row_size</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t &</td>          <td class="paramname"><span class="paramname"><em>non_row_reductions</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>shape</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t *</td>          <td class="paramname"><span class="paramname"><em>strides</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>ndim</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>reduce_shape</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t *</td>          <td class="paramname"><span class="paramname"><em>reduce_strides</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>reduce_ndim</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gsize</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>lid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>lsize</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_lane_id</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_per_group</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_group_id</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="a7dbd7cc81b1ce5a4271d56b99ce595d4" name="a7dbd7cc81b1ce5a4271d56b99ce595d4"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#a7dbd7cc81b1ce5a4271d56b99ce595d4">◆ </a></span>row_reduce_simple()</h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, typename IdxT = int64_t, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">void row_reduce_simple </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>in</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">device U *</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 size_t &</td>          <td class="paramname"><span class="paramname"><em>reduction_size</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t &</td>          <td class="paramname"><span class="paramname"><em>out_size</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gsize</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>lid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>lsize</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_lane_id</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_per_group</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_group_id</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="a1e1b59fa73d2b0be978494a759f2c6ee" name="a1e1b59fa73d2b0be978494a759f2c6ee"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#a1e1b59fa73d2b0be978494a759f2c6ee">◆ </a></span>row_reduce_small()</h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, typename IdxT, int NDIMS, int N_READS = REDUCE_N_READS> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">void row_reduce_small </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">const device T *</td>          <td class="paramname"><span class="paramname"><em>in</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">device U *</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 int64_t &</td>          <td class="paramname"><span class="paramname"><em>row_size</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t &</td>          <td class="paramname"><span class="paramname"><em>non_row_reductions</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>shape</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t *</td>          <td class="paramname"><span class="paramname"><em>strides</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>ndim</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>reduce_shape</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">const constant int64_t *</td>          <td class="paramname"><span class="paramname"><em>reduce_strides</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>reduce_ndim</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_lane_id</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>gsize</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <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">uint3</td>          <td class="paramname"><span class="paramname"><em>tsize</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="afd80a25fa84e6cc884dcc8698859ade1" name="afd80a25fa84e6cc884dcc8698859ade1"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#afd80a25fa84e6cc884dcc8698859ade1">◆ </a></span>thread_reduce()</h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">METAL_FUNC void thread_reduce </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">thread U &</td>          <td class="paramname"><span class="paramname"><em>total</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>row</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>blocks</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">int</td>          <td class="paramname"><span class="paramname"><em>extra</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
<a id="aa146bb611069fd2892f03714fd1cc3cf" name="aa146bb611069fd2892f03714fd1cc3cf"></a>
 | 
						|
<h2 class="memtitle"><span class="permalink"><a href="#aa146bb611069fd2892f03714fd1cc3cf">◆ </a></span>threadgroup_reduce()</h2>
 | 
						|
 | 
						|
<div class="memitem">
 | 
						|
<div class="memproto">
 | 
						|
<div class="memtemplate">
 | 
						|
template<typename T, typename U, typename Op, int N_READS = REDUCE_N_READS, int N_WRITES = REDUCE_N_WRITES> </div>
 | 
						|
      <table class="memname">
 | 
						|
        <tr>
 | 
						|
          <td class="memname">METAL_FUNC void threadgroup_reduce </td>
 | 
						|
          <td>(</td>
 | 
						|
          <td class="paramtype">thread U</td>          <td class="paramname"><span class="paramname"><em>totals</em></span>[N_WRITES], </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">threadgroup U *</td>          <td class="paramname"><span class="paramname"><em>shared_vals</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint3</td>          <td class="paramname"><span class="paramname"><em>lid</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_lane_id</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_per_group</em></span>, </td>
 | 
						|
        </tr>
 | 
						|
        <tr>
 | 
						|
          <td class="paramkey"></td>
 | 
						|
          <td></td>
 | 
						|
          <td class="paramtype">uint</td>          <td class="paramname"><span class="paramname"><em>simd_group_id</em></span> )</td>
 | 
						|
        </tr>
 | 
						|
      </table>
 | 
						|
</div><div class="memdoc">
 | 
						|
 | 
						|
<p>Reduce within the threadgroup. </p>
 | 
						|
 | 
						|
</div>
 | 
						|
</div>
 | 
						|
</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="dir_f60cd69d27fd3faa641c79056fff0e2d.html">reduction</a></li><li class="navelem"><a class="el" href="reduce__row_8h.html">reduce_row.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>
 |