docs update

This commit is contained in:
Awni Hannun
2024-08-23 12:14:53 -07:00
committed by CircleCI Docs
parent f5dcb1c2b9
commit 9da49a07a4
697 changed files with 15867 additions and 8594 deletions

View File

@@ -72,8 +72,7 @@ $(function() {
</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="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_max-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Max&lt; U &gt; Struct Template Reference</div></div>
</div><!--header-->
@@ -81,142 +80,27 @@ $(function() {
<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:a4f74440c6f1ce8247d5a87c2a8882080" id="r_a4f74440c6f1ce8247d5a87c2a8882080"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a4f74440c6f1ce8247d5a87c2a8882080"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4f74440c6f1ce8247d5a87c2a8882080">simd_reduce</a> (T val)</td></tr>
<tr class="separator:a4f74440c6f1ce8247d5a87c2a8882080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac478a5cd1f567164d786240589d9260c" id="r_ac478a5cd1f567164d786240589d9260c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac478a5cd1f567164d786240589d9260c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ac478a5cd1f567164d786240589d9260c">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:ac478a5cd1f567164d786240589d9260c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bcf100d50dc6c06833fd6e3e0345007" id="r_a5bcf100d50dc6c06833fd6e3e0345007"><td class="memItemLeft" align="right" valign="top">U&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5bcf100d50dc6c06833fd6e3e0345007">operator()</a> (U a, U b)</td></tr>
<tr class="separator:a5bcf100d50dc6c06833fd6e3e0345007"><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:aa985471d570c1009e5cbb174efcb9131" id="r_aa985471d570c1009e5cbb174efcb9131"><td class="memItemLeft" align="right" valign="top">static constexpr constant U&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa985471d570c1009e5cbb174efcb9131">init</a> = <a class="el" href="struct_limits.html">Limits</a>&lt;U&gt;::min</td></tr>
<tr class="separator:aa985471d570c1009e5cbb174efcb9131"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:adfee65117dbf49404241861d374b9c4d" id="r_adfee65117dbf49404241861d374b9c4d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:adfee65117dbf49404241861d374b9c4d"><td class="memTemplItemLeft" align="right" valign="top">b&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#adfee65117dbf49404241861d374b9c4d">a</a>: b</td></tr>
<tr class="separator:adfee65117dbf49404241861d374b9c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac478a5cd1f567164d786240589d9260c" name="ac478a5cd1f567164d786240589d9260c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac478a5cd1f567164d786240589d9260c">&#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_max.html">Max</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="a5bcf100d50dc6c06833fd6e3e0345007" name="a5bcf100d50dc6c06833fd6e3e0345007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bcf100d50dc6c06833fd6e3e0345007">&#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_max.html">Max</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="a4f74440c6f1ce8247d5a87c2a8882080" name="a4f74440c6f1ce8247d5a87c2a8882080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f74440c6f1ce8247d5a87c2a8882080">&#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_max.html">Max</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="aa985471d570c1009e5cbb174efcb9131" name="aa985471d570c1009e5cbb174efcb9131"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa985471d570c1009e5cbb174efcb9131">&#9670;&#160;</a></span>init</h2>
<a id="adfee65117dbf49404241861d374b9c4d" name="adfee65117dbf49404241861d374b9c4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfee65117dbf49404241861d374b9c4d">&#9670;&#160;</a></span>a</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">constexpr constant U <a class="el" href="struct_max.html">Max</a>&lt; U &gt;::init = <a class="el" href="struct_limits.html">Limits</a>&lt;U&gt;::min</td>
<td class="memname">b <a class="el" href="struct_max.html">Max</a>&lt; U &gt;::a</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>