zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-11-04 18:48:15 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Files
5a14f96fb92403f986ae661514421299f09fef06
mlx/docs/build/html/kernels_2indexing_8h_source.html
CircleCI Docs 3bac79c1d6 rebase
2025-10-17 19:15:00 +00:00

153 lines
12 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.13.2"/>
<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>
<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>
<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>
<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.13.2 -->
<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>
</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(){initNavTree('kernels_2indexing_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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="headertitle"><div class="title">indexing.h</div></div>
</div><!--header-->
<div class="contents">
<a href="kernels_2indexing_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">#pragma once</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="preprocessor">#include &lt;metal_stdlib&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</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="foldopen00008" data-start="{" data-end="};">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="struct_indices.html"> 8</a></span><span class="keyword">struct </span><a class="code hl_struct" href="struct_indices.html">Indices</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="struct_indices.html#ad705070a740579c07d109ae4f3d86e76"> 9</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="l00010" name="l00010"></a><span class="lineno"><a class="line" href="struct_indices.html#a5ab170f1a77636180889ddfffd4f7d2f"> 10</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="l00011" name="l00011"></a><span class="lineno"><a class="line" href="struct_indices.html#a510b7fe052c5826911dd17d7ccb9e73f"> 11</a></span> <span class="keyword">const</span> constant int64_t* <a class="code hl_variable" href="struct_indices.html#a510b7fe052c5826911dd17d7ccb9e73f">strides</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="struct_indices.html#a255e340a39c6ac28ef2c232b106f85d1"> 12</a></span> <span class="keyword">const</span> constant <span class="keywordtype">bool</span>* <a class="code hl_variable" href="struct_indices.html#a255e340a39c6ac28ef2c232b106f85d1">row_contiguous</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="struct_indices.html#a7dec359e91d0eb2b64e5461b54308313"> 13</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="l00014" name="l00014"></a><span class="lineno"> 14</span>};</div>
</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> IdxT&gt;</div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="kernels_2indexing_8h.html#a58a65ea6215999cd4ccb4fe757cc2dc8"> 17</a></span>METAL_FUNC <span class="keywordtype">size_t</span> <a class="code hl_function" href="kernels_2indexing_8h.html#a58a65ea6215999cd4ccb4fe757cc2dc8">offset_neg_idx</a>(IdxT idx, <span class="keywordtype">int</span> size) {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordflow">if</span> (is_unsigned_v&lt;IdxT&gt;) {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">return</span> idx;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordflow">return</span> (idx &lt; 0) ? idx + size : idx;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> }</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>}</div>
</div>
<div class="ttc" id="akernels_2indexing_8h_html_a58a65ea6215999cd4ccb4fe757cc2dc8"><div class="ttname"><a href="kernels_2indexing_8h.html#a58a65ea6215999cd4ccb4fe757cc2dc8">offset_neg_idx</a></div><div class="ttdeci">METAL_FUNC size_t offset_neg_idx(IdxT idx, int size)</div><div class="ttdef"><b>Definition</b> indexing.h:17</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:8</div></div>
<div class="ttc" id="astruct_indices_html_a255e340a39c6ac28ef2c232b106f85d1"><div class="ttname"><a href="struct_indices.html#a255e340a39c6ac28ef2c232b106f85d1">Indices::row_contiguous</a></div><div class="ttdeci">const constant bool * row_contiguous</div><div class="ttdef"><b>Definition</b> indexing.h:12</div></div>
<div class="ttc" id="astruct_indices_html_a510b7fe052c5826911dd17d7ccb9e73f"><div class="ttname"><a href="struct_indices.html#a510b7fe052c5826911dd17d7ccb9e73f">Indices::strides</a></div><div class="ttdeci">const constant int64_t * strides</div><div class="ttdef"><b>Definition</b> indexing.h:11</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:10</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:13</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:9</div></div>
</div><!-- fragment --></div><!-- contents -->
</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="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><li class="navelem"><a class="el" href="kernels_2indexing_8h.html">indexing.h</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.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink