mlx/docs/build/html/backend_2common_2utils_8h.html
CircleCI Docs fe6b3ed02c rebase
2025-06-04 01:01:52 +00:00

154 lines
14 KiB
HTML

<!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: mlx/backend/common/utils.h File 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 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 id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">utils.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
</div>
<p><a href="backend_2common_2utils_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmlx_1_1core_1_1_contiguous_iterator.html">mlx::core::ContiguousIterator&lt; StrideT &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html">mlx::core</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a77657cb50fd9392f7f4c64e43843c2b3" id="r_a77657cb50fd9392f7f4c64e43843c2b3"><td class="memTemplParams" colspan="2">template&lt;typename StrideT &gt; </td></tr>
<tr class="memitem:a77657cb50fd9392f7f4c64e43843c2b3"><td class="memTemplItemLeft" align="right" valign="top">StrideT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a77657cb50fd9392f7f4c64e43843c2b3">mlx::core::elem_to_loc</a> (int elem, const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; StrideT &gt; &amp;strides)</td></tr>
<tr class="separator:a77657cb50fd9392f7f4c64e43843c2b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7e4f40eb351b554bbfabb6d7d600d06" id="r_ad7e4f40eb351b554bbfabb6d7d600d06"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ad7e4f40eb351b554bbfabb6d7d600d06">mlx::core::elem_to_loc</a> (int elem, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a)</td></tr>
<tr class="separator:ad7e4f40eb351b554bbfabb6d7d600d06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a085379297e21d57f5b3aa38ae1c26070" id="r_a085379297e21d57f5b3aa38ae1c26070"><td class="memTemplParams" colspan="2">template&lt;typename StrideT &gt; </td></tr>
<tr class="memitem:a085379297e21d57f5b3aa38ae1c26070"><td class="memTemplItemLeft" align="right" valign="top">std::vector&lt; StrideT &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a085379297e21d57f5b3aa38ae1c26070">mlx::core::make_contiguous_strides</a> (const std::vector&lt; int &gt; &amp;shape)</td></tr>
<tr class="separator:a085379297e21d57f5b3aa38ae1c26070"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38fe6ec5220d13d96c7dad7556d2b613" id="r_a38fe6ec5220d13d96c7dad7556d2b613"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; std::vector&lt; int &gt;, std::vector&lt; std::vector&lt; int64_t &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a38fe6ec5220d13d96c7dad7556d2b613">mlx::core::collapse_contiguous_dims</a> (const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; std::vector&lt; int64_t &gt; &gt; &amp;strides, int64_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:a38fe6ec5220d13d96c7dad7556d2b613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2895f9b0083efd8221275eb8cadccbe" id="r_af2895f9b0083efd8221275eb8cadccbe"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; std::vector&lt; int &gt;, std::vector&lt; std::vector&lt; size_t &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af2895f9b0083efd8221275eb8cadccbe">mlx::core::collapse_contiguous_dims</a> (const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; std::vector&lt; size_t &gt; &gt; &amp;strides, size_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:af2895f9b0083efd8221275eb8cadccbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e2b6edc0fe82230cb93f5ea39febb4" id="r_a90e2b6edc0fe82230cb93f5ea39febb4"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; std::vector&lt; int &gt;, std::vector&lt; std::vector&lt; size_t &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a90e2b6edc0fe82230cb93f5ea39febb4">mlx::core::collapse_contiguous_dims</a> (const std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt; &amp;xs, size_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:a90e2b6edc0fe82230cb93f5ea39febb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac813412cce77fc1340dcfefc6e099276" id="r_ac813412cce77fc1340dcfefc6e099276"><td class="memTemplParams" colspan="2">template&lt;typename... Arrays, typename = enable_for_arrays_t&lt;Arrays...&gt;&gt; </td></tr>
<tr class="memitem:ac813412cce77fc1340dcfefc6e099276"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ac813412cce77fc1340dcfefc6e099276">mlx::core::collapse_contiguous_dims</a> (Arrays &amp;&amp;... xs)</td></tr>
<tr class="separator:ac813412cce77fc1340dcfefc6e099276"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab3cc7f3808934ae0727b920eba231bd" id="r_aab3cc7f3808934ae0727b920eba231bd"><td class="memItemLeft" align="right" valign="top">std::pair&lt; std::vector&lt; int &gt;, std::vector&lt; int64_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#aab3cc7f3808934ae0727b920eba231bd">mlx::core::collapse_contiguous_dims</a> (const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; int64_t &gt; &amp;strides, int64_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:aab3cc7f3808934ae0727b920eba231bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e0cbcf109d32794ffc8efc7302ba9b0" id="r_a1e0cbcf109d32794ffc8efc7302ba9b0"><td class="memItemLeft" align="right" valign="top">std::pair&lt; std::vector&lt; int &gt;, std::vector&lt; size_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1e0cbcf109d32794ffc8efc7302ba9b0">mlx::core::collapse_contiguous_dims</a> (const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; size_t &gt; &amp;strides, size_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:a1e0cbcf109d32794ffc8efc7302ba9b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ee50bfb240512d0c0ce151dfe2c74ef" id="r_a4ee50bfb240512d0c0ce151dfe2c74ef"><td class="memItemLeft" align="right" valign="top">std::pair&lt; std::vector&lt; int &gt;, std::vector&lt; size_t &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4ee50bfb240512d0c0ce151dfe2c74ef">mlx::core::collapse_contiguous_dims</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;a, size_t size_cap=std::numeric_limits&lt; int32_t &gt;<a class="el" href="group__ops.html#ga7fed87d96cc7741d8267f4eac83f5fe7">::max</a>())</td></tr>
<tr class="separator:a4ee50bfb240512d0c0ce151dfe2c74ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ba20a804c306067b7023259429e0e48" id="r_a3ba20a804c306067b7023259429e0e48"><td class="memTemplParams" colspan="2">template&lt;typename StrideT &gt; </td></tr>
<tr class="memitem:a3ba20a804c306067b7023259429e0e48"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a3ba20a804c306067b7023259429e0e48">mlx::core::check_contiguity</a> (const std::vector&lt; int &gt; &amp;shape, const std::vector&lt; StrideT &gt; &amp;strides)</td></tr>
<tr class="separator:a3ba20a804c306067b7023259429e0e48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af650e831ce21759da1ac103037d08d84" id="r_af650e831ce21759da1ac103037d08d84"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af650e831ce21759da1ac103037d08d84">mlx::core::is_donatable</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;in, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &amp;out)</td></tr>
<tr class="separator:af650e831ce21759da1ac103037d08d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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>