zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-11-04 10:38:10 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Files
db790ac051c6c911cc03fde33e375d3bf6418c12
mlx/docs/build/html/struct_sum.html
Awni Hannun db790ac051 docs update
2025-10-17 19:14:56 +00:00

234 lines
10 KiB
HTML
Raw Blame History

<!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: Sum&lt; U &gt; Struct Template 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>
<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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="struct_sum-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Sum&lt; U &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="backend_2metal_2kernels_2reduction_2ops_8h_source.html">ops.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acf10e0604098391526da3b8271928b5c" id="r_acf10e0604098391526da3b8271928b5c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:acf10e0604098391526da3b8271928b5c"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#acf10e0604098391526da3b8271928b5c">simd_reduce</a> (T val)</td></tr>
<tr class="separator:acf10e0604098391526da3b8271928b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3188318e74823f00b9367317ec22ad6b" id="r_a3188318e74823f00b9367317ec22ad6b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a3188318e74823f00b9367317ec22ad6b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3188318e74823f00b9367317ec22ad6b">atomic_update</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *out, T val, uint offset=0)</td></tr>
<tr class="separator:a3188318e74823f00b9367317ec22ad6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9bfdc5603dd2b888d9e1416b70aefcc" id="r_af9bfdc5603dd2b888d9e1416b70aefcc"><td class="memItemLeft" align="right" valign="top">U&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af9bfdc5603dd2b888d9e1416b70aefcc">operator()</a> (U a, U b)</td></tr>
<tr class="separator:af9bfdc5603dd2b888d9e1416b70aefcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a433bf0fe3ce751c18e5269bbc19daa65" id="r_a433bf0fe3ce751c18e5269bbc19daa65"><td class="memItemLeft" align="right" valign="top">static constexpr constant U&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a433bf0fe3ce751c18e5269bbc19daa65">init</a> = U(0)</td></tr>
<tr class="separator:a433bf0fe3ce751c18e5269bbc19daa65"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3188318e74823f00b9367317ec22ad6b" name="a3188318e74823f00b9367317ec22ad6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3188318e74823f00b9367317ec22ad6b">&#9670;&#160;</a></span>atomic_update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U &gt; </div>
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_sum.html">Sum</a>&lt; U &gt;::atomic_update </td>
<td>(</td>
<td class="paramtype">device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>val</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>offset</em><span class="paramdefsep"> = </span><span class="paramdefval">0</span></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af9bfdc5603dd2b888d9e1416b70aefcc" name="af9bfdc5603dd2b888d9e1416b70aefcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9bfdc5603dd2b888d9e1416b70aefcc">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">U <a class="el" href="struct_sum.html">Sum</a>&lt; U &gt;::operator() </td>
<td>(</td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>a</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">U</td> <td class="paramname"><span class="paramname"><em>b</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acf10e0604098391526da3b8271928b5c" name="acf10e0604098391526da3b8271928b5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf10e0604098391526da3b8271928b5c">&#9670;&#160;</a></span>simd_reduce()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U &gt; </div>
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="struct_sum.html">Sum</a>&lt; U &gt;::simd_reduce </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>val</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a433bf0fe3ce751c18e5269bbc19daa65" name="a433bf0fe3ce751c18e5269bbc19daa65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a433bf0fe3ce751c18e5269bbc19daa65">&#9670;&#160;</a></span>init</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr constant U <a class="el" href="struct_sum.html">Sum</a>&lt; U &gt;::init = U(0)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>mlx/backend/metal/kernels/reduction/<a class="el" href="backend_2metal_2kernels_2reduction_2ops_8h_source.html">ops.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink