mlx/docs/build/html/namespacemembers_func_s.html
CircleCI Docs a18bfad3da rebase
2025-07-08 21:30:25 +00:00

203 lines
18 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: Namespace Members</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('namespacemembers_func_s.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="contents">
<div class="textblock">Here is a list of all namespace functions with links to the namespace documentation for each function:</div>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>save()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#ad4c2cebe9e54582295f98c5a448a1f32">mlx::core</a></li>
<li>save_gguf()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a8bcc29ca8846ec99dce333df4a34dc5f">mlx::core</a></li>
<li>save_safetensors()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a9f158db20c2405557f3ebc397e876de8">mlx::core</a></li>
<li>scaled_dot_product_attention()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1fast.html#a3663b50265b0a9c0cca2b5376852e059">mlx::core::fast</a></li>
<li>scan()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a81c2cf124b0803098a54a78f8f6873a6">mlx::core::metal</a></li>
<li>scatter()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a32e902c6cd6d35fcc3119ed6685a170f">mlx::core::metal</a>, <a class="el" href="group__ops.html#gad438be8f90bae9d37c6853b8f4225d61">mlx::core</a></li>
<li>scatter_add()&#160;:&#160;<a class="el" href="group__ops.html#gacd14c2b5cfebf343fc2d672722f8d174">mlx::core</a></li>
<li>scatter_add_axis()&#160;:&#160;<a class="el" href="group__ops.html#gab3fd98c0d06b84b836f93bddbd7a2a0d">mlx::core</a></li>
<li>scatter_axis()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a88c1d42d525fcdfb2f9e8aa2c3f82ea6">mlx::core::metal</a></li>
<li>scatter_max()&#160;:&#160;<a class="el" href="group__ops.html#ga05881a4157cd113c9392d168a79e6673">mlx::core</a></li>
<li>scatter_min()&#160;:&#160;<a class="el" href="group__ops.html#ga0ca16b7579dfc899f3f7fd40245ba7c5">mlx::core</a></li>
<li>scatter_prod()&#160;:&#160;<a class="el" href="group__ops.html#ga3708b5bcb61e2c63d213c4ce6ad0ffc0">mlx::core</a></li>
<li>scheduler()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1scheduler.html#ae856e468c2f7c8f8ec672522cc13730b">mlx::core::scheduler</a></li>
<li>seed()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1random.html#ac4ad325b613257306df74595d3d0e23b">mlx::core::random</a></li>
<li>select()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1simd.html#afb3bcbd8d8b34128cd0c8eb677a170ef">mlx::core::simd</a></li>
<li>send()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1distributed_1_1detail.html#abf33511660ac71df5fc92f2aad6c6e08">mlx::core::distributed::detail</a>, <a class="el" href="namespacemlx_1_1core_1_1distributed.html#a5a8360edaa3a528a3927fce4d2cf1777">mlx::core::distributed</a></li>
<li>set_binary_op_output_data()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a6a52856325c2eb031d3983eba2108d59">mlx::core</a></li>
<li>set_cache_limit()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#ab09c9b60f1e886ab859e6a066c9a5b9d">mlx::core::metal</a></li>
<li>set_compile_mode()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a49445a55f976c4397f25ea18e1e92bef">mlx::core</a></li>
<li>set_default_device()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a312a2de41367fe52caeaf8c0f596a120">mlx::core</a></li>
<li>set_default_stream()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#af35a2b06517d8bb7dbb469692b4f841c">mlx::core</a></li>
<li>set_memory_limit()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a3fb2c4a237fa4bfdff798156146c4937">mlx::core::metal</a></li>
<li>set_ternary_op_output_data()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a6f4528d0d338ea5e1f19d345875c26a2">mlx::core</a></li>
<li>set_unary_output_data()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a4c6a4241bfcdd7bbf30d0e521b79e5a3">mlx::core</a></li>
<li>set_wired_limit()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a31eab4828d31d292bc84e07b0d961e1e">mlx::core::metal</a></li>
<li>shapes_without_reduction_axes()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a0bea91a360a984e72d2815353f97ee25">mlx::core</a></li>
<li>shared_buffer_reshape()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a88d88987bd8bf3ca46bf3b5e8aacce9d">mlx::core</a></li>
<li>shared_buffer_slice()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a349a9fc2bfd950f679a3fe39b8bdedad">mlx::core</a></li>
<li>sigmoid()&#160;:&#160;<a class="el" href="group__ops.html#ga708abf8f79609cd6831db7c38cafac0e">mlx::core</a></li>
<li>sign()&#160;:&#160;<a class="el" href="group__ops.html#ga20f1a1a8c0cd6206485f9363f3915faa">mlx::core</a></li>
<li>simd_broadcast()&#160;:&#160;<a class="el" href="namespacemetal.html#a498f1e85107eb5f01ba4435977f8efe0">metal</a></li>
<li>simd_max()&#160;:&#160;<a class="el" href="namespacemetal.html#a048cad0aca52cb737ebf103e76bd1c49">metal</a></li>
<li>simd_min()&#160;:&#160;<a class="el" href="namespacemetal.html#ae9e2a23e00724ba2d7868bc4112b386b">metal</a></li>
<li>simd_prefix_exclusive_product()&#160;:&#160;<a class="el" href="namespacemetal.html#a5ca40242390b632f737e29636829b2e4">metal</a></li>
<li>simd_prefix_exclusive_sum()&#160;:&#160;<a class="el" href="namespacemetal.html#abfbb70c7471f28bf7ff36a612ad014b2">metal</a></li>
<li>simd_prefix_inclusive_product()&#160;:&#160;<a class="el" href="namespacemetal.html#a6ca6a7e1996228fa536e969e9e45c446">metal</a></li>
<li>simd_prefix_inclusive_sum()&#160;:&#160;<a class="el" href="namespacemetal.html#a567acb18199ac0107712eb8cb8aeb8e9">metal</a></li>
<li>simd_product()&#160;:&#160;<a class="el" href="namespacemetal.html#ac6e883a04e2265a9790d7db76059e1b4">metal</a></li>
<li>simd_shuffle()&#160;:&#160;<a class="el" href="namespacemetal.html#a259ed115bc3c58f88eb35830916b26d4">metal</a></li>
<li>simd_shuffle_and_fill_down()&#160;:&#160;<a class="el" href="namespacemetal.html#ae29a06f0eac636ad7af21dea5b04938b">metal</a></li>
<li>simd_shuffle_and_fill_up()&#160;:&#160;<a class="el" href="namespacemetal.html#a1ca14116bf50639b214d8414b5bbaaa6">metal</a></li>
<li>simd_shuffle_down()&#160;:&#160;<a class="el" href="namespacemetal.html#af6e2dd7ae087aba6abac4f0350b7611c">metal</a></li>
<li>simd_shuffle_rotate_down()&#160;:&#160;<a class="el" href="namespacemetal.html#a4bb203647a421032db47e73cd649841b">metal</a></li>
<li>simd_shuffle_rotate_up()&#160;:&#160;<a class="el" href="namespacemetal.html#a729b22077d6c944491a6027c18ea80c9">metal</a></li>
<li>simd_shuffle_up()&#160;:&#160;<a class="el" href="namespacemetal.html#afe81c5fbde3f4890458b081909242c55">metal</a></li>
<li>simd_shuffle_xor()&#160;:&#160;<a class="el" href="namespacemetal.html#a5017efc9605e069cfb507137cd1a1852">metal</a></li>
<li>simd_sum()&#160;:&#160;<a class="el" href="namespacemetal.html#a85181e37a00cb4a4217f1bb25389bce5">metal</a></li>
<li>simd_xor()&#160;:&#160;<a class="el" href="namespacemetal.html#a1308decbf2d5c33d34d6be523ea1c30f">metal</a></li>
<li>sin()&#160;:&#160;<a class="el" href="namespacemetal_1_1fast.html#a3af771cfe7a135104f9d063147dba270">metal::fast</a>, <a class="el" href="namespacemetal_1_1precise.html#a71acf77ffd29c56f56afae0195c98a1c">metal::precise</a>, <a class="el" href="namespacemetal.html#a619a159ca5f2ddfe3647d3a6bb6e804c">metal</a>, <a class="el" href="namespacemlx_1_1core_1_1simd.html#ab4d582d72c0a7ee313e19c906e43cef1">mlx::core::simd</a>, <a class="el" href="group__ops.html#gaebf0a73ad3732fba39df37826c235692">mlx::core</a>, <a class="el" href="namespacepocketfft_1_1detail.html#a07745f4a069f811859308281b2982258">pocketfft::detail</a></li>
<li>sincos()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1simd.html#ad78056685c9732c3465c0d8b8ec1bef7">mlx::core::simd</a></li>
<li>sinh()&#160;:&#160;<a class="el" href="namespacemetal_1_1fast.html#a990d90b3440e38d1fb4ff5065c6c189b">metal::fast</a>, <a class="el" href="namespacemetal_1_1precise.html#abc8f4f59dd6e7204ab5d84f0af96331c">metal::precise</a>, <a class="el" href="namespacemetal.html#a83ba4235ae350ab8880a9df09158620b">metal</a>, <a class="el" href="namespacemlx_1_1core_1_1simd.html#a09a2f3f2bc999c16babf3d8d90994d6e">mlx::core::simd</a>, <a class="el" href="group__ops.html#gaf532375c6563dbd6e329bdedf0224dd7">mlx::core</a></li>
<li>sinpi()&#160;:&#160;<a class="el" href="namespacemetal_1_1fast.html#ab07a32fe544aa304577d29e0251e87b2">metal::fast</a>, <a class="el" href="namespacemetal_1_1precise.html#a78b17dab93519d9c82c2575dafec49c9">metal::precise</a>, <a class="el" href="namespacemetal.html#ae9655f7fa2ba6c0625ca25fbb278e269">metal</a></li>
<li>size_of()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#add4794cc0ffe5d717fc146084a235d95">mlx::core</a></li>
<li>slice()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a5adff87687b78bfc18dafbc654925cdb">mlx::core</a></li>
<li>slice_gpu()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a327578951a44116e5da2db651661265f">mlx::core</a></li>
<li>slice_update()&#160;:&#160;<a class="el" href="group__ops.html#ga7b7e786985d27789aaed20bb2f9509be">mlx::core</a></li>
<li>softmax()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a4fe937c2c584fd646926057f31d54ca6">mlx::core::metal</a>, <a class="el" href="group__ops.html#ga7e9bb08b43c8fd0444b7d3c9e09dc1c6">mlx::core</a></li>
<li>solve()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1linalg.html#a66590bfcec381e952b27630da0a31953">mlx::core::linalg</a></li>
<li>solve_triangular()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1linalg.html#a5e6e53f7a04688baa1329d166511febe">mlx::core::linalg</a></li>
<li>sort()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#ab77c9a9ecaeeab8c66b712862777c24b">mlx::core::metal</a>, <a class="el" href="group__ops.html#ga7fb616054665b3c2d61fa234f501f079">mlx::core</a></li>
<li>special_mul()&#160;:&#160;<a class="el" href="namespacepocketfft_1_1detail.html#a8da1f3d4a0b712a0285529f24187fe76">pocketfft::detail</a></li>
<li>split()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1random.html#a42847b435d037a977592e355eed072af">mlx::core::random</a>, <a class="el" href="group__ops.html#ga7534290bceab5fb3831a05d67bebce7d">mlx::core</a></li>
<li>sqrt()&#160;:&#160;<a class="el" href="namespacemetal_1_1fast.html#a4218a85c7d8a74cb8055b4755205627e">metal::fast</a>, <a class="el" href="namespacemetal_1_1precise.html#acb213467361cd2cab93a8d5ea1aa5bfd">metal::precise</a>, <a class="el" href="namespacemetal.html#ab3f4d4852ca0e591104fbd8e5b50d31b">metal</a>, <a class="el" href="namespacemlx_1_1core_1_1simd.html#ae39b8e1d1fff94947406eeb8ec6e0414">mlx::core::simd</a>, <a class="el" href="group__ops.html#ga297f853b3d90ec8ae81263977ba2ddb1">mlx::core</a>, <a class="el" href="namespacepocketfft_1_1detail.html#a774f8b73f28259d4276bd188b540a3e3">pocketfft::detail</a></li>
<li>square()&#160;:&#160;<a class="el" href="group__ops.html#ga1234e4c39cfa79f19d4bdb5b8ea4d45e">mlx::core</a></li>
<li>squeeze()&#160;:&#160;<a class="el" href="group__ops.html#ga710daa7ec721bd4d3f326082cb195576">mlx::core</a></li>
<li>stack()&#160;:&#160;<a class="el" href="group__ops.html#gaf8f2ec2b98a4b59eca73d7471df6e032">mlx::core</a></li>
<li>start_capture()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#aa47cb5651bf3b65c46ab216b7e504d77">mlx::core::metal</a></li>
<li>std()&#160;:&#160;<a class="el" href="group__ops.html#ga2a466024f8061febc0a64be557644cb0">mlx::core</a></li>
<li>steel_conv()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a92f1e559b1121d545746f81ff86eaca1">mlx::core::metal</a></li>
<li>steel_conv_general()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a02edb6a90bdf30f4c9f0d6c25b0267b5">mlx::core::metal</a></li>
<li>steel_gemm_fused()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a17764366deed71c160fb26091400a803">mlx::core::metal</a></li>
<li>steel_gemm_masked()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#a962272ca73d26c08f76f706a128fd71f">mlx::core::metal</a></li>
<li>steel_gemm_splitk()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#ad0dfd40ba7c09755711ceb731e57a5ac">mlx::core::metal</a></li>
<li>steel_matmul()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#aaff208bbac7021c4265580885874499a">mlx::core</a></li>
<li>steel_matmul_regular()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a2a8a09851097571fb51ac5b608550e44">mlx::core</a></li>
<li>stop_capture()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1metal.html#ac90714424e36fb01e04550de69b8314f">mlx::core::metal</a></li>
<li>stop_gradient()&#160;:&#160;<a class="el" href="group__ops.html#ga36bc28f1deb2fe668ca9ae1e447b6b1f">mlx::core</a></li>
<li>store()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1simd.html#afa2236afddfdec312eb7e27b89a5316a">mlx::core::simd</a></li>
<li>strided_reduce_general_dispatch()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#aa0332c64ee9965f05026c30a0b778000">mlx::core</a></li>
<li>subtract()&#160;:&#160;<a class="el" href="group__ops.html#ga196c240d3d0fcbb4713802c485e15133">mlx::core</a></li>
<li>sum()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1simd.html#a53b547b886918dc13d4da88eeb8811d2">mlx::core::simd</a>, <a class="el" href="group__ops.html#gade905ee92eb6ab7edfc312aeddfbaeb6">mlx::core</a>, <a class="el" href="namespacemlx_1_1steel.html#ab4a6ddea4beb7c447cf5b69b9d46cc3b">mlx::steel</a></li>
<li>svd()&#160;:&#160;<a class="el" href="namespacemlx_1_1core_1_1linalg.html#a64364b880e99914cf47bf756fa8dbaf0">mlx::core::linalg</a></li>
<li>swapaxes()&#160;:&#160;<a class="el" href="group__ops.html#gabc46eed81ab6c6247903e4ec0c4ec1fb">mlx::core</a></li>
<li>synchronize()&#160;:&#160;<a class="el" href="namespacemlx_1_1core.html#a14287949d82ffefad0306cef5eb5f9e4">mlx::core</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>