This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions

View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: ReadWriter&lt; in_T, out_T, step, four_step_real &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -28,12 +35,24 @@
<div id="projectname">MLX
</div>
</td>
<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>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,22 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
</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>
<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); });
$(function(){initNavTree('struct_read_writer.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -81,8 +101,6 @@ $(function(){ initResizable(false); });
</div>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
@@ -191,7 +209,7 @@ Public Attributes</h2></td></tr>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -244,7 +262,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -258,7 +276,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -276,7 +294,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -289,7 +307,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -303,7 +321,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -350,7 +368,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -368,7 +386,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -423,7 +441,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -441,7 +459,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -538,7 +556,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -552,7 +570,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -599,7 +617,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -613,7 +631,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -626,7 +644,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -640,7 +658,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -653,7 +671,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -667,7 +685,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -680,7 +698,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -698,7 +716,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -711,7 +729,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -725,7 +743,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -772,7 +790,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -790,7 +808,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -845,7 +863,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
@@ -863,7 +881,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -940,7 +958,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::batch_size</td>
@@ -956,7 +974,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">threadgroup float2* <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::buf</td>
@@ -972,7 +990,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">uint3 <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::elem</td>
@@ -988,7 +1006,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::elems_per_thread</td>
@@ -1004,7 +1022,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">uint3 <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::grid</td>
@@ -1020,7 +1038,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">const device in_T* <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::in</td>
@@ -1036,7 +1054,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::inv</td>
@@ -1052,7 +1070,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::n</td>
@@ -1068,7 +1086,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">device out_T* <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::out</td>
@@ -1084,7 +1102,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::strided_device_idx = 0</td>
@@ -1100,7 +1118,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::strided_shared_idx = 0</td>
@@ -1116,7 +1134,7 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real = false&gt; </div>
template&lt;typename in_T, typename out_T, int step = 0, bool four_step_real = false&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_read_writer.html">ReadWriter</a>&lt; in_T, out_T, step, four_step_real &gt;::threads_per_tg</td>
@@ -1130,10 +1148,13 @@ template&lt;typename in_T , typename out_T , int step = 0, bool four_step_real =
<li>mlx/backend/metal/kernels/fft/<a class="el" href="readwrite_8h_source.html">readwrite.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.12.0
</small></address>
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_read_writer.html">ReadWriter</a></li>
<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.1 </li>
</ul>
</div>
</body>
</html>