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
9b53df2ca9
mlx/docs/build/html/indexing_8h_source.html

156 lines
16 KiB
HTML
Raw Normal View History

docs update
2024-05-10 23:49:36 +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"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: mlx/backend/metal/kernels/indexing.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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 class="header">
<div class="headertitle"><div class="title">indexing.h</div></div>
</div><!--header-->
<div class="contents">
<a href="indexing_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright © 2023-2024 Apple Inc.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;metal_stdlib&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacemetal.html">metal</a>;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// Indexing utils</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> IdxT, <span class="keywordtype">int</span> NIDX&gt;</div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="struct_indices.html"> 12</a></span><span class="keyword">struct </span><a class="code hl_struct" href="struct_indices.html">Indices</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="struct_indices.html#ad705070a740579c07d109ae4f3d86e76"> 13</a></span> <span class="keyword">const</span> array&lt;const device IdxT*, NIDX&gt; <a class="code hl_variable" href="struct_indices.html#ad705070a740579c07d109ae4f3d86e76">buffers</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="struct_indices.html#a5ab170f1a77636180889ddfffd4f7d2f"> 14</a></span> <span class="keyword">const</span> constant <span class="keywordtype">int</span>* <a class="code hl_variable" href="struct_indices.html#a5ab170f1a77636180889ddfffd4f7d2f">shapes</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="struct_indices.html#a7f73d7652f0f751e6a06c2663e329a4a"> 15</a></span> <span class="keyword">const</span> constant <span class="keywordtype">size_t</span>* <a class="code hl_variable" href="struct_indices.html#a7f73d7652f0f751e6a06c2663e329a4a">strides</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="struct_indices.html#a7dec359e91d0eb2b64e5461b54308313"> 16</a></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="struct_indices.html#a7dec359e91d0eb2b64e5461b54308313">ndim</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>};</div>
</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> IdxT&gt;</div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="}">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="indexing_8h.html#ab41167dc537c06fbdb4df100972393df"> 20</a></span>METAL_FUNC <span class="keywordtype">size_t</span> <a class="code hl_function" href="indexing_8h.html#ab41167dc537c06fbdb4df100972393df">offset_neg_idx</a>(IdxT idx, <span class="keywordtype">size_t</span> size) {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordflow">if</span> (is_unsigned_v&lt;IdxT&gt;) {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">return</span> idx;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> (idx &lt; 0) ? idx + size : idx;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>}</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="indexing_8h.html#a5d4cfefe7180cf840b79bf0a8ec061a8"> 28</a></span><span class="preprocessor">#define IDX_ARG_N(idx_t, n) const device idx_t *idx##n [[buffer(n)]],</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="indexing_8h.html#af8bb6670caeaf3af80ba3257bafa2c50"> 30</a></span><span class="preprocessor">#define IDX_ARG_0(idx_t)</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="indexing_8h.html#a082401184dc3527c9f6f624213ad8f77"> 31</a></span><span class="preprocessor">#define IDX_ARG_1(idx_t) IDX_ARG_0(idx_t) IDX_ARG_N(idx_t, 21)</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="indexing_8h.html#a9685e668db4d60d2bc12576a78904061"> 32</a></span><span class="preprocessor">#define IDX_ARG_2(idx_t) IDX_ARG_1(idx_t) IDX_ARG_N(idx_t, 22)</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="indexing_8h.html#a8aa63aa523ab92dce40ceb8f21f9dc19"> 33</a></span><span class="preprocessor">#define IDX_ARG_3(idx_t) IDX_ARG_2(idx_t) IDX_ARG_N(idx_t, 23)</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="indexing_8h.html#aa38efa38463c3a58d1979ca5f5f3204f"> 34</a></span><span class="preprocessor">#define IDX_ARG_4(idx_t) IDX_ARG_3(idx_t) IDX_ARG_N(idx_t, 24)</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="indexing_8h.html#ace172c62b947a8521f2476897127419d"> 35</a></span><span class="preprocessor">#define IDX_ARG_5(idx_t) IDX_ARG_4(idx_t) IDX_ARG_N(idx_t, 25)</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="indexing_8h.html#aae81b1053b1bd2ff642275277012b667"> 36</a></span><span class="preprocessor">#define IDX_ARG_6(idx_t) IDX_ARG_5(idx_t) IDX_ARG_N(idx_t, 26)</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="indexing_8h.html#af3c6551c0072658c9703aa6d4c43dce9"> 37</a></span><span class="preprocessor">#define IDX_ARG_7(idx_t) IDX_ARG_6(idx_t) IDX_ARG_N(idx_t, 27)</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="indexing_8h.html#a9090171aa7aa84b8353a53ac378bf152"> 38</a></span><span class="preprocessor">#define IDX_ARG_8(idx_t) IDX_ARG_7(idx_t) IDX_ARG_N(idx_t, 28)</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="indexing_8h.html#ac944f9ec7acf249d1e0de9fb0076a9c0"> 39</a></span><span class="preprocessor">#define IDX_ARG_9(idx_t) IDX_ARG_8(idx_t) IDX_ARG_N(idx_t, 29)</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="indexing_8h.html#a7f961a2a10103c74ecc328f57f83ad8d"> 40</a></span><span class="preprocessor">#define IDX_ARG_10(idx_t) IDX_ARG_9(idx_t) IDX_ARG_N(idx_t, 30)</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="indexing_8h.html#a990fd6ebee1aac2c54c73a99b611d57e"> 42</a></span><span class="preprocessor">#define IDX_ARR_N(n) idx##n,</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="indexing_8h.html#a0612aa97c62b199874a8d28e502c86ad"> 44</a></span><span class="preprocessor">#define IDX_ARR_0()</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="indexing_8h.html#aea19bed78cf40050326d877ad86d5686"> 45</a></span><span class="preprocessor">#define IDX_ARR_1() IDX_ARR_0() IDX_ARR_N(21)</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="indexing_8h.html#a162281bcb632fce3aea20ad1954531ec"> 46</a></span><span class="preprocessor">#define IDX_ARR_2() IDX_ARR_1() IDX_ARR_N(22)</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="indexing_8h.html#a8d94c0c239732a9e5426b77c3b13c90f"> 47</a></span><span class="preprocessor">#define IDX_ARR_3() IDX_ARR_2() IDX_ARR_N(23)</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="indexing_8h.html#af4aaf68f2042df454122f9d43ffcca0d"> 48</a></span><span class="preprocessor">#define IDX_ARR_4() IDX_ARR_3() IDX_ARR_N(24)</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="indexing_8h.html#a6bf02128d04afdb329c4252d7073d901"> 49</a></span><span class="preprocessor">#define IDX_ARR_5() IDX_ARR_4() IDX_ARR_N(25)</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="indexing_8h.html#a4ac8aae861c171e6fb38bd526fc14b17"> 50</a></span><span class="preprocessor">#define IDX_ARR_6() IDX_ARR_5() IDX_ARR_N(26)</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="indexing_8h.html#ab51629b8f5f95f4081eda4dc7efe5077"> 51</a></span><span class="preprocessor">#define IDX_ARR_7() IDX_ARR_6() IDX_ARR_N(27)</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="indexing_8h.html#a67b454cecf9a33f4e9417a657da0b445"> 52</a></span><span class="preprocessor">#define IDX_ARR_8() IDX_ARR_7() IDX_ARR_N(28)</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="indexing_8h.html#a31220713207894f0b5ce4cd0c4c7b67e"> 53</a></span><span class="preprocessor">#define IDX_ARR_9() IDX_ARR_8() IDX_ARR_N(29)</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="indexing_8h.html#a613f3089e43e929a92d634c823260f04"> 54</a></span><span class="preprocessor">#define IDX_ARR_10() IDX_ARR_9() IDX_ARR_N(30)</span></div>
<div class="ttc" id="aindexing_8h_html_ab41167dc537c06fbdb4df100972393df"><div class="ttname"><a href="indexing_8h.html#ab41167dc537c06fbdb4df100972393df">offset_neg_idx</a></div><div class="ttdeci">METAL_FUNC size_t offset_neg_idx(IdxT idx, size_t size)</div><div class="ttdef"><b>Definition</b> indexing.h:20</div></div>
<div class="ttc" id="anamespacemetal_html"><div class="ttname"><a href="namespacemetal.html">metal</a></div><div class="ttdef"><b>Definition</b> bf16.h:265</div></div>
<div class="ttc" id="astruct_indices_html"><div class="ttname"><a href="struct_indices.html">Indices</a></div><div class="ttdef"><b>Definition</b> indexing.h:12</div></div>
<div class="ttc" id="astruct_indices_html_a5ab170f1a77636180889ddfffd4f7d2f"><div class="ttname"><a href="struct_indices.html#a5ab170f1a77636180889ddfffd4f7d2f">Indices::shapes</a></div><div class="ttdeci">const constant int * shapes</div><div class="ttdef"><b>Definition</b> indexing.h:14</div></div>
<div class="ttc" id="astruct_indices_html_a7dec359e91d0eb2b64e5461b54308313"><div class="ttname"><a href="struct_indices.html#a7dec359e91d0eb2b64e5461b54308313">Indices::ndim</a></div><div class="ttdeci">const int ndim</div><div class="ttdef"><b>Definition</b> indexing.h:16</div></div>
<div class="ttc" id="astruct_indices_html_a7f73d7652f0f751e6a06c2663e329a4a"><div class="ttname"><a href="struct_indices.html#a7f73d7652f0f751e6a06c2663e329a4a">Indices::strides</a></div><div class="ttdeci">const constant size_t * strides</div><div class="ttdef"><b>Definition</b> indexing.h:15</div></div>
<div class="ttc" id="astruct_indices_html_ad705070a740579c07d109ae4f3d86e76"><div class="ttname"><a href="struct_indices.html#ad705070a740579c07d109ae4f3d86e76">Indices::buffers</a></div><div class="ttdeci">const array&lt; const device IdxT *, NIDX &gt; buffers</div><div class="ttdef"><b>Definition</b> indexing.h:13</div></div>
</div><!-- fragment --></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>
Reference in New Issue Copy Permalink