mlx/docs/build/html/metal_2kernels_2ternary_8h.html
CircleCI Docs fe6b3ed02c rebase
2025-06-04 01:01:52 +00:00

447 lines
22 KiB
HTML

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/ternary.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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.12.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ternary.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="metal_2kernels_2ternary_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a83f93644d21ee774e06e8190d0725ccb" id="r_a83f93644d21ee774e06e8190d0725ccb"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op &gt; </td></tr>
<tr class="memitem:a83f93644d21ee774e06e8190d0725ccb"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a83f93644d21ee774e06e8190d0725ccb">ternary_v</a> (device const bool *a, device const T *b, device const T *c, device T *d, uint index)</td></tr>
<tr class="separator:a83f93644d21ee774e06e8190d0725ccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e610f3b01966bdbf23fdfebe5d2c508" id="r_a3e610f3b01966bdbf23fdfebe5d2c508"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op &gt; </td></tr>
<tr class="memitem:a3e610f3b01966bdbf23fdfebe5d2c508"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3e610f3b01966bdbf23fdfebe5d2c508">ternary_v2</a> (device const bool *a, device const T *b, device const T *c, device T *d, uint2 index, uint2 grid_dim)</td></tr>
<tr class="separator:a3e610f3b01966bdbf23fdfebe5d2c508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd5918559850f3f80e3adee2391fe6a" id="r_a1bd5918559850f3f80e3adee2391fe6a"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op &gt; </td></tr>
<tr class="memitem:a1bd5918559850f3f80e3adee2391fe6a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1bd5918559850f3f80e3adee2391fe6a">ternary_g_nd1</a> (device const bool *a, device const T *b, device const T *c, device T *d, constant const size_t &amp;a_strides, constant const size_t &amp;b_strides, constant const size_t &amp;c_strides, uint index)</td></tr>
<tr class="separator:a1bd5918559850f3f80e3adee2391fe6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdf0d9d0cb21fcb3f176500785076af8" id="r_afdf0d9d0cb21fcb3f176500785076af8"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op &gt; </td></tr>
<tr class="memitem:afdf0d9d0cb21fcb3f176500785076af8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#afdf0d9d0cb21fcb3f176500785076af8">ternary_g_nd2</a> (device const bool *a, device const T *b, device const T *c, device T *d, constant const size_t a_strides[2], constant const size_t b_strides[2], constant const size_t c_strides[2], uint2 index, uint2 grid_dim)</td></tr>
<tr class="separator:afdf0d9d0cb21fcb3f176500785076af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a113df0c8a841b0e986900d580644e047" id="r_a113df0c8a841b0e986900d580644e047"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op &gt; </td></tr>
<tr class="memitem:a113df0c8a841b0e986900d580644e047"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a113df0c8a841b0e986900d580644e047">ternary_g_nd3</a> (device const bool *a, device const T *b, device const T *c, device T *d, constant const size_t a_strides[3], constant const size_t b_strides[3], constant const size_t c_strides[3], uint3 index, uint3 grid_dim)</td></tr>
<tr class="separator:a113df0c8a841b0e986900d580644e047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf8b5989de971e43829875dc0097cdfb" id="r_adf8b5989de971e43829875dc0097cdfb"><td class="memTemplParams" colspan="2">template&lt;typename T , typename Op , int N = 1&gt; </td></tr>
<tr class="memitem:adf8b5989de971e43829875dc0097cdfb"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#adf8b5989de971e43829875dc0097cdfb">ternary_g</a> (device const bool *a, device const T *b, device const T *c, device T *d, constant const int *shape, constant const size_t *a_strides, constant const size_t *b_strides, constant const size_t *c_strides, constant const int &amp;ndim, uint3 index, uint3 grid_dim)</td></tr>
<tr class="separator:adf8b5989de971e43829875dc0097cdfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="adf8b5989de971e43829875dc0097cdfb" name="adf8b5989de971e43829875dc0097cdfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf8b5989de971e43829875dc0097cdfb">&#9670;&#160;</a></span>ternary_g()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op , int N = 1&gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_g </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const int *</td> <td class="paramname"><span class="paramname"><em>shape</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t *</td> <td class="paramname"><span class="paramname"><em>a_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t *</td> <td class="paramname"><span class="paramname"><em>b_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t *</td> <td class="paramname"><span class="paramname"><em>c_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const int &amp;</td> <td class="paramname"><span class="paramname"><em>ndim</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>index</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>grid_dim</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1bd5918559850f3f80e3adee2391fe6a" name="a1bd5918559850f3f80e3adee2391fe6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bd5918559850f3f80e3adee2391fe6a">&#9670;&#160;</a></span>ternary_g_nd1()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_g_nd1 </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t &amp;</td> <td class="paramname"><span class="paramname"><em>a_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t &amp;</td> <td class="paramname"><span class="paramname"><em>b_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t &amp;</td> <td class="paramname"><span class="paramname"><em>c_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>index</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afdf0d9d0cb21fcb3f176500785076af8" name="afdf0d9d0cb21fcb3f176500785076af8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdf0d9d0cb21fcb3f176500785076af8">&#9670;&#160;</a></span>ternary_g_nd2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_g_nd2 </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>a_strides</em></span>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>b_strides</em></span>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>c_strides</em></span>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>index</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>grid_dim</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a113df0c8a841b0e986900d580644e047" name="a113df0c8a841b0e986900d580644e047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a113df0c8a841b0e986900d580644e047">&#9670;&#160;</a></span>ternary_g_nd3()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_g_nd3 </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>a_strides</em></span>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>b_strides</em></span>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">constant const size_t</td> <td class="paramname"><span class="paramname"><em>c_strides</em></span>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>index</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>grid_dim</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a83f93644d21ee774e06e8190d0725ccb" name="a83f93644d21ee774e06e8190d0725ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83f93644d21ee774e06e8190d0725ccb">&#9670;&#160;</a></span>ternary_v()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_v </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>index</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3e610f3b01966bdbf23fdfebe5d2c508" name="a3e610f3b01966bdbf23fdfebe5d2c508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e610f3b01966bdbf23fdfebe5d2c508">&#9670;&#160;</a></span>ternary_v2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename Op &gt; </div>
<table class="memname">
<tr>
<td class="memname">void ternary_v2 </td>
<td>(</td>
<td class="paramtype">device const bool *</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>b</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device const T *</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>d</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>index</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint2</td> <td class="paramname"><span class="paramname"><em>grid_dim</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>