zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 18:51:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
9b53df2ca9
mlx/docs/build/html/struct_or.html

292 lines
13 KiB
HTML
Raw Normal View History

docs update
2024-05-10 23:49:36 +08:00
<!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: Or Struct 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_or-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Or Struct 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:a7c32fbf3039b1becf469e42b56a4d99f" id="r_a7c32fbf3039b1becf469e42b56a4d99f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c32fbf3039b1becf469e42b56a4d99f">simd_reduce</a> (bool val)</td></tr>
<tr class="separator:a7c32fbf3039b1becf469e42b56a4d99f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b0cdb18509f9a5c27a8055eda552d34" id="r_a4b0cdb18509f9a5c27a8055eda552d34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b0cdb18509f9a5c27a8055eda552d34">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:a4b0cdb18509f9a5c27a8055eda552d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14399ada78a7d65f7d67dbc8a7dc577a" id="r_a14399ada78a7d65f7d67dbc8a7dc577a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a14399ada78a7d65f7d67dbc8a7dc577a">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:a14399ada78a7d65f7d67dbc8a7dc577a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65afbdc52a8cf13b1533f99e82edb574" id="r_a65afbdc52a8cf13b1533f99e82edb574"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a65afbdc52a8cf13b1533f99e82edb574">update</a> (device bool *out, bool val)</td></tr>
<tr class="separator:a65afbdc52a8cf13b1533f99e82edb574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3df0639f60bbbfa462e384ed854a684a" id="r_a3df0639f60bbbfa462e384ed854a684a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3df0639f60bbbfa462e384ed854a684a">operator()</a> (bool a, bool b)</td></tr>
<tr class="separator:a3df0639f60bbbfa462e384ed854a684a"><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:a9e7135dc9686bb30f78970a2b134d30f" id="r_a9e7135dc9686bb30f78970a2b134d30f"><td class="memItemLeft" align="right" valign="top">static constexpr constant bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e7135dc9686bb30f78970a2b134d30f">init</a> = false</td></tr>
<tr class="separator:a9e7135dc9686bb30f78970a2b134d30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a14399ada78a7d65f7d67dbc8a7dc577a" name="a14399ada78a7d65f7d67dbc8a7dc577a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14399ada78a7d65f7d67dbc8a7dc577a">&#9670;&#160;</a></span>atomic_update() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Or::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="a4b0cdb18509f9a5c27a8055eda552d34" name="a4b0cdb18509f9a5c27a8055eda552d34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b0cdb18509f9a5c27a8055eda552d34">&#9670;&#160;</a></span>atomic_update() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Or::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="a3df0639f60bbbfa462e384ed854a684a" name="a3df0639f60bbbfa462e384ed854a684a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3df0639f60bbbfa462e384ed854a684a">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Or::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="a7c32fbf3039b1becf469e42b56a4d99f" name="a7c32fbf3039b1becf469e42b56a4d99f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c32fbf3039b1becf469e42b56a4d99f">&#9670;&#160;</a></span>simd_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Or::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="a65afbdc52a8cf13b1533f99e82edb574" name="a65afbdc52a8cf13b1533f99e82edb574"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65afbdc52a8cf13b1533f99e82edb574">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Or::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="a9e7135dc9686bb30f78970a2b134d30f" name="a9e7135dc9686bb30f78970a2b134d30f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e7135dc9686bb30f78970a2b134d30f">&#9670;&#160;</a></span>init</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr constant bool Or::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>
</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 Copy Permalink