zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 02:33:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
6269c69d0e
mlx/docs/build/html/atomic_8h.html
Awni Hannun 6269c69d0e docs update
2025-06-04 01:01:50 +00:00

521 lines
31 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: mlx/backend/metal/kernels/atomic.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>
<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 id="nav-path" class="navpath">
<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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">atomic.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;metal_atomic&gt;</code><br />
<code>#include &lt;metal_stdlib&gt;</code><br />
</div>
<p><a href="atomic_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmlx__atomic.html">mlx_atomic&lt; T, typename &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmlx__atomic_3_01_t_00_01enable__if__t_3_01is__metal__atomic_3_01_t_01_4_01_4_01_4.html">mlx_atomic&lt; T, enable_if_t&lt; is_metal_atomic&lt; T &gt; &gt; &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a802615a5c326e8dd4ab13fefa0231d4e" id="r_a802615a5c326e8dd4ab13fefa0231d4e"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a802615a5c326e8dd4ab13fefa0231d4e"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a802615a5c326e8dd4ab13fefa0231d4e">mlx_atomic_load_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, uint offset)</td></tr>
<tr class="separator:a802615a5c326e8dd4ab13fefa0231d4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8108e66ef9a5fa8c62e6a7c6504c43aa" id="r_a8108e66ef9a5fa8c62e6a7c6504c43aa"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a8108e66ef9a5fa8c62e6a7c6504c43aa"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8108e66ef9a5fa8c62e6a7c6504c43aa">mlx_atomic_store_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:a8108e66ef9a5fa8c62e6a7c6504c43aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65bd5cae890db9b927d853a52bdc06e8" id="r_a65bd5cae890db9b927d853a52bdc06e8"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a65bd5cae890db9b927d853a52bdc06e8"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a65bd5cae890db9b927d853a52bdc06e8">mlx_atomic_fetch_and_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:a65bd5cae890db9b927d853a52bdc06e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a995c2d054cc4faa7b86e9a8719ff3e6f" id="r_a995c2d054cc4faa7b86e9a8719ff3e6f"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a995c2d054cc4faa7b86e9a8719ff3e6f"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a995c2d054cc4faa7b86e9a8719ff3e6f">mlx_atomic_fetch_or_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:a995c2d054cc4faa7b86e9a8719ff3e6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab962bd4d6ee8040e930e03f54c5ac16a" id="r_ab962bd4d6ee8040e930e03f54c5ac16a"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:ab962bd4d6ee8040e930e03f54c5ac16a"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab962bd4d6ee8040e930e03f54c5ac16a">mlx_atomic_fetch_min_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:ab962bd4d6ee8040e930e03f54c5ac16a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafeb87661c0b216d994677807a78f6d7" id="r_aafeb87661c0b216d994677807a78f6d7"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:aafeb87661c0b216d994677807a78f6d7"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aafeb87661c0b216d994677807a78f6d7">mlx_atomic_fetch_max_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:aafeb87661c0b216d994677807a78f6d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37cbd062017e3d056782dcfa7f5f6add" id="r_a37cbd062017e3d056782dcfa7f5f6add"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a37cbd062017e3d056782dcfa7f5f6add"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a37cbd062017e3d056782dcfa7f5f6add">mlx_atomic_fetch_add_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:a37cbd062017e3d056782dcfa7f5f6add"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adea4b9574507634f411de665f4db7c3c" id="r_adea4b9574507634f411de665f4db7c3c"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:adea4b9574507634f411de665f4db7c3c"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#adea4b9574507634f411de665f4db7c3c">mlx_atomic_fetch_mul_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, uint offset)</td></tr>
<tr class="separator:adea4b9574507634f411de665f4db7c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af63dac2f2df485a85b490e58302491b3" id="r_af63dac2f2df485a85b490e58302491b3"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:af63dac2f2df485a85b490e58302491b3"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af63dac2f2df485a85b490e58302491b3">mlx_atomic_compare_exchange_weak_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, thread T *expected, T val, uint offset)</td></tr>
<tr class="separator:af63dac2f2df485a85b490e58302491b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa81c17d78ba4c9eb989f288000816c73" id="r_aa81c17d78ba4c9eb989f288000816c73"><td class="memItemLeft" align="right" valign="top">template&lt;&gt; </td></tr>
<tr class="memitem:aa81c17d78ba4c9eb989f288000816c73"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa81c17d78ba4c9eb989f288000816c73">mlx_atomic_fetch_min_explicit&lt; float &gt;</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; float &gt; *object, float val, uint offset)</td></tr>
<tr class="separator:aa81c17d78ba4c9eb989f288000816c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55a4a8fbb8951a18375bdb635cf81af0" id="r_a55a4a8fbb8951a18375bdb635cf81af0"><td class="memItemLeft" align="right" valign="top">template&lt;&gt; </td></tr>
<tr class="memitem:a55a4a8fbb8951a18375bdb635cf81af0"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a55a4a8fbb8951a18375bdb635cf81af0">mlx_atomic_fetch_max_explicit&lt; float &gt;</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; float &gt; *object, float val, uint offset)</td></tr>
<tr class="separator:a55a4a8fbb8951a18375bdb635cf81af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c328b82e1b4c8cd0e9c864ecac30136" id="r_a0c328b82e1b4c8cd0e9c864ecac30136"><td class="memTemplParams" colspan="2">template&lt;typename T , enable_if_t&lt;!<a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </td></tr>
<tr class="memitem:a0c328b82e1b4c8cd0e9c864ecac30136"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a0c328b82e1b4c8cd0e9c864ecac30136">mlx_atomic_compare_exchange_weak_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, thread uint *expected, uint val, uint offset)</td></tr>
<tr class="separator:a0c328b82e1b4c8cd0e9c864ecac30136"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a91a8bdcae647947a83c6689d7f252d24" id="r_a91a8bdcae647947a83c6689d7f252d24"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a91a8bdcae647947a83c6689d7f252d24"><td class="memTemplItemLeft" align="right" valign="top">constexpr constant bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a></td></tr>
<tr class="separator:a91a8bdcae647947a83c6689d7f252d24"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="af63dac2f2df485a85b490e58302491b3" name="af63dac2f2df485a85b490e58302491b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af63dac2f2df485a85b490e58302491b3">&#9670;&#160;</a></span>mlx_atomic_compare_exchange_weak_explicit() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC bool mlx_atomic_compare_exchange_weak_explicit </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>object</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">thread T *</td> <td class="paramname"><span class="paramname"><em>expected</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0c328b82e1b4c8cd0e9c864ecac30136" name="a0c328b82e1b4c8cd0e9c864ecac30136"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c328b82e1b4c8cd0e9c864ecac30136">&#9670;&#160;</a></span>mlx_atomic_compare_exchange_weak_explicit() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt;!<a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC bool mlx_atomic_compare_exchange_weak_explicit </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>object</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">thread uint *</td> <td class="paramname"><span class="paramname"><em>expected</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a37cbd062017e3d056782dcfa7f5f6add" name="a37cbd062017e3d056782dcfa7f5f6add"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37cbd062017e3d056782dcfa7f5f6add">&#9670;&#160;</a></span>mlx_atomic_fetch_add_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_add_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a65bd5cae890db9b927d853a52bdc06e8" name="a65bd5cae890db9b927d853a52bdc06e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65bd5cae890db9b927d853a52bdc06e8">&#9670;&#160;</a></span>mlx_atomic_fetch_and_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_and_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aafeb87661c0b216d994677807a78f6d7" name="aafeb87661c0b216d994677807a78f6d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafeb87661c0b216d994677807a78f6d7">&#9670;&#160;</a></span>mlx_atomic_fetch_max_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_max_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a55a4a8fbb8951a18375bdb635cf81af0" name="a55a4a8fbb8951a18375bdb635cf81af0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55a4a8fbb8951a18375bdb635cf81af0">&#9670;&#160;</a></span>mlx_atomic_fetch_max_explicit&lt; float &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void <a class="el" href="#aafeb87661c0b216d994677807a78f6d7">mlx_atomic_fetch_max_explicit</a>&lt; float &gt; </td>
<td>(</td>
<td class="paramtype">device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; float &gt; *</td> <td class="paramname"><span class="paramname"><em>object</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab962bd4d6ee8040e930e03f54c5ac16a" name="ab962bd4d6ee8040e930e03f54c5ac16a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab962bd4d6ee8040e930e03f54c5ac16a">&#9670;&#160;</a></span>mlx_atomic_fetch_min_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_min_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa81c17d78ba4c9eb989f288000816c73" name="aa81c17d78ba4c9eb989f288000816c73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa81c17d78ba4c9eb989f288000816c73">&#9670;&#160;</a></span>mlx_atomic_fetch_min_explicit&lt; float &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void <a class="el" href="#ab962bd4d6ee8040e930e03f54c5ac16a">mlx_atomic_fetch_min_explicit</a>&lt; float &gt; </td>
<td>(</td>
<td class="paramtype">device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; float &gt; *</td> <td class="paramname"><span class="paramname"><em>object</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adea4b9574507634f411de665f4db7c3c" name="adea4b9574507634f411de665f4db7c3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adea4b9574507634f411de665f4db7c3c">&#9670;&#160;</a></span>mlx_atomic_fetch_mul_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_mul_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a995c2d054cc4faa7b86e9a8719ff3e6f" name="a995c2d054cc4faa7b86e9a8719ff3e6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a995c2d054cc4faa7b86e9a8719ff3e6f">&#9670;&#160;</a></span>mlx_atomic_fetch_or_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_fetch_or_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a802615a5c326e8dd4ab13fefa0231d4e" name="a802615a5c326e8dd4ab13fefa0231d4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a802615a5c326e8dd4ab13fefa0231d4e">&#9670;&#160;</a></span>mlx_atomic_load_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC T mlx_atomic_load_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8108e66ef9a5fa8c62e6a7c6504c43aa" name="a8108e66ef9a5fa8c62e6a7c6504c43aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8108e66ef9a5fa8c62e6a7c6504c43aa">&#9670;&#160;</a></span>mlx_atomic_store_explicit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , enable_if_t&lt; <a class="el" href="#a91a8bdcae647947a83c6689d7f252d24">is_metal_atomic</a>&lt; T &gt;, bool &gt; = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">METAL_FUNC void mlx_atomic_store_explicit </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>object</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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a91a8bdcae647947a83c6689d7f252d24" name="a91a8bdcae647947a83c6689d7f252d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91a8bdcae647947a83c6689d7f252d24">&#9670;&#160;</a></span>is_metal_atomic</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr constant bool is_metal_atomic</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= _disjunction&lt;</div>
<div class="line"> is_same&lt;T, int&gt;,</div>
<div class="line"> is_same&lt;T, uint&gt;,</div>
<div class="line"> is_same&lt;T, ulong&gt;,</div>
<div class="line"> is_same&lt;T, float&gt;&gt;::value</div>
</div><!-- fragment -->
</div>
</div>
</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