mlx/docs/build/html/functions_func_s.html
2025-06-04 01:01:50 +00:00

152 lines
16 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: Class Members - Functions</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>
</div><!-- top -->
<!-- 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 functions with links to the classes they belong to:</div>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>sanity_check()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1util.html#a3d2f5f00d4fed5c09bd1509ffa9a44cd">pocketfft::detail::util</a></li>
<li>ScaledDotProductAttention()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_scaled_dot_product_attention.html#a6a904c377fffc3c193102a3123f5e706">mlx::core::fast::ScaledDotProductAttention</a></li>
<li>Scan()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_scan.html#ac93e8f9c6771de825d2186ef34fa7087">mlx::core::Scan</a></li>
<li>Scatter()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_scatter.html#ac9b3eff67389ef9aa820753379ffeaa3">mlx::core::Scatter</a></li>
<li>Scheduler()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1scheduler_1_1_scheduler.html#a3ae42aed78a2200e9d02776fcd2316ba">mlx::core::scheduler::Scheduler</a></li>
<li>seed()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1random_1_1_key_sequence.html#a9f19c5da2031cba50d0ff996924347d8">mlx::core::random::KeySequence</a></li>
<li>seek()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1io_1_1_file_reader.html#aab62cc43970bd5de2c0115b1cc0a6af4">mlx::core::io::FileReader</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_file_writer.html#a9646f4ea048ae58719daeb588e2de433">mlx::core::io::FileWriter</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_reader.html#acea55078bd39ccaa27a9a36f17a39cd1">mlx::core::io::Reader</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_writer.html#a9c1716dda53aa36faea9c8fb1a3e34d4">mlx::core::io::Writer</a></li>
<li>Select()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_select.html#a6f833fe55dd68ad3726bbf9a8f75eec9">mlx::core::Select</a></li>
<li>Set()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1cmplx.html#a647fece372b64b13c4a7e5877d09a807">pocketfft::detail::cmplx&lt; T &gt;</a></li>
<li>set_cache_limit()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_metal_allocator.html#af392bced29d9e4e3f1a7cc4725d83764">mlx::core::metal::MetalAllocator</a></li>
<li>set_data()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a631acd8e318189640b8338f9ae1a554d">mlx::core::array</a></li>
<li>set_default_stream()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1scheduler_1_1_scheduler.html#a6d15314ac9cf25efc9bd1278de9a66bb">mlx::core::scheduler::Scheduler</a></li>
<li>set_input_array()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#ab69ff0d7f14b9b59db4df0608193dce4">mlx::core::metal::CommandEncoder</a></li>
<li>set_memory_limit()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_metal_allocator.html#a179e3127ef9377ce54295f771c34ba1b">mlx::core::metal::MetalAllocator</a></li>
<li>set_output_array()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a6a2e28e542eaa2886041bddd51ff6522">mlx::core::metal::CommandEncoder</a></li>
<li>set_siblings()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a8fccbe7a4edfd8cca168161124e263b1">mlx::core::array</a></li>
<li>set_status()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a63598018999b49f1340b183cb303f05c">mlx::core::array</a></li>
<li>set_tracer()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#af26e6be1a9e6239471a4c24310c0c7c8">mlx::core::array</a></li>
<li>set_value()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a0d077b11f4b28f882b42440b7ac6d40d">mlx::core::Event</a></li>
<li>setBatchSize()&#160;:&#160;<a class="el" href="class_m_p_s_1_1_matrix_multiplication.html#ac24cc7d71cdf3fd5bc4291ba2bfcd9e7">MPS::MatrixMultiplication</a></li>
<li>setBatchStart()&#160;:&#160;<a class="el" href="class_m_p_s_1_1_matrix_multiplication.html#a82008429b4f14b5eba13142886b76cde">MPS::MatrixMultiplication</a></li>
<li>setLeftMatrixOrigin()&#160;:&#160;<a class="el" href="class_m_p_s_1_1_matrix_multiplication.html#a8b905b75090af80d97cf09b05cdad528">MPS::MatrixMultiplication</a></li>
<li>setResultMatrixOrigin()&#160;:&#160;<a class="el" href="class_m_p_s_1_1_matrix_multiplication.html#a86647678c55adffc51114d036445ba10">MPS::MatrixMultiplication</a></li>
<li>setRightMatrixOrigin()&#160;:&#160;<a class="el" href="class_m_p_s_1_1_matrix_multiplication.html#afaa45acd37397737ef4d94e8803be7e2">MPS::MatrixMultiplication</a></li>
<li>shape()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a4a2a2c8a4a5beafd723fc13f2055d55d">mlx::core::array</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#accada8146cb8d3ab7facb4c1e3413ec0">pocketfft::detail::arr_info</a></li>
<li>shutdown()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html#a0c7c29290fde806031c497f24c4ad411">pocketfft::detail::threading::thread_pool</a></li>
<li>siblings()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#acf80fde8f743f65ad5b4be69fcb7a74d">mlx::core::array</a></li>
<li>Sigmoid()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sigmoid.html#a47eca99113ec19f0eb60b6a0472c592b">mlx::core::Sigmoid</a></li>
<li>Sign()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sign.html#afe951e50907bc23a601ec5fa9eae5763">mlx::core::Sign</a></li>
<li>signal()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a65a858445506a61be5889ae0e3651b89">mlx::core::Event</a></li>
<li>signaling_NaN()&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#ad1f76a43c7d51a3765174aa6e0dd9f80">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>simd_exclusive_scan()&#160;:&#160;<a class="el" href="struct_cum_max.html#ae11b67aa6c998e9a01615b2a79af4403">CumMax&lt; U &gt;</a>, <a class="el" href="struct_cum_min.html#a83e65017ff33018b585c043fb803773b">CumMin&lt; U &gt;</a>, <a class="el" href="struct_cum_prod.html#a5b0577295853a48856b84fd4f935dff8">CumProd&lt; U &gt;</a>, <a class="el" href="struct_cum_prod_3_01bool_01_4.html#a1a86e9398bae24182b7be0a6577bf223">CumProd&lt; bool &gt;</a>, <a class="el" href="struct_cum_sum.html#a64d1933942de4df2d44dd90e9e5e4460">CumSum&lt; U &gt;</a></li>
<li>simd_reduce()&#160;:&#160;<a class="el" href="struct_and.html#ab4df5517e050cfa7257c34c6b0bd980b">And&lt; U &gt;</a>, <a class="el" href="struct_max.html#a4f74440c6f1ce8247d5a87c2a8882080">Max&lt; U &gt;</a>, <a class="el" href="struct_min.html#afe8d7cefac624fd4267c1b252ac38528">Min&lt; U &gt;</a>, <a class="el" href="struct_or.html#aef6b5abbbf3fd22981b8d27562022605">Or&lt; U &gt;</a>, <a class="el" href="struct_prod.html#ab0d7a38360b971b4d99c4ad2db310069">Prod&lt; U &gt;</a>, <a class="el" href="struct_sum.html#acf10e0604098391526da3b8271928b5c">Sum&lt; U &gt;</a></li>
<li>simd_scan()&#160;:&#160;<a class="el" href="struct_cum_max.html#adc9ec8bb09b4433d4c2f03022c43d781">CumMax&lt; U &gt;</a>, <a class="el" href="struct_cum_min.html#a0a1005d91b1c90e90e2c6dbd6c296649">CumMin&lt; U &gt;</a>, <a class="el" href="struct_cum_prod.html#a860dbf6146de088d07175bd165b74004">CumProd&lt; U &gt;</a>, <a class="el" href="struct_cum_prod_3_01bool_01_4.html#abeb5ec4237b330e7219f4e881cf10d7a">CumProd&lt; bool &gt;</a>, <a class="el" href="struct_cum_sum.html#a83342af06f6a700067e3b451636852d6">CumSum&lt; U &gt;</a></li>
<li>simple_iter()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1simple__iter.html#a1e455c615825bebd5f1f62665027b398">pocketfft::detail::simple_iter</a></li>
<li>Sin()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sin.html#a10d1ecc0ca96e79cdf55b57073d126ea">mlx::core::Sin</a></li>
<li>sincos_2pibyn()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1sincos__2pibyn.html#a88518f2182d854c557edacd4ab8cbc40">pocketfft::detail::sincos_2pibyn&lt; T &gt;</a></li>
<li>Sinh()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sinh.html#a4a4f6814d403c2ce5d6c574b0dca3c96">mlx::core::Sinh</a></li>
<li>size()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a598f87161926d9e0b516860f0ea2c8f6">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#abd96a09217e3d1bcc522888257d22cef">mlx::core::distributed::Group</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr.html#a95bca00060957f540ff25b69632c6952">pocketfft::detail::arr&lt; T &gt;</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#a003a7106f7fa59a3c55ac1f0116313a5">pocketfft::detail::arr_info</a></li>
<li>Slice()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_slice.html#a8a38feb7bb6b72bdeebb83f053e2fd7f">mlx::core::Slice</a></li>
<li>SliceUpdate()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_slice_update.html#aa30a7f22f557c56e1a2b5fcf44488990">mlx::core::SliceUpdate</a></li>
<li>Softmax()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_softmax.html#a4ec686aac4e06f0dfe2cbd6801af40eb">mlx::core::Softmax</a></li>
<li>sort()&#160;:&#160;<a class="el" href="struct_block_merge_sort.html#acc970f5eb963f7f2010f5ae5ea8b8bc0">BlockMergeSort&lt; val_t, idx_t, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></li>
<li>Sort()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sort.html#a62943032dbd72e85ceb9b4b7211f4a44">mlx::core::Sort</a></li>
<li>sort()&#160;:&#160;<a class="el" href="struct_thread_sort.html#ad9ab3e6b47f7e9b91c0f3b773596986d">ThreadSort&lt; val_t, idx_t, ARG_SORT, N_PER_THREAD, CompareOp &gt;</a></li>
<li>special_mul()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1cmplx.html#a2e79f5c73c1d926361ad126cf57c8874">pocketfft::detail::cmplx&lt; T &gt;</a></li>
<li>split()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1distributed_1_1_group.html#abbf40f8979488806bc5bca9ecc4130e9">mlx::core::distributed::Group</a></li>
<li>Split()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_split.html#a897c746ecfdff5119cc5ae3f20499385">mlx::core::Split</a></li>
<li>Sqrt()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_sqrt.html#a6682a7c31ca427c9d2c5ddb6a479bf29">mlx::core::Sqrt</a></li>
<li>Square()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_square.html#ab94e28d5c92e6febc1c74e525f730dc4">mlx::core::Square</a></li>
<li>start_concurrent()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a48b548a0b15f9d1279c938a1c6167034">mlx::core::metal::CommandEncoder</a></li>
<li>status()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#add41975ba47933af8e74dde0cc646ec4">mlx::core::array</a></li>
<li>StopGradient()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_stop_gradient.html#ac70d1ab819d04e00f76bc25aeebaf84f">mlx::core::StopGradient</a></li>
<li>store_result()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#a85c57ad4092079f068683cb525fb08ee">mlx::steel::BlockMMA&lt; T, U, BM, BN, BK, WM, WN, transpose_a, transpose_b, lda_tgp, ldb_tgp, AccumType, Epilogue &gt;</a></li>
<li>store_result_safe()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#af94bafeb285c240051e86418fccb89fe">mlx::steel::BlockMMA&lt; T, U, BM, BN, BK, WM, WN, transpose_a, transpose_b, lda_tgp, ldb_tgp, AccumType, Epilogue &gt;</a></li>
<li>stream()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a2567b067cb4c7828962363844f67176e">mlx::core::Event</a>, <a class="el" href="classmlx_1_1core_1_1_primitive.html#a46e6257397a662528f9f831842ac456a">mlx::core::Primitive</a></li>
<li>Stream()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_stream.html#a7f0815ff4886da74cbbff5f93d82dd3e">mlx::core::Stream</a></li>
<li>StreamContext()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_stream_context.html#a89d803151e9d7dce29382aa83d5c6ef1">mlx::core::StreamContext</a></li>
<li>StreamThread()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1scheduler_1_1_stream_thread.html#ac528109a11abcb82e6e221c5efa4493c">mlx::core::scheduler::StreamThread</a></li>
<li>stride()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#a9d10aa83a1117e75d36f7396b8c2a093">pocketfft::detail::arr_info</a></li>
<li>stride_in()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#ac947f03b1cfcb63436a7e61ff020a88c">pocketfft::detail::multi_iter&lt; N &gt;</a></li>
<li>stride_out()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#a81d71a13bf0b85e556fbb9834167ecc7">pocketfft::detail::multi_iter&lt; N &gt;</a></li>
<li>strides()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a186cf2648da92584d5c1c8b24e69629b">mlx::core::array</a></li>
<li>submit()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html#a8698d49e8f406cdb88006aac6a91f9a4">pocketfft::detail::threading::thread_pool</a></li>
<li>Subtract()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_subtract.html#a834854757394f8de7082af65bf86ed9c">mlx::core::Subtract</a></li>
<li>SVD()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_s_v_d.html#ae89ff583e34fa894cccb8e7a475ee6d1">mlx::core::SVD</a></li>
<li>swizzle()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_swizzle.html#a98e558d63826d2aaa06d3e65a06d2760">mlx::steel::BlockSwizzle</a></li>
</ul>
</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>