zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-09-18 10:26:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs update

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

215
docs/build/html/struct_or.html vendored
View File

@@ -71,226 +71,11 @@ $(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="struct_or-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Or&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:aef6b5abbbf3fd22981b8d27562022605" id="r_aef6b5abbbf3fd22981b8d27562022605"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef6b5abbbf3fd22981b8d27562022605">simd_reduce</a> (bool val)</td></tr>
<tr class="separator:aef6b5abbbf3fd22981b8d27562022605"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40840c0506bf4ed9a0771ba42c9ebb0f" id="r_a40840c0506bf4ed9a0771ba42c9ebb0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40840c0506bf4ed9a0771ba42c9ebb0f">atomic_update</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; unsigned int &gt; *out, bool val, uint elem_idx, uint offset=0)</td></tr>
<tr class="separator:a40840c0506bf4ed9a0771ba42c9ebb0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad1e6b5b015cd0910625da725afabdf3" id="r_aad1e6b5b015cd0910625da725afabdf3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aad1e6b5b015cd0910625da725afabdf3">atomic_update</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; bool &gt; *out, bool val, uint offset=0)</td></tr>
<tr class="separator:aad1e6b5b015cd0910625da725afabdf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a942628b1b3c6be9f486c15081a0cba8e" id="r_a942628b1b3c6be9f486c15081a0cba8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a942628b1b3c6be9f486c15081a0cba8e">update</a> (device bool *out, bool val)</td></tr>
<tr class="separator:a942628b1b3c6be9f486c15081a0cba8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3798a4c73565aee2430459146305e44f" id="r_a3798a4c73565aee2430459146305e44f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3798a4c73565aee2430459146305e44f">operator()</a> (bool a, bool b)</td></tr>
<tr class="separator:a3798a4c73565aee2430459146305e44f"><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:a6734c64e8048a209047fa18dd8bd49e8" id="r_a6734c64e8048a209047fa18dd8bd49e8"><td class="memItemLeft" align="right" valign="top">static constexpr constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6734c64e8048a209047fa18dd8bd49e8">init</a> = false</td></tr>
<tr class="separator:a6734c64e8048a209047fa18dd8bd49e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aad1e6b5b015cd0910625da725afabdf3" name="aad1e6b5b015cd0910625da725afabdf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad1e6b5b015cd0910625da725afabdf3">&#9670;&#160;</a></span>atomic_update() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::atomic_update </td>
<td>(</td>
<td class="paramtype">device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; bool &gt; *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</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="a40840c0506bf4ed9a0771ba42c9ebb0f" name="a40840c0506bf4ed9a0771ba42c9ebb0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40840c0506bf4ed9a0771ba42c9ebb0f">&#9670;&#160;</a></span>atomic_update() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::atomic_update </td>
<td>(</td>
<td class="paramtype">device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; unsigned int &gt; *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</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>elem_idx</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="a3798a4c73565aee2430459146305e44f" name="a3798a4c73565aee2430459146305e44f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3798a4c73565aee2430459146305e44f">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::operator() </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>a</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</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="aef6b5abbbf3fd22981b8d27562022605" name="aef6b5abbbf3fd22981b8d27562022605"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6b5abbbf3fd22981b8d27562022605">&#9670;&#160;</a></span>simd_reduce()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::simd_reduce </td>
<td>(</td>
<td class="paramtype">bool</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>
<a id="a942628b1b3c6be9f486c15081a0cba8e" name="a942628b1b3c6be9f486c15081a0cba8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a942628b1b3c6be9f486c15081a0cba8e">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::update </td>
<td>(</td>
<td class="paramtype">device bool *</td> <td class="paramname"><span class="paramname"><em>out</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>val</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>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6734c64e8048a209047fa18dd8bd49e8" name="a6734c64e8048a209047fa18dd8bd49e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6734c64e8048a209047fa18dd8bd49e8">&#9670;&#160;</a></span>init</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename U = bool&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr constant bool <a class="el" href="struct_or.html">Or</a>&lt; U &gt;::init = false</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>