mlx/docs/build/html/struct_m_l_x_conv_params.html
2025-06-04 01:01:50 +00:00

367 lines
18 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: MLXConvParams&lt; NDIM &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">MLX
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_m_l_x_conv_params-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">MLXConvParams&lt; NDIM &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="conv_2params_8h_source.html">params.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae6b7054dc3cffa8e6aedeb29fa7da932" id="r_ae6b7054dc3cffa8e6aedeb29fa7da932"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6b7054dc3cffa8e6aedeb29fa7da932">N</a></td></tr>
<tr class="separator:ae6b7054dc3cffa8e6aedeb29fa7da932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0953063962ac3b5a027243289e72fbb2" id="r_a0953063962ac3b5a027243289e72fbb2"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0953063962ac3b5a027243289e72fbb2">C</a></td></tr>
<tr class="separator:a0953063962ac3b5a027243289e72fbb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad55ff586d30072d8154865f9dfe92d97" id="r_ad55ff586d30072d8154865f9dfe92d97"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad55ff586d30072d8154865f9dfe92d97">O</a></td></tr>
<tr class="separator:ad55ff586d30072d8154865f9dfe92d97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72e1c3b4da0f70622cf18036bbf97fe6" id="r_a72e1c3b4da0f70622cf18036bbf97fe6"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a72e1c3b4da0f70622cf18036bbf97fe6">iS</a> [NDIM]</td></tr>
<tr class="separator:a72e1c3b4da0f70622cf18036bbf97fe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba2074189644b1b59567d018409277a9" id="r_aba2074189644b1b59567d018409277a9"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba2074189644b1b59567d018409277a9">wS</a> [NDIM]</td></tr>
<tr class="separator:aba2074189644b1b59567d018409277a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19ccb9fecfccdc18b6a7f0cc43adbc6e" id="r_a19ccb9fecfccdc18b6a7f0cc43adbc6e"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19ccb9fecfccdc18b6a7f0cc43adbc6e">oS</a> [NDIM]</td></tr>
<tr class="separator:a19ccb9fecfccdc18b6a7f0cc43adbc6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a862191e8ab1bc8a47aa1396b36d46058" id="r_a862191e8ab1bc8a47aa1396b36d46058"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a862191e8ab1bc8a47aa1396b36d46058">str</a> [NDIM]</td></tr>
<tr class="separator:a862191e8ab1bc8a47aa1396b36d46058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae84a9afb3a95b57e0b763bb0ebda0753" id="r_ae84a9afb3a95b57e0b763bb0ebda0753"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae84a9afb3a95b57e0b763bb0ebda0753">pad</a> [NDIM]</td></tr>
<tr class="separator:ae84a9afb3a95b57e0b763bb0ebda0753"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7611db8f1621c7e09fc685ed44073b14" id="r_a7611db8f1621c7e09fc685ed44073b14"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7611db8f1621c7e09fc685ed44073b14">kdil</a> [NDIM]</td></tr>
<tr class="separator:a7611db8f1621c7e09fc685ed44073b14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af900fdb4c4d4ea35eed02940dee8d4d1" id="r_af900fdb4c4d4ea35eed02940dee8d4d1"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af900fdb4c4d4ea35eed02940dee8d4d1">idil</a> [NDIM]</td></tr>
<tr class="separator:af900fdb4c4d4ea35eed02940dee8d4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab25eade6573784985dbea1216f9068cf" id="r_ab25eade6573784985dbea1216f9068cf"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab25eade6573784985dbea1216f9068cf">in_strides</a> [NDIM+2]</td></tr>
<tr class="separator:ab25eade6573784985dbea1216f9068cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a887fee0da1494d038526fb0f59faff45" id="r_a887fee0da1494d038526fb0f59faff45"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a887fee0da1494d038526fb0f59faff45">wt_strides</a> [NDIM+2]</td></tr>
<tr class="separator:a887fee0da1494d038526fb0f59faff45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c8b2cfc26859a2af9d39a2cfcc3aea6" id="r_a0c8b2cfc26859a2af9d39a2cfcc3aea6"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c8b2cfc26859a2af9d39a2cfcc3aea6">out_strides</a> [NDIM+2]</td></tr>
<tr class="separator:a0c8b2cfc26859a2af9d39a2cfcc3aea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7a5590ac0974c7841c7f8b9fda0cbed" id="r_af7a5590ac0974c7841c7f8b9fda0cbed"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af7a5590ac0974c7841c7f8b9fda0cbed">groups</a></td></tr>
<tr class="separator:af7a5590ac0974c7841c7f8b9fda0cbed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b30cda15eda20f84f12db868f21d0ef" id="r_a8b30cda15eda20f84f12db868f21d0ef"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b30cda15eda20f84f12db868f21d0ef">flip</a></td></tr>
<tr class="separator:a8b30cda15eda20f84f12db868f21d0ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0953063962ac3b5a027243289e72fbb2" name="a0953063962ac3b5a027243289e72fbb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0953063962ac3b5a027243289e72fbb2">&#9670;&#160;</a></span>C</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::C</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8b30cda15eda20f84f12db868f21d0ef" name="a8b30cda15eda20f84f12db868f21d0ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b30cda15eda20f84f12db868f21d0ef">&#9670;&#160;</a></span>flip</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::flip</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af7a5590ac0974c7841c7f8b9fda0cbed" name="af7a5590ac0974c7841c7f8b9fda0cbed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7a5590ac0974c7841c7f8b9fda0cbed">&#9670;&#160;</a></span>groups</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::groups</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af900fdb4c4d4ea35eed02940dee8d4d1" name="af900fdb4c4d4ea35eed02940dee8d4d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af900fdb4c4d4ea35eed02940dee8d4d1">&#9670;&#160;</a></span>idil</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::idil[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab25eade6573784985dbea1216f9068cf" name="ab25eade6573784985dbea1216f9068cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab25eade6573784985dbea1216f9068cf">&#9670;&#160;</a></span>in_strides</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const size_t <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::in_strides[NDIM+2]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a72e1c3b4da0f70622cf18036bbf97fe6" name="a72e1c3b4da0f70622cf18036bbf97fe6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72e1c3b4da0f70622cf18036bbf97fe6">&#9670;&#160;</a></span>iS</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::iS[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7611db8f1621c7e09fc685ed44073b14" name="a7611db8f1621c7e09fc685ed44073b14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7611db8f1621c7e09fc685ed44073b14">&#9670;&#160;</a></span>kdil</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::kdil[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae6b7054dc3cffa8e6aedeb29fa7da932" name="ae6b7054dc3cffa8e6aedeb29fa7da932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6b7054dc3cffa8e6aedeb29fa7da932">&#9670;&#160;</a></span>N</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::N</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad55ff586d30072d8154865f9dfe92d97" name="ad55ff586d30072d8154865f9dfe92d97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad55ff586d30072d8154865f9dfe92d97">&#9670;&#160;</a></span>O</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::O</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a19ccb9fecfccdc18b6a7f0cc43adbc6e" name="a19ccb9fecfccdc18b6a7f0cc43adbc6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19ccb9fecfccdc18b6a7f0cc43adbc6e">&#9670;&#160;</a></span>oS</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::oS[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0c8b2cfc26859a2af9d39a2cfcc3aea6" name="a0c8b2cfc26859a2af9d39a2cfcc3aea6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c8b2cfc26859a2af9d39a2cfcc3aea6">&#9670;&#160;</a></span>out_strides</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const size_t <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::out_strides[NDIM+2]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae84a9afb3a95b57e0b763bb0ebda0753" name="ae84a9afb3a95b57e0b763bb0ebda0753"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae84a9afb3a95b57e0b763bb0ebda0753">&#9670;&#160;</a></span>pad</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::pad[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a862191e8ab1bc8a47aa1396b36d46058" name="a862191e8ab1bc8a47aa1396b36d46058"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a862191e8ab1bc8a47aa1396b36d46058">&#9670;&#160;</a></span>str</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::str[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aba2074189644b1b59567d018409277a9" name="aba2074189644b1b59567d018409277a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2074189644b1b59567d018409277a9">&#9670;&#160;</a></span>wS</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::wS[NDIM]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a887fee0da1494d038526fb0f59faff45" name="a887fee0da1494d038526fb0f59faff45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a887fee0da1494d038526fb0f59faff45">&#9670;&#160;</a></span>wt_strides</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int NDIM&gt; </div>
<table class="memname">
<tr>
<td class="memname">const size_t <a class="el" href="struct_m_l_x_conv_params.html">MLXConvParams</a>&lt; NDIM &gt;::wt_strides[NDIM+2]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>mlx/backend/metal/kernels/steel/conv/<a class="el" href="conv_2params_8h_source.html">params.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>