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
50b9530af5
mlx/docs/build/html/atomic_8h.html

521 lines
32 KiB
HTML
Raw Normal View History

docs update
2024-06-07 11:28:06 +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: 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>
docs update
2024-08-24 03:14:53 +08:00
<tr class="memitem:a253a4e8c2c5768a069e2791b627dfc99" id="r_a253a4e8c2c5768a069e2791b627dfc99"><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:a253a4e8c2c5768a069e2791b627dfc99"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a253a4e8c2c5768a069e2791b627dfc99">mlx_atomic_load_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, size_t offset)</td></tr>
<tr class="separator:a253a4e8c2c5768a069e2791b627dfc99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ae453140b0819a4c02f265334de98c0" id="r_a0ae453140b0819a4c02f265334de98c0"><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:a0ae453140b0819a4c02f265334de98c0"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a0ae453140b0819a4c02f265334de98c0">mlx_atomic_store_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:a0ae453140b0819a4c02f265334de98c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a253e3c870c0ddc7c28ab2f6ca2c3eae5" id="r_a253e3c870c0ddc7c28ab2f6ca2c3eae5"><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:a253e3c870c0ddc7c28ab2f6ca2c3eae5"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a253e3c870c0ddc7c28ab2f6ca2c3eae5">mlx_atomic_fetch_and_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:a253e3c870c0ddc7c28ab2f6ca2c3eae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7391f197001471e4788312bdb6ab37a" id="r_ab7391f197001471e4788312bdb6ab37a"><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:ab7391f197001471e4788312bdb6ab37a"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab7391f197001471e4788312bdb6ab37a">mlx_atomic_fetch_or_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:ab7391f197001471e4788312bdb6ab37a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ec33dca0039bd944d73d1c2b378cc19" id="r_a2ec33dca0039bd944d73d1c2b378cc19"><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:a2ec33dca0039bd944d73d1c2b378cc19"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2ec33dca0039bd944d73d1c2b378cc19">mlx_atomic_fetch_min_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:a2ec33dca0039bd944d73d1c2b378cc19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac480f2b459a8ad9095cee353e152d00c" id="r_ac480f2b459a8ad9095cee353e152d00c"><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:ac480f2b459a8ad9095cee353e152d00c"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ac480f2b459a8ad9095cee353e152d00c">mlx_atomic_fetch_max_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:ac480f2b459a8ad9095cee353e152d00c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad448d9e06e001700b65ca8317216a3b" id="r_aad448d9e06e001700b65ca8317216a3b"><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:aad448d9e06e001700b65ca8317216a3b"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aad448d9e06e001700b65ca8317216a3b">mlx_atomic_fetch_add_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:aad448d9e06e001700b65ca8317216a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfdbea60436f14f1af9ce36e2a0a77a3" id="r_adfdbea60436f14f1af9ce36e2a0a77a3"><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:adfdbea60436f14f1af9ce36e2a0a77a3"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#adfdbea60436f14f1af9ce36e2a0a77a3">mlx_atomic_fetch_mul_explicit</a> (device <a class="el" href="structmlx__atomic.html">mlx_atomic</a>&lt; T &gt; *object, T val, size_t offset)</td></tr>
<tr class="separator:adfdbea60436f14f1af9ce36e2a0a77a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7f32327ff66354cfa2f0cfdac79316f" id="r_ad7f32327ff66354cfa2f0cfdac79316f"><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:ad7f32327ff66354cfa2f0cfdac79316f"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad7f32327ff66354cfa2f0cfdac79316f">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, size_t offset)</td></tr>
<tr class="separator:ad7f32327ff66354cfa2f0cfdac79316f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7d1dc49f319f239b7ee0b7c72976dd0" id="r_ab7d1dc49f319f239b7ee0b7c72976dd0"><td class="memItemLeft" align="right" valign="top">template&lt;&gt; </td></tr>
<tr class="memitem:ab7d1dc49f319f239b7ee0b7c72976dd0"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab7d1dc49f319f239b7ee0b7c72976dd0">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, size_t offset)</td></tr>
<tr class="separator:ab7d1dc49f319f239b7ee0b7c72976dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dce2abfa16417122c4d2bf261129ae4" id="r_a1dce2abfa16417122c4d2bf261129ae4"><td class="memItemLeft" align="right" valign="top">template&lt;&gt; </td></tr>
<tr class="memitem:a1dce2abfa16417122c4d2bf261129ae4"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1dce2abfa16417122c4d2bf261129ae4">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, size_t offset)</td></tr>
<tr class="separator:a1dce2abfa16417122c4d2bf261129ae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8f47b2e9b95d4b00ad51f08b070deb5" id="r_aa8f47b2e9b95d4b00ad51f08b070deb5"><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:aa8f47b2e9b95d4b00ad51f08b070deb5"><td class="memTemplItemLeft" align="right" valign="top">METAL_FUNC bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa8f47b2e9b95d4b00ad51f08b070deb5">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, size_t offset)</td></tr>
<tr class="separator:aa8f47b2e9b95d4b00ad51f08b070deb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
docs update
2024-06-07 11:28:06 +08:00
</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>
docs update
2024-08-24 03:14:53 +08:00
<a id="ad7f32327ff66354cfa2f0cfdac79316f" name="ad7f32327ff66354cfa2f0cfdac79316f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7f32327ff66354cfa2f0cfdac79316f">&#9670;&#160;</a></span>mlx_atomic_compare_exchange_weak_explicit() <span class="overload">[1/2]</span></h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="aa8f47b2e9b95d4b00ad51f08b070deb5" name="aa8f47b2e9b95d4b00ad51f08b070deb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8f47b2e9b95d4b00ad51f08b070deb5">&#9670;&#160;</a></span>mlx_atomic_compare_exchange_weak_explicit() <span class="overload">[2/2]</span></h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="aad448d9e06e001700b65ca8317216a3b" name="aad448d9e06e001700b65ca8317216a3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad448d9e06e001700b65ca8317216a3b">&#9670;&#160;</a></span>mlx_atomic_fetch_add_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="a253e3c870c0ddc7c28ab2f6ca2c3eae5" name="a253e3c870c0ddc7c28ab2f6ca2c3eae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a253e3c870c0ddc7c28ab2f6ca2c3eae5">&#9670;&#160;</a></span>mlx_atomic_fetch_and_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="ac480f2b459a8ad9095cee353e152d00c" name="ac480f2b459a8ad9095cee353e152d00c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac480f2b459a8ad9095cee353e152d00c">&#9670;&#160;</a></span>mlx_atomic_fetch_max_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="a1dce2abfa16417122c4d2bf261129ae4" name="a1dce2abfa16417122c4d2bf261129ae4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dce2abfa16417122c4d2bf261129ae4">&#9670;&#160;</a></span>mlx_atomic_fetch_max_explicit&lt; float &gt;()</h2>
docs update
2024-06-07 11:28:06 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;&gt; </div>
<table class="memname">
<tr>
docs update
2024-08-24 03:14:53 +08:00
<td class="memname">METAL_FUNC void <a class="el" href="#ac480f2b459a8ad9095cee353e152d00c">mlx_atomic_fetch_max_explicit</a>&lt; float &gt; </td>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="a2ec33dca0039bd944d73d1c2b378cc19" name="a2ec33dca0039bd944d73d1c2b378cc19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ec33dca0039bd944d73d1c2b378cc19">&#9670;&#160;</a></span>mlx_atomic_fetch_min_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="ab7d1dc49f319f239b7ee0b7c72976dd0" name="ab7d1dc49f319f239b7ee0b7c72976dd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7d1dc49f319f239b7ee0b7c72976dd0">&#9670;&#160;</a></span>mlx_atomic_fetch_min_explicit&lt; float &gt;()</h2>
docs update
2024-06-07 11:28:06 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;&gt; </div>
<table class="memname">
<tr>
docs update
2024-08-24 03:14:53 +08:00
<td class="memname">METAL_FUNC void <a class="el" href="#a2ec33dca0039bd944d73d1c2b378cc19">mlx_atomic_fetch_min_explicit</a>&lt; float &gt; </td>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="adfdbea60436f14f1af9ce36e2a0a77a3" name="adfdbea60436f14f1af9ce36e2a0a77a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfdbea60436f14f1af9ce36e2a0a77a3">&#9670;&#160;</a></span>mlx_atomic_fetch_mul_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="ab7391f197001471e4788312bdb6ab37a" name="ab7391f197001471e4788312bdb6ab37a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7391f197001471e4788312bdb6ab37a">&#9670;&#160;</a></span>mlx_atomic_fetch_or_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="a253a4e8c2c5768a069e2791b627dfc99" name="a253a4e8c2c5768a069e2791b627dfc99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a253a4e8c2c5768a069e2791b627dfc99">&#9670;&#160;</a></span>mlx_atomic_load_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
docs update
2024-08-24 03:14:53 +08:00
<a id="a0ae453140b0819a4c02f265334de98c0" name="a0ae453140b0819a4c02f265334de98c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae453140b0819a4c02f265334de98c0">&#9670;&#160;</a></span>mlx_atomic_store_explicit()</h2>
docs update
2024-06-07 11:28:06 +08:00
<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>
docs update
2024-08-24 03:14:53 +08:00
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span>&#160;)</td>
docs update
2024-06-07 11:28:06 +08:00
</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 Copy Permalink