mlx/docs/build/html/backend_2common_2utils_8h_source.html

278 lines
33 KiB
HTML
Raw Normal View History

2024-06-07 11:28:06 +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/common/utils.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_f149b24a1b5be11cd70151abe517e3f8.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">utils.h</div></div>
</div><!--header-->
<div class="contents">
<a href="backend_2common_2utils_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;vector&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="preprocessor">#include &quot;<a class="code" href="array_8h.html">mlx/array.h</a>&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemlx_1_1core.html">mlx::core</a> {</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> str<span class="keywordtype">id</span>e_t&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="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880"> 12</a></span><span class="keyword">inline</span> stride_t <a class="code hl_function" href="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880">elem_to_loc</a>(</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordtype">int</span> elem,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; shape,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">const</span> std::vector&lt;stride_t&gt;&amp; strides) {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> stride_t loc = 0;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = shape.size() - 1; i &gt;= 0; --i) {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">auto</span> q_and_r = ldiv(elem, shape[i]);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> loc += q_and_r.rem * strides[i];</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> elem = q_and_r.quot;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> }</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordflow">return</span> loc;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>}</div>
</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ad7e4f40eb351b554bbfabb6d7d600d06"> 25</a></span><span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880">elem_to_loc</a>(<span class="keywordtype">int</span> elem, <span class="keyword">const</span> <a class="code hl_class" href="classmlx_1_1core_1_1array.html">array</a>&amp; a) {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> (a.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a0a20a6065ae71b64c1e3aa22a45fd8a1">flags</a>().<a class="code hl_variable" href="structmlx_1_1core_1_1array_1_1_flags.html#a3170fa381dc7a90f6eabcc029bdf9bfd">row_contiguous</a>) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">return</span> elem;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> }</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880">elem_to_loc</a>(elem, a.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a4a2a2c8a4a5beafd723fc13f2055d55d">shape</a>(), a.<a class="code hl_function" href="classmlx_1_1core_1_1array.html#a186cf2648da92584d5c1c8b24e69629b">strides</a>());</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>}</div>
</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> str<span class="keywordtype">id</span>e_t&gt;</div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="}">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ac9fb1286a1a00395e901dbff80560895"> 33</a></span>std::vector&lt;stride_t&gt; <a class="code hl_function" href="namespacemlx_1_1core.html#ac9fb1286a1a00395e901dbff80560895">make_contiguous_strides</a>(<span class="keyword">const</span> std::vector&lt;int&gt;&amp; shape) {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> std::vector&lt;stride_t&gt; strides(shape.size(), 1);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = shape.size() - 1; i &gt; 0; i--) {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> strides[i - 1] = strides[i] * shape[i];</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">return</span> strides;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
2024-06-07 11:28:06 +08:00
</div>
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">// Collapse dims that are contiguous to possibly route to a better kernel</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// e.g. for x = transpose(array({0, 1, 2, 3, 4, 5, 6, 7}, {2, 2, 2}), {2, 0, 1})</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">// should return {{2, 4}, {{1, 2}}}.</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">//</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// When multiple arrays are passed they should all have the same shape. The</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">// collapsed axes are also the same so one shape is returned.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> str<span class="keywordtype">id</span>e_t&gt;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">inline</span> std::tuple&lt;std::vector&lt;int&gt;, std::vector&lt;std::vector&lt;stride_t&gt;&gt;&gt;</div>
<div class="foldopen" id="foldopen00049" data-start="{" data-end="}">
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c"> 49</a></span><a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; shape,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">const</span> std::vector&lt;std::vector&lt;stride_t&gt;&gt; strides) {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Make a vector that has axes separated with -1. Collapse all axes between</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// -1.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> std::vector&lt;int&gt; to_collapse;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">if</span> (shape.size() &gt; 0) {</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> to_collapse.push_back(0);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i &lt; shape.size(); i++) {</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">bool</span> contiguous = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> std::vector&lt;stride_t&gt;&amp; st : strides) {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">if</span> (st[i] * shape[i] != st[i - 1]) {</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> contiguous = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">if</span> (!contiguous) {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> }</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">if</span> (!contiguous) {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> to_collapse.push_back(-1);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> }</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> to_collapse.push_back(i);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> to_collapse.push_back(-1);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> }</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> std::vector&lt;int&gt; out_shape;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> std::vector&lt;std::vector&lt;stride_t&gt;&gt; out_strides(strides.size());</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; to_collapse.size(); i++) {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">int</span> current_shape = shape[to_collapse[i]];</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">while</span> (to_collapse[++i] != -1) {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> current_shape *= shape[to_collapse[i]];</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> }</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> out_shape.push_back(current_shape);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j &lt; strides.size(); j++) {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">const</span> std::vector&lt;stride_t&gt;&amp; st = strides[j];</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> out_strides[j].push_back(st[to_collapse[i - 1]]);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> }</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordflow">return</span> std::make_tuple(out_shape, out_strides);</div>
2024-06-07 11:28:06 +08:00
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>}</div>
</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keyword">inline</span> std::tuple&lt;std::vector&lt;int&gt;, std::vector&lt;std::vector&lt;size_t&gt;&gt;&gt;</div>
2024-06-07 11:28:06 +08:00
<div class="foldopen" id="foldopen00093" data-start="{" data-end="}">
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a8430e0baac3f6d8a2ab22428f9c0b7e2"> 93</a></span><a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(<span class="keyword">const</span> std::vector&lt;array&gt;&amp; xs) {</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> std::vector&lt;std::vector&lt;size_t&gt;&gt; strides;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; x : xs) {</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> strides.emplace_back(x.strides());</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> }</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(xs[0].shape(), strides);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>}</div>
2024-06-07 11:28:06 +08:00
</div>
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Arrays, <span class="keyword">typename</span> = <a class="code hl_typedef" href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">enable_for_arrays_t</a>&lt;Arrays...&gt;&gt;</div>
<div class="foldopen" id="foldopen00102" data-start="{" data-end="}">
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ac813412cce77fc1340dcfefc6e099276"> 102</a></span><span class="keyword">inline</span> <span class="keyword">auto</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(Arrays&amp;&amp;... xs) {</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> std::vector&lt;array&gt;{std::forward&lt;Arrays&gt;(xs)...});</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>}</div>
2024-06-07 11:28:06 +08:00
</div>
2024-07-12 06:32:08 +08:00
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
2024-08-24 03:14:53 +08:00
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">// The single array version of the above.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="keyword">inline</span> std::tuple&lt;std::vector&lt;int&gt;, std::vector&lt;size_t&gt;&gt;</div>
<div class="foldopen" id="foldopen00109" data-start="{" data-end="}">
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#ad2f039e04bf902c9d98f631a67cc63ed"> 109</a></span><a class="code hl_function" href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">collapse_contiguous_dims</a>(</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; shape,</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">const</span> std::vector&lt;size_t&gt;&amp; strides) {</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> std::vector&lt;int&gt; collapsed_shape;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::vector&lt;size_t&gt; collapsed_strides;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">if</span> (shape.size() &gt; 0) {</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> collapsed_shape.push_back(shape[0]);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> collapsed_strides.push_back(strides[0]);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 1; i &lt; shape.size(); i++) {</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keywordflow">if</span> (strides[i] * shape[i] != collapsed_strides.back() ||</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> collapsed_shape.back() * <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(shape[i]) &gt;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> std::numeric_limits&lt;int&gt;::max()) {</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> collapsed_shape.push_back(shape[i]);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> collapsed_strides.push_back(strides[i]);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> collapsed_shape.back() *= shape[i];</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> collapsed_strides.back() = strides[i];</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> }</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> }</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> }</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keywordflow">return</span> std::make_tuple(collapsed_shape, collapsed_strides);</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span>}</div>
2024-07-12 06:32:08 +08:00
</div>
2024-08-24 03:14:53 +08:00
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> str<span class="keywordtype">id</span>e_t&gt;</div>
<div class="foldopen" id="foldopen00135" data-start="{" data-end="}">
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="namespacemlx_1_1core.html#a847b0a276663d9ddb5cac905ee977f03"> 135</a></span><span class="keyword">inline</span> <span class="keyword">auto</span> <a class="code hl_function" href="namespacemlx_1_1core.html#a847b0a276663d9ddb5cac905ee977f03">check_contiguity</a>(</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">const</span> std::vector&lt;int&gt;&amp; shape,</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">const</span> std::vector&lt;stride_t&gt;&amp; strides) {</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">size_t</span> data_size = 1;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">size_t</span> f_stride = 1;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">size_t</span> b_stride = 1;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">bool</span> is_row_contiguous = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">bool</span> is_col_contiguous = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0, ri = shape.size() - 1; ri &gt;= 0; i++, ri--) {</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> is_col_contiguous &amp;= strides[i] == f_stride || shape[i] == 1;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> is_row_contiguous &amp;= strides[ri] == b_stride || shape[ri] == 1;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> f_stride *= shape[i];</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> b_stride *= shape[ri];</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="keywordflow">if</span> (strides[i] &gt; 0) {</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> data_size *= shape[i];</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> }</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> }</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordflow">return</span> std::make_tuple(data_size, is_row_contiguous, is_col_contiguous);</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>}</div>
</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span>} <span class="comment">// namespace mlx::core</span></div>
2024-06-07 11:28:06 +08:00
<div class="ttc" id="aarray_8h_html"><div class="ttname"><a href="array_8h.html">array.h</a></div></div>
<div class="ttc" id="aclassmlx_1_1core_1_1array_html"><div class="ttname"><a href="classmlx_1_1core_1_1array.html">mlx::core::array</a></div><div class="ttdef"><b>Definition</b> array.h:20</div></div>
<div class="ttc" id="aclassmlx_1_1core_1_1array_html_a0a20a6065ae71b64c1e3aa22a45fd8a1"><div class="ttname"><a href="classmlx_1_1core_1_1array.html#a0a20a6065ae71b64c1e3aa22a45fd8a1">mlx::core::array::flags</a></div><div class="ttdeci">const Flags &amp; flags() const</div><div class="ttdoc">Get the Flags bit-field.</div><div class="ttdef"><b>Definition</b> array.h:290</div></div>
<div class="ttc" id="aclassmlx_1_1core_1_1array_html_a186cf2648da92584d5c1c8b24e69629b"><div class="ttname"><a href="classmlx_1_1core_1_1array.html#a186cf2648da92584d5c1c8b24e69629b">mlx::core::array::strides</a></div><div class="ttdeci">const std::vector&lt; size_t &gt; &amp; strides() const</div><div class="ttdoc">The strides of the array.</div><div class="ttdef"><b>Definition</b> array.h:113</div></div>
<div class="ttc" id="aclassmlx_1_1core_1_1array_html_a4a2a2c8a4a5beafd723fc13f2055d55d"><div class="ttname"><a href="classmlx_1_1core_1_1array.html#a4a2a2c8a4a5beafd723fc13f2055d55d">mlx::core::array::shape</a></div><div class="ttdeci">const std::vector&lt; int &gt; &amp; shape() const</div><div class="ttdoc">The shape of the array as a vector of integers.</div><div class="ttdef"><b>Definition</b> array.h:99</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html"><div class="ttname"><a href="namespacemlx_1_1core.html">mlx::core</a></div><div class="ttdef"><b>Definition</b> allocator.h:7</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_a4950c3248e70280b406a4f1430a85880"><div class="ttname"><a href="namespacemlx_1_1core.html#a4950c3248e70280b406a4f1430a85880">mlx::core::elem_to_loc</a></div><div class="ttdeci">stride_t elem_to_loc(int elem, const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; stride_t &gt; &amp;strides)</div><div class="ttdef"><b>Definition</b> utils.h:12</div></div>
2024-08-24 03:14:53 +08:00
<div class="ttc" id="anamespacemlx_1_1core_html_a847b0a276663d9ddb5cac905ee977f03"><div class="ttname"><a href="namespacemlx_1_1core.html#a847b0a276663d9ddb5cac905ee977f03">mlx::core::check_contiguity</a></div><div class="ttdeci">auto check_contiguity(const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; stride_t &gt; &amp;strides)</div><div class="ttdef"><b>Definition</b> utils.h:135</div></div>
2024-07-12 06:32:08 +08:00
<div class="ttc" id="anamespacemlx_1_1core_html_a9d151ba3e138be1954d2f51f85806b0c"><div class="ttname"><a href="namespacemlx_1_1core.html#a9d151ba3e138be1954d2f51f85806b0c">mlx::core::collapse_contiguous_dims</a></div><div class="ttdeci">std::tuple&lt; std::vector&lt; int &gt;, std::vector&lt; std::vector&lt; stride_t &gt; &gt; &gt; collapse_contiguous_dims(const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; std::vector&lt; stride_t &gt; &gt; strides)</div><div class="ttdef"><b>Definition</b> utils.h:49</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_ac9fb1286a1a00395e901dbff80560895"><div class="ttname"><a href="namespacemlx_1_1core.html#ac9fb1286a1a00395e901dbff80560895">mlx::core::make_contiguous_strides</a></div><div class="ttdeci">std::vector&lt; stride_t &gt; make_contiguous_strides(const std::vector&lt; int &gt; &amp;shape)</div><div class="ttdef"><b>Definition</b> utils.h:33</div></div>
<div class="ttc" id="anamespacemlx_1_1core_html_af89751d79339f3e4d9318ea97d64d114"><div class="ttname"><a href="namespacemlx_1_1core.html#af89751d79339f3e4d9318ea97d64d114">mlx::core::enable_for_arrays_t</a></div><div class="ttdeci">typename std::enable_if_t&lt; is_arrays_v&lt; T... &gt; &gt; enable_for_arrays_t</div><div class="ttdef"><b>Definition</b> array.h:566</div></div>
2024-06-07 11:28:06 +08:00
<div class="ttc" id="astructmlx_1_1core_1_1array_1_1_flags_html_a3170fa381dc7a90f6eabcc029bdf9bfd"><div class="ttname"><a href="structmlx_1_1core_1_1array_1_1_flags.html#a3170fa381dc7a90f6eabcc029bdf9bfd">mlx::core::array::Flags::row_contiguous</a></div><div class="ttdeci">bool row_contiguous</div><div class="ttdef"><b>Definition</b> array.h:226</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>