mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
175 lines
19 KiB
HTML
175 lines
19 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.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MLX: mlx/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>
|
|
<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&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">utils.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <variant></code><br />
|
|
<code>#include "<a class="el" href="array_8h_source.html">array.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="device_8h_source.html">device.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="dtype_8h_source.html">dtype.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="stream_8h_source.html">stream.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="utils_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmlx_1_1core_1_1_stream_context.html">mlx::core::StreamContext</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmlx_1_1core_1_1_print_formatter.html">mlx::core::PrintFormatter</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:namespacemlx" id="r_namespacemlx"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:namespacemlx_1_1core" id="r_namespacemlx_1_1core"><td class="memItemLeft" align="right" valign="top">namespace  </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"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a95fc1013cc48fbfee0c54310711a5e58" id="r_a95fc1013cc48fbfee0c54310711a5e58"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">mlx::core::StreamOrDevice</a> = std::variant<std::monostate, <a class="el" href="structmlx_1_1core_1_1_stream.html">Stream</a>, <a class="el" href="structmlx_1_1core_1_1_device.html">Device</a>></td></tr>
|
|
<tr class="separator:a95fc1013cc48fbfee0c54310711a5e58"><td class="memSeparator" colspan="2"> </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:a4734a596e57434492ddfe79f2cb9dbf9" id="r_a4734a596e57434492ddfe79f2cb9dbf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_stream.html">Stream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4734a596e57434492ddfe79f2cb9dbf9">mlx::core::to_stream</a> (<a class="el" href="namespacemlx_1_1core.html#a95fc1013cc48fbfee0c54310711a5e58">StreamOrDevice</a> s)</td></tr>
|
|
<tr class="separator:a4734a596e57434492ddfe79f2cb9dbf9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b984eef832f757e28cd262d64a49ae7" id="r_a8b984eef832f757e28cd262d64a49ae7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a8b984eef832f757e28cd262d64a49ae7">mlx::core::result_type</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &a, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &b)</td></tr>
|
|
<tr class="memdesc:a8b984eef832f757e28cd262d64a49ae7"><td class="mdescLeft"> </td><td class="mdescRight">The type from promoting the arrays' types with one another. <br /></td></tr>
|
|
<tr class="separator:a8b984eef832f757e28cd262d64a49ae7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac457c232f956ba802acb69c5a621633d" id="r_ac457c232f956ba802acb69c5a621633d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ac457c232f956ba802acb69c5a621633d">mlx::core::result_type</a> (const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &a, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &b, const <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &c)</td></tr>
|
|
<tr class="separator:ac457c232f956ba802acb69c5a621633d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafaf24a28297428caf6d0c36c623489e" id="r_aafaf24a28297428caf6d0c36c623489e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#aafaf24a28297428caf6d0c36c623489e">mlx::core::result_type</a> (const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &arrays)</td></tr>
|
|
<tr class="separator:aafaf24a28297428caf6d0c36c623489e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a075e07def338cd9d815182d0e6a656c0" id="r_a075e07def338cd9d815182d0e6a656c0"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a075e07def338cd9d815182d0e6a656c0">mlx::core::broadcast_shapes</a> (const std::vector< int > &s1, const std::vector< int > &s2)</td></tr>
|
|
<tr class="separator:a075e07def338cd9d815182d0e6a656c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4b664de4a4abd305827b30879b9da33" id="r_ad4b664de4a4abd305827b30879b9da33"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ad4b664de4a4abd305827b30879b9da33">mlx::core::is_same_shape</a> (const std::vector< <a class="el" href="classmlx_1_1core_1_1array.html">array</a> > &arrays)</td></tr>
|
|
<tr class="separator:ad4b664de4a4abd305827b30879b9da33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b5f1435b7628a094a38b62e403e1540" id="r_a8b5f1435b7628a094a38b62e403e1540"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a8b5f1435b7628a094a38b62e403e1540"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a8b5f1435b7628a094a38b62e403e1540">mlx::core::check_shape_dim</a> (const T dim)</td></tr>
|
|
<tr class="memdesc:a8b5f1435b7628a094a38b62e403e1540"><td class="mdescLeft"> </td><td class="mdescRight">Returns the shape dimension if it's within allowed range. <br /></td></tr>
|
|
<tr class="separator:a8b5f1435b7628a094a38b62e403e1540"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0181b5d72bf3d34448dabc70f7ff858d" id="r_a0181b5d72bf3d34448dabc70f7ff858d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a0181b5d72bf3d34448dabc70f7ff858d">mlx::core::normalize_axis</a> (int axis, int ndim)</td></tr>
|
|
<tr class="memdesc:a0181b5d72bf3d34448dabc70f7ff858d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the axis normalized to be in the range [0, ndim). <br /></td></tr>
|
|
<tr class="separator:a0181b5d72bf3d34448dabc70f7ff858d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e5c30e316afa30c14bc48b92afdb794" id="r_a1e5c30e316afa30c14bc48b92afdb794"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1e5c30e316afa30c14bc48b92afdb794">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="structmlx_1_1core_1_1_device.html">Device</a> &d)</td></tr>
|
|
<tr class="separator:a1e5c30e316afa30c14bc48b92afdb794"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ddd07021b36c848d6fb1dd9ac276822" id="r_a4ddd07021b36c848d6fb1dd9ac276822"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4ddd07021b36c848d6fb1dd9ac276822">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="structmlx_1_1core_1_1_stream.html">Stream</a> &s)</td></tr>
|
|
<tr class="separator:a4ddd07021b36c848d6fb1dd9ac276822"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0023c267cf81345fad65e7a797954cd3" id="r_a0023c267cf81345fad65e7a797954cd3"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a0023c267cf81345fad65e7a797954cd3">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="structmlx_1_1core_1_1_dtype.html">Dtype</a> &d)</td></tr>
|
|
<tr class="separator:a0023c267cf81345fad65e7a797954cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fd58658474fb842d648dcf8f7d9f078" id="r_a1fd58658474fb842d648dcf8f7d9f078"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a1fd58658474fb842d648dcf8f7d9f078">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="structmlx_1_1core_1_1_dtype.html#adb1ea8b45a0c53e04a0e73b168702715">Dtype::Kind</a> &k)</td></tr>
|
|
<tr class="separator:a1fd58658474fb842d648dcf8f7d9f078"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a123331f01188bd76e37623b63b6b4340" id="r_a123331f01188bd76e37623b63b6b4340"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a123331f01188bd76e37623b63b6b4340">mlx::core::operator<<</a> (std::ostream &os, <a class="el" href="classmlx_1_1core_1_1array.html">array</a> a)</td></tr>
|
|
<tr class="separator:a123331f01188bd76e37623b63b6b4340"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e733bba89760abed32393e085812b22" id="r_a4e733bba89760abed32393e085812b22"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4e733bba89760abed32393e085812b22">mlx::core::operator<<</a> (std::ostream &os, const std::vector< int > &v)</td></tr>
|
|
<tr class="separator:a4e733bba89760abed32393e085812b22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6276bb9bad43ed4a27a1e2c3f5bfd990" id="r_a6276bb9bad43ed4a27a1e2c3f5bfd990"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a6276bb9bad43ed4a27a1e2c3f5bfd990">mlx::core::operator<<</a> (std::ostream &os, const std::vector< size_t > &v)</td></tr>
|
|
<tr class="separator:a6276bb9bad43ed4a27a1e2c3f5bfd990"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e5bd5c57b1cf19776bdb41e732861d9" id="r_a5e5bd5c57b1cf19776bdb41e732861d9"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a5e5bd5c57b1cf19776bdb41e732861d9">mlx::core::operator<<</a> (std::ostream &os, const std::vector< int64_t > &v)</td></tr>
|
|
<tr class="separator:a5e5bd5c57b1cf19776bdb41e732861d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42a19c8442b173606e714364227e7d45" id="r_a42a19c8442b173606e714364227e7d45"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a42a19c8442b173606e714364227e7d45">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="structmlx_1_1core_1_1complex64__t.html">complex64_t</a> &v)</td></tr>
|
|
<tr class="separator:a42a19c8442b173606e714364227e7d45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57eb97a5eba99a846ac429795e407574" id="r_a57eb97a5eba99a846ac429795e407574"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a57eb97a5eba99a846ac429795e407574">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="namespacemlx_1_1core.html#afbd2769c30e721afc85a7b9fb55b8e52">float16_t</a> &v)</td></tr>
|
|
<tr class="separator:a57eb97a5eba99a846ac429795e407574"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7db909d54cf07375e89424c32c07a29c" id="r_a7db909d54cf07375e89424c32c07a29c"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a7db909d54cf07375e89424c32c07a29c">mlx::core::operator<<</a> (std::ostream &os, const <a class="el" href="namespacemlx_1_1core.html#acb5d16c9b83778c7621c38e522e0060b">bfloat16_t</a> &v)</td></tr>
|
|
<tr class="separator:a7db909d54cf07375e89424c32c07a29c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adacbc4526e8964b267a8ec3eb1bc1a32" id="r_adacbc4526e8964b267a8ec3eb1bc1a32"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#adacbc4526e8964b267a8ec3eb1bc1a32">mlx::core::is_power_of_2</a> (int n)</td></tr>
|
|
<tr class="separator:adacbc4526e8964b267a8ec3eb1bc1a32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a685c0530e338aabc622325685846ce93" id="r_a685c0530e338aabc622325685846ce93"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a685c0530e338aabc622325685846ce93">mlx::core::next_power_of_2</a> (int n)</td></tr>
|
|
<tr class="separator:a685c0530e338aabc622325685846ce93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:af5a408a78cc934717dd711ddfda58ea6" id="r_af5a408a78cc934717dd711ddfda58ea6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_print_formatter.html">PrintFormatter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af5a408a78cc934717dd711ddfda58ea6">mlx::core::global_formatter</a></td></tr>
|
|
<tr class="separator:af5a408a78cc934717dd711ddfda58ea6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|