mlx/docs/build/html/struct_g_e_m_v_kernel.html

588 lines
32 KiB
HTML
Raw Normal View History

2024-10-15 23:12:17 +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"/>
2025-02-07 04:16:29 +08:00
<meta name="generator" content="Doxygen 1.13.2"/>
2024-10-15 23:12:17 +08:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2025-03-21 06:37:22 +08:00
<title>MLX: GEMVKernel&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt; Struct Template Reference</title>
2024-10-15 23:12:17 +08:00
<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"/>
2025-01-10 05:56:20 +08:00
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
2024-10-15 23:12:17 +08:00
<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>
2025-01-10 05:56:20 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
2024-10-15 23:12:17 +08:00
<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>
2025-01-10 05:56:20 +08:00
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
2024-10-15 23:12:17 +08:00
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
<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>
2025-01-10 05:56:20 +08:00
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
2024-10-15 23:12:17 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('struct_g_e_m_v_kernel.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
</script>
2025-01-10 05:56:20 +08:00
<div id="doc-content">
2024-10-15 23:12:17 +08:00
<!-- 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 class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="struct_g_e_m_v_kernel-members.html">List of all members</a> </div>
2025-03-21 06:37:22 +08:00
<div class="headertitle"><div class="title">GEMVKernel&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt; Struct Template Reference</div></div>
2024-10-15 23:12:17 +08:00
</div><!--header-->
<div class="contents">
2025-02-07 04:16:29 +08:00
<p><code>#include &lt;<a class="el" href="gemv__masked_8h_source.html">gemv_masked.h</a>&gt;</code></p>
2024-10-15 23:12:17 +08:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
2025-03-21 06:37:22 +08:00
<tr class="memitem:af96a768a213a95e7a4d8f3ec1948034f" id="r_af96a768a213a95e7a4d8f3ec1948034f"><td class="memTemplParams" colspan="2">template&lt;typename U = T&gt; </td></tr>
<tr class="memitem:af96a768a213a95e7a4d8f3ec1948034f"><td class="memTemplItemLeft" align="right" valign="top">static METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af96a768a213a95e7a4d8f3ec1948034f">load_unsafe</a> (const device T *src, thread U dst[TN], const int src_offset=0)</td></tr>
<tr class="separator:af96a768a213a95e7a4d8f3ec1948034f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a047eca250e7cbc928bce0e13de98e558" id="r_a047eca250e7cbc928bce0e13de98e558"><td class="memTemplParams" colspan="2">template&lt;typename U = T&gt; </td></tr>
<tr class="memitem:a047eca250e7cbc928bce0e13de98e558"><td class="memTemplItemLeft" align="right" valign="top">static METAL_FUNC void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a047eca250e7cbc928bce0e13de98e558">load_safe</a> (const device T *src, thread U dst[TN], const int src_offset=0, const int src_size=TN)</td></tr>
<tr class="separator:a047eca250e7cbc928bce0e13de98e558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1a9e1d9853489dd928916912cc627a7" id="r_ac1a9e1d9853489dd928916912cc627a7"><td class="memItemLeft" align="right" valign="top">static METAL_FUNC void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1a9e1d9853489dd928916912cc627a7">run</a> (const device T *mat, const device T *in_vec, device T *out_vec, const constant int &amp;in_vec_size, const constant int &amp;out_vec_size, const constant int &amp;matrix_ld, const device out_mask_t *out_mask, const device op_mask_t *mat_mask, const device op_mask_t *vec_mask, const constant int *mask_strides, threadgroup AccT *tgp_memory, uint3 tid, uint3 lid, uint simd_gid, uint simd_lid)</td></tr>
<tr class="separator:ac1a9e1d9853489dd928916912cc627a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
2024-10-15 23:12:17 +08:00
</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>
2025-03-21 06:37:22 +08:00
<tr class="memitem:afbe7ab8ebfa912ffbf3ba2cf4db24940" id="r_afbe7ab8ebfa912ffbf3ba2cf4db24940"><td class="memItemLeft" align="right" valign="top">static constant constexpr const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afbe7ab8ebfa912ffbf3ba2cf4db24940">threadsM</a> = BM * SM</td></tr>
<tr class="separator:afbe7ab8ebfa912ffbf3ba2cf4db24940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23142b7400f1f678e5d6d69d87f51032" id="r_a23142b7400f1f678e5d6d69d87f51032"><td class="memItemLeft" align="right" valign="top">static constant constexpr const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23142b7400f1f678e5d6d69d87f51032">threadsN</a> = BN * SN</td></tr>
<tr class="separator:a23142b7400f1f678e5d6d69d87f51032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a188ef7ed5c1d74d9b540b6d4ebf12f2e" id="r_a188ef7ed5c1d74d9b540b6d4ebf12f2e"><td class="memItemLeft" align="right" valign="top">static constant constexpr const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a188ef7ed5c1d74d9b540b6d4ebf12f2e">blockM</a> = <a class="el" href="#afbe7ab8ebfa912ffbf3ba2cf4db24940">threadsM</a> * TM</td></tr>
<tr class="separator:a188ef7ed5c1d74d9b540b6d4ebf12f2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af22b6e5ed1a9d350866aaafa35d63a8a" id="r_af22b6e5ed1a9d350866aaafa35d63a8a"><td class="memItemLeft" align="right" valign="top">static constant constexpr const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af22b6e5ed1a9d350866aaafa35d63a8a">blockN</a> = <a class="el" href="#a23142b7400f1f678e5d6d69d87f51032">threadsN</a> * TN</td></tr>
<tr class="separator:af22b6e5ed1a9d350866aaafa35d63a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68bad880d1e689228ae4d3c6958cc6c1" id="r_a68bad880d1e689228ae4d3c6958cc6c1"><td class="memItemLeft" align="right" valign="top">static constant constexpr const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a68bad880d1e689228ae4d3c6958cc6c1">has_operand_mask</a> = !metal::is_same_v&lt;op_mask_t, <a class="el" href="gemv__masked_8h.html#a1480c8cdff1cae1462a5a71632969bca">nomask_t</a>&gt;</td></tr>
<tr class="separator:a68bad880d1e689228ae4d3c6958cc6c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b0b9ccf11bd5d7de50b9626fa9a22cc" id="r_a3b0b9ccf11bd5d7de50b9626fa9a22cc"><td class="memItemLeft" align="right" valign="top">static constant constexpr const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b0b9ccf11bd5d7de50b9626fa9a22cc">has_output_mask</a> = !metal::is_same_v&lt;out_mask_t, <a class="el" href="gemv__masked_8h.html#a1480c8cdff1cae1462a5a71632969bca">nomask_t</a>&gt;</td></tr>
<tr class="separator:a3b0b9ccf11bd5d7de50b9626fa9a22cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f0e646822d45dc2543e31509552258" id="r_a09f0e646822d45dc2543e31509552258"><td class="memItemLeft" align="right" valign="top">static constant constexpr const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a09f0e646822d45dc2543e31509552258">has_mul_operand_mask</a></td></tr>
<tr class="separator:a09f0e646822d45dc2543e31509552258"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad54fb5c6f0f9a820365b638542693291" id="r_ad54fb5c6f0f9a820365b638542693291"><td class="memItemLeft" align="right" valign="top">static constant constexpr const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad54fb5c6f0f9a820365b638542693291">has_mul_output_mask</a></td></tr>
<tr class="separator:ad54fb5c6f0f9a820365b638542693291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53514fa199efc5b7328052dac45aabab" id="r_a53514fa199efc5b7328052dac45aabab"><td class="memItemLeft" align="right" valign="top">static constant constexpr const short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53514fa199efc5b7328052dac45aabab">tgp_mem_size</a> = BN &gt; 1 ? BN*(<a class="el" href="#a188ef7ed5c1d74d9b540b6d4ebf12f2e">blockM</a> + TM) : 0</td></tr>
<tr class="separator:a53514fa199efc5b7328052dac45aabab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c8e57e6718f22732570cc92d9bcf99" id="r_ae1c8e57e6718f22732570cc92d9bcf99"><td class="memItemLeft" align="right" valign="top">static constant constexpr const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1c8e57e6718f22732570cc92d9bcf99">needs_tgp_reduction</a> = BN &gt; 1</td></tr>
<tr class="separator:ae1c8e57e6718f22732570cc92d9bcf99"><td class="memSeparator" colspan="2">&#160;</td></tr>
2024-10-15 23:12:17 +08:00
</table>
<h2 class="groupheader">Member Function Documentation</h2>
2025-03-21 06:37:22 +08:00
<a id="a047eca250e7cbc928bce0e13de98e558" name="a047eca250e7cbc928bce0e13de98e558"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a047eca250e7cbc928bce0e13de98e558">&#9670;&#160;</a></span>load_safe()</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
<div class="memtemplate">
template&lt;typename U = T&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">static METAL_FUNC void <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::load_safe </td>
2024-10-15 23:12:17 +08:00
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2025-03-21 06:37:22 +08:00
<td class="paramtype">thread U</td> <td class="paramname"><span class="paramname"><em>dst</em></span>[TN], </td>
2024-10-15 23:12:17 +08:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>src_offset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>src_size</em></span><span class="paramdefsep"> = </span><span class="paramdefval">TN</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="af96a768a213a95e7a4d8f3ec1948034f" name="af96a768a213a95e7a4d8f3ec1948034f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af96a768a213a95e7a4d8f3ec1948034f">&#9670;&#160;</a></span>load_unsafe()</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
<div class="memtemplate">
template&lt;typename U = T&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">static METAL_FUNC void <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::load_unsafe </td>
2024-10-15 23:12:17 +08:00
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2025-03-21 06:37:22 +08:00
<td class="paramtype">thread U</td> <td class="paramname"><span class="paramname"><em>dst</em></span>[TN], </td>
2024-10-15 23:12:17 +08:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>src_offset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="ac1a9e1d9853489dd928916912cc627a7" name="ac1a9e1d9853489dd928916912cc627a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1a9e1d9853489dd928916912cc627a7">&#9670;&#160;</a></span>run()</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">static METAL_FUNC void <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::run </td>
2024-10-15 23:12:17 +08:00
<td>(</td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>mat</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device T *</td> <td class="paramname"><span class="paramname"><em>in_vec</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">device T *</td> <td class="paramname"><span class="paramname"><em>out_vec</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int &amp;</td> <td class="paramname"><span class="paramname"><em>in_vec_size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int &amp;</td> <td class="paramname"><span class="paramname"><em>out_vec_size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int &amp;</td> <td class="paramname"><span class="paramname"><em>matrix_ld</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device out_mask_t *</td> <td class="paramname"><span class="paramname"><em>out_mask</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device op_mask_t *</td> <td class="paramname"><span class="paramname"><em>mat_mask</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const device op_mask_t *</td> <td class="paramname"><span class="paramname"><em>vec_mask</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant int *</td> <td class="paramname"><span class="paramname"><em>mask_strides</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2025-03-21 06:37:22 +08:00
<td class="paramtype">threadgroup AccT *</td> <td class="paramname"><span class="paramname"><em>tgp_memory</em></span>, </td>
2024-10-15 23:12:17 +08:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>tid</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint3</td> <td class="paramname"><span class="paramname"><em>lid</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_gid</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint</td> <td class="paramname"><span class="paramname"><em>simd_lid</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
2025-03-21 06:37:22 +08:00
<a id="a188ef7ed5c1d74d9b540b6d4ebf12f2e" name="a188ef7ed5c1d74d9b540b6d4ebf12f2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a188ef7ed5c1d74d9b540b6d4ebf12f2e">&#9670;&#160;</a></span>blockM</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const int <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::blockM = <a class="el" href="#afbe7ab8ebfa912ffbf3ba2cf4db24940">threadsM</a> * TM</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="af22b6e5ed1a9d350866aaafa35d63a8a" name="af22b6e5ed1a9d350866aaafa35d63a8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af22b6e5ed1a9d350866aaafa35d63a8a">&#9670;&#160;</a></span>blockN</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const int <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::blockN = <a class="el" href="#a23142b7400f1f678e5d6d69d87f51032">threadsN</a> * TN</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="a09f0e646822d45dc2543e31509552258" name="a09f0e646822d45dc2543e31509552258"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09f0e646822d45dc2543e31509552258">&#9670;&#160;</a></span>has_mul_operand_mask</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const bool <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::has_mul_operand_mask</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
2025-03-21 06:37:22 +08:00
<div class="line"> <a class="code hl_variable" href="#a68bad880d1e689228ae4d3c6958cc6c1">has_operand_mask</a> &amp;&amp; !metal::is_same_v&lt;op_mask_t, bool&gt;</div>
<div class="ttc" id="astruct_g_e_m_v_kernel_html_a68bad880d1e689228ae4d3c6958cc6c1"><div class="ttname"><a href="#a68bad880d1e689228ae4d3c6958cc6c1">GEMVKernel::has_operand_mask</a></div><div class="ttdeci">static constant constexpr const bool has_operand_mask</div><div class="ttdef"><b>Definition</b> gemv_masked.h:64</div></div>
2024-10-15 23:12:17 +08:00
</div><!-- fragment -->
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="ad54fb5c6f0f9a820365b638542693291" name="ad54fb5c6f0f9a820365b638542693291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad54fb5c6f0f9a820365b638542693291">&#9670;&#160;</a></span>has_mul_output_mask</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const bool <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::has_mul_output_mask</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
2025-03-21 06:37:22 +08:00
<div class="line"> <a class="code hl_variable" href="#a3b0b9ccf11bd5d7de50b9626fa9a22cc">has_output_mask</a> &amp;&amp; !metal::is_same_v&lt;out_mask_t, bool&gt;</div>
<div class="ttc" id="astruct_g_e_m_v_kernel_html_a3b0b9ccf11bd5d7de50b9626fa9a22cc"><div class="ttname"><a href="#a3b0b9ccf11bd5d7de50b9626fa9a22cc">GEMVKernel::has_output_mask</a></div><div class="ttdeci">static constant constexpr const bool has_output_mask</div><div class="ttdef"><b>Definition</b> gemv_masked.h:65</div></div>
2024-10-15 23:12:17 +08:00
</div><!-- fragment -->
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="a68bad880d1e689228ae4d3c6958cc6c1" name="a68bad880d1e689228ae4d3c6958cc6c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68bad880d1e689228ae4d3c6958cc6c1">&#9670;&#160;</a></span>has_operand_mask</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const bool <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::has_operand_mask = !metal::is_same_v&lt;op_mask_t, <a class="el" href="gemv__masked_8h.html#a1480c8cdff1cae1462a5a71632969bca">nomask_t</a>&gt;</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="a3b0b9ccf11bd5d7de50b9626fa9a22cc" name="a3b0b9ccf11bd5d7de50b9626fa9a22cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b0b9ccf11bd5d7de50b9626fa9a22cc">&#9670;&#160;</a></span>has_output_mask</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const bool <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::has_output_mask = !metal::is_same_v&lt;out_mask_t, <a class="el" href="gemv__masked_8h.html#a1480c8cdff1cae1462a5a71632969bca">nomask_t</a>&gt;</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="ae1c8e57e6718f22732570cc92d9bcf99" name="ae1c8e57e6718f22732570cc92d9bcf99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1c8e57e6718f22732570cc92d9bcf99">&#9670;&#160;</a></span>needs_tgp_reduction</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const bool <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::needs_tgp_reduction = BN &gt; 1</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="a53514fa199efc5b7328052dac45aabab" name="a53514fa199efc5b7328052dac45aabab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53514fa199efc5b7328052dac45aabab">&#9670;&#160;</a></span>tgp_mem_size</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const short <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::tgp_mem_size = BN &gt; 1 ? BN*(<a class="el" href="#a188ef7ed5c1d74d9b540b6d4ebf12f2e">blockM</a> + TM) : 0</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="afbe7ab8ebfa912ffbf3ba2cf4db24940" name="afbe7ab8ebfa912ffbf3ba2cf4db24940"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbe7ab8ebfa912ffbf3ba2cf4db24940">&#9670;&#160;</a></span>threadsM</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const int <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::threadsM = BM * SM</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
2025-03-21 06:37:22 +08:00
<a id="a23142b7400f1f678e5d6d69d87f51032" name="a23142b7400f1f678e5d6d69d87f51032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23142b7400f1f678e5d6d69d87f51032">&#9670;&#160;</a></span>threadsN</h2>
2024-10-15 23:12:17 +08:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
2025-03-21 06:37:22 +08:00
template&lt;typename T, typename out_mask_t, typename op_mask_t, const int BM, const int BN, const int SM, const int SN, const int TM, const int TN, typename AccT = float&gt; </div>
2024-10-15 23:12:17 +08:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2025-03-21 06:37:22 +08:00
<td class="memname">constant constexpr const int <a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a>&lt; T, out_mask_t, op_mask_t, BM, BN, SM, SN, TM, TN, AccT &gt;::threadsN = BN * SN</td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</td>
<td class="mlabels-right">
2025-01-10 05:56:20 +08:00
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
2024-10-15 23:12:17 +08:00
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
2025-02-07 04:16:29 +08:00
<li>mlx/backend/metal/kernels/<a class="el" href="gemv__masked_8h_source.html">gemv_masked.h</a></li>
2024-10-15 23:12:17 +08:00
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
2025-01-10 05:56:20 +08:00
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_g_e_m_v_kernel.html">GEMVKernel</a></li>
2025-02-07 04:16:29 +08:00
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
2025-01-10 05:56:20 +08:00
</ul>
</div>
2024-10-15 23:12:17 +08:00
</body>
</html>