zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-06-26 10:41:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
171ca75e2a
mlx/docs/build/html/struct_looped_elem_to_loc.html
CircleCI Docs 347febaf97 rebase
2025-06-04 01:01:54 +00:00

318 lines
15 KiB
HTML
Raw Blame History

<!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: LoopedElemToLoc&lt; DIM, OffsetT, General &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>
<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><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_looped_elem_to_loc-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">LoopedElemToLoc&lt; DIM, OffsetT, General &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="backend_2metal_2kernels_2utils_8h_source.html">utils.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5653be1c990722a4a215be27efe5648b" id="r_a5653be1c990722a4a215be27efe5648b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5653be1c990722a4a215be27efe5648b">LoopedElemToLoc</a> (int <a class="el" href="#af8285112846769aba2c0d8615f6f1364">dim</a>)</td></tr>
<tr class="separator:a5653be1c990722a4a215be27efe5648b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c743940bf96350f3be42bba5d28205" id="r_a54c743940bf96350f3be42bba5d28205"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a54c743940bf96350f3be42bba5d28205">next</a> (const constant int *shape, const constant size_t *strides)</td></tr>
<tr class="separator:a54c743940bf96350f3be42bba5d28205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7da7bd04e79ba86f71c535b5a6ec1a2d" id="r_a7da7bd04e79ba86f71c535b5a6ec1a2d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7da7bd04e79ba86f71c535b5a6ec1a2d">next</a> (int n, const constant int *shape, const constant size_t *strides)</td></tr>
<tr class="separator:a7da7bd04e79ba86f71c535b5a6ec1a2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba051a428ad0934a9c6d04d4d3ee6e0e" id="r_aba051a428ad0934a9c6d04d4d3ee6e0e"><td class="memItemLeft" align="right" valign="top">OffsetT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba051a428ad0934a9c6d04d4d3ee6e0e">location</a> ()</td></tr>
<tr class="separator:aba051a428ad0934a9c6d04d4d3ee6e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af8285112846769aba2c0d8615f6f1364" id="r_af8285112846769aba2c0d8615f6f1364"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af8285112846769aba2c0d8615f6f1364">dim</a></td></tr>
<tr class="separator:af8285112846769aba2c0d8615f6f1364"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fbe77b4a774a30af5734dd9c5bd1f40" id="r_a8fbe77b4a774a30af5734dd9c5bd1f40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM - 1, OffsetT, General &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8fbe77b4a774a30af5734dd9c5bd1f40">inner_looper</a></td></tr>
<tr class="separator:a8fbe77b4a774a30af5734dd9c5bd1f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdffe540c383a67417604b6080704791" id="r_acdffe540c383a67417604b6080704791"><td class="memItemLeft" align="right" valign="top">OffsetT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acdffe540c383a67417604b6080704791">offset</a> {0}</td></tr>
<tr class="separator:acdffe540c383a67417604b6080704791"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd070b3193d9e87fb2c2db8db571333" id="r_acbd070b3193d9e87fb2c2db8db571333"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbd070b3193d9e87fb2c2db8db571333">index</a> {0}</td></tr>
<tr class="separator:acbd070b3193d9e87fb2c2db8db571333"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5653be1c990722a4a215be27efe5648b" name="a5653be1c990722a4a215be27efe5648b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5653be1c990722a4a215be27efe5648b">&#9670;&#160;</a></span>LoopedElemToLoc()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;<a class="el" href="struct_looped_elem_to_loc.html">::LoopedElemToLoc</a> </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>dim</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aba051a428ad0934a9c6d04d4d3ee6e0e" name="aba051a428ad0934a9c6d04d4d3ee6e0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba051a428ad0934a9c6d04d4d3ee6e0e">&#9670;&#160;</a></span>location()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">OffsetT <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::location </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a54c743940bf96350f3be42bba5d28205" name="a54c743940bf96350f3be42bba5d28205"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54c743940bf96350f3be42bba5d28205">&#9670;&#160;</a></span>next() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::next </td>
<td>(</td>
<td class="paramtype">const constant int *</td> <td class="paramname"><span class="paramname"><em>shape</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t *</td> <td class="paramname"><span class="paramname"><em>strides</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7da7bd04e79ba86f71c535b5a6ec1a2d" name="a7da7bd04e79ba86f71c535b5a6ec1a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7da7bd04e79ba86f71c535b5a6ec1a2d">&#9670;&#160;</a></span>next() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::next </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>n</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>shape</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const constant size_t *</td> <td class="paramname"><span class="paramname"><em>strides</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af8285112846769aba2c0d8615f6f1364" name="af8285112846769aba2c0d8615f6f1364"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8285112846769aba2c0d8615f6f1364">&#9670;&#160;</a></span>dim</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::dim</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acbd070b3193d9e87fb2c2db8db571333" name="acbd070b3193d9e87fb2c2db8db571333"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbd070b3193d9e87fb2c2db8db571333">&#9670;&#160;</a></span>index</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::index {0}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8fbe77b4a774a30af5734dd9c5bd1f40" name="a8fbe77b4a774a30af5734dd9c5bd1f40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fbe77b4a774a30af5734dd9c5bd1f40">&#9670;&#160;</a></span>inner_looper</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt;DIM - 1, OffsetT, General&gt; <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::inner_looper</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acdffe540c383a67417604b6080704791" name="acdffe540c383a67417604b6080704791"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdffe540c383a67417604b6080704791">&#9670;&#160;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int DIM, typename OffsetT = size_t, bool General = true&gt; </div>
<table class="memname">
<tr>
<td class="memname">OffsetT <a class="el" href="struct_looped_elem_to_loc.html">LoopedElemToLoc</a>&lt; DIM, OffsetT, General &gt;::offset {0}</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/<a class="el" href="backend_2metal_2kernels_2utils_8h_source.html">utils.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 -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink