mlx/docs/build/html/functions_func_i.html
CircleCI Docs c996fc9d45 rebase
2025-06-04 01:01:53 +00:00

118 lines
17 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: 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>
<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>
</div><!-- top -->
<div id="doc-content">
<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 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_i" name="index_i"></a>- i -</h3><ul>
<li>id()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#adfa53f3f26bb0f942fb1c67ec8cd5380">mlx::core::array</a></li>
<li>Imag()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_imag.html#a284b7de34a316110fdc98e7b753372b2">mlx::core::Imag</a></li>
<li>in_tracing()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#ac52b8e2c3f808d3076c4e1ebaf9dc63d">mlx::core::detail::InTracing</a></li>
<li>increment_command_buffer_ops()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#a7a33d4d601423a3d3c23d5ad7072abb6">mlx::core::metal::Device</a></li>
<li>infinity()&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#a61eb741e7af49046beb863abf023b206">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>inputs()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a2913abcdf71826827c8457f529825fff">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a27ded7e54bc1712063c874646b445509">mlx::core::metal::CommandEncoder</a></li>
<li>insert()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_residency_set.html#aaafe1a4305a107d4bcdd4f35d3df09b3">mlx::core::metal::ResidencySet</a></li>
<li>InTracing()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a7a77f19391498afa5dcea3509d241a70">mlx::core::detail::InTracing</a></li>
<li>Inverse()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_inverse.html#a71467681e523abb725724490bfeb76ad">mlx::core::Inverse</a></li>
<li>iofs()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#ad33360d4a8ab8e6d72efadc6f9cb5bfa">pocketfft::detail::multi_iter&lt; N &gt;</a></li>
<li>is_available()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#aebed1f37c19197be76105161102a8a40">mlx::core::array</a></li>
<li>is_donatable()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a4677a404b5d191af20b52649225de087">mlx::core::array</a></li>
<li>is_equivalent()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_abs.html#ab6f0ec56bc7c048382297e12dabadc67">mlx::core::Abs</a>, <a class="el" href="classmlx_1_1core_1_1_add.html#aba0a35410c3aac53d0f7a0c283d9ee3f">mlx::core::Add</a>, <a class="el" href="classmlx_1_1core_1_1_add_m_m.html#a6e37c6882dba995a63fb6d8dfb01754f">mlx::core::AddMM</a>, <a class="el" href="classmlx_1_1core_1_1_arange.html#a7b6a45cf9c4b109d4e0373f3fe576c35">mlx::core::Arange</a>, <a class="el" href="classmlx_1_1core_1_1_arc_cos.html#a39557461e3235801886675a9b7d25bf5">mlx::core::ArcCos</a>, <a class="el" href="classmlx_1_1core_1_1_arc_cosh.html#a6928e827b9ac2e86e7d5b02b78150eee">mlx::core::ArcCosh</a>, <a class="el" href="classmlx_1_1core_1_1_arc_sin.html#a13b5e39eeccaf32d94b8eb85b3b753ab">mlx::core::ArcSin</a>, <a class="el" href="classmlx_1_1core_1_1_arc_sinh.html#a63c7a765c7906242dc3371deec094f0f">mlx::core::ArcSinh</a>, <a class="el" href="classmlx_1_1core_1_1_arc_tan2.html#aeaee58cd803d3ebf0b76574a409682cc">mlx::core::ArcTan2</a>, <a class="el" href="classmlx_1_1core_1_1_arc_tan.html#a0e5b5fc7218143ecd0a8666d9137c34c">mlx::core::ArcTan</a>, <a class="el" href="classmlx_1_1core_1_1_arc_tanh.html#ac8ecdd640043dab0461d49d7650679a2">mlx::core::ArcTanh</a>, <a class="el" href="classmlx_1_1core_1_1_arg_partition.html#ad87509ce70b51fb75dfb9c3a05a5b31a">mlx::core::ArgPartition</a>, <a class="el" href="classmlx_1_1core_1_1_arg_reduce.html#a03b81a670dcb1e39bf7279e4d4583b97">mlx::core::ArgReduce</a>, <a class="el" href="classmlx_1_1core_1_1_arg_sort.html#a048cd09c557d29d1111726f97010a845">mlx::core::ArgSort</a>, <a class="el" href="classmlx_1_1core_1_1_as_strided.html#a1738c6aa0a3a3eb68530f0d5b436e094">mlx::core::AsStrided</a>, <a class="el" href="classmlx_1_1core_1_1_as_type.html#a8e6c8b2428ab15c4fb43f2e3a8fb38af">mlx::core::AsType</a>, <a class="el" href="classmlx_1_1core_1_1_bitwise_binary.html#a8cd6b916b4838a6c329cf4df8530c3b8">mlx::core::BitwiseBinary</a>, <a class="el" href="classmlx_1_1core_1_1_block_masked_m_m.html#aef1c303955f9b8f445296372cf181160">mlx::core::BlockMaskedMM</a>, <a class="el" href="classmlx_1_1core_1_1_broadcast.html#a0e27692b0090ec451954649a36042616">mlx::core::Broadcast</a>, <a class="el" href="classmlx_1_1core_1_1_ceil.html#aacd90acb56eb0649c1cef807aa21df52">mlx::core::Ceil</a>, <a class="el" href="classmlx_1_1core_1_1_compiled.html#a63e5016458887813b4a59dee5a0a3f10">mlx::core::Compiled</a>, <a class="el" href="classmlx_1_1core_1_1_concatenate.html#aaf8a72a0c30114460caf519580cc35d2">mlx::core::Concatenate</a>, <a class="el" href="classmlx_1_1core_1_1_conjugate.html#af42f00a790c6bc5572bd8fe9e5b36c5e">mlx::core::Conjugate</a>, <a class="el" href="classmlx_1_1core_1_1_convolution.html#afb87708a5e3aab2e9e663daa9d8863de">mlx::core::Convolution</a>, <a class="el" href="classmlx_1_1core_1_1_copy.html#afcfa39465015f638e294aa954ea0f3da">mlx::core::Copy</a>, <a class="el" href="classmlx_1_1core_1_1_cos.html#ab611ca38c987915659f7ffcce0370417">mlx::core::Cos</a>, <a class="el" href="classmlx_1_1core_1_1_cosh.html#ae0bacccaf501f5349db0c13cca776ff9">mlx::core::Cosh</a>, <a class="el" href="classmlx_1_1core_1_1_divide.html#a3dda091f05c4164c29bb8129e9712650">mlx::core::Divide</a>, <a class="el" href="classmlx_1_1core_1_1_div_mod.html#af5fcf8ec8515d46844cbeeab6dafb38a">mlx::core::DivMod</a>, <a class="el" href="classmlx_1_1core_1_1_eigh.html#a09414e3fe88a952408d164d6dd0af381">mlx::core::Eigh</a>, <a class="el" href="classmlx_1_1core_1_1_equal.html#a58c1c5003e43f47dc0788c1851deaa02">mlx::core::Equal</a>, <a class="el" href="classmlx_1_1core_1_1_erf.html#abe99dfbc2954c3a7d5dec56ab165ee82">mlx::core::Erf</a>, <a class="el" href="classmlx_1_1core_1_1_erf_inv.html#aaac9e3b454ba564f9c6e804ab6562832">mlx::core::ErfInv</a>, <a class="el" href="classmlx_1_1core_1_1_exp.html#ac6e44bffe7a643ab4ca51e74c7328357">mlx::core::Exp</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_scaled_dot_product_attention.html#af08b1294f3f93505a96fdfa85b1edd62">mlx::core::fast::ScaledDotProductAttention</a>, <a class="el" href="classmlx_1_1core_1_1_f_f_t.html#a0ede3bc8b6d77d560c0a750b68fddc06">mlx::core::FFT</a>, <a class="el" href="classmlx_1_1core_1_1_floor.html#a24b64feb026c4fcd02fc481cffdb1c94">mlx::core::Floor</a>, <a class="el" href="classmlx_1_1core_1_1_full.html#afafcbcae1e28597fe8f7fde289105792">mlx::core::Full</a>, <a class="el" href="classmlx_1_1core_1_1_gather.html#a23ff1406dbf0c770e75ad47440b467aa">mlx::core::Gather</a>, <a class="el" href="classmlx_1_1core_1_1_gather_m_m.html#a163f17f6ce2c002f22e81b302777342b">mlx::core::GatherMM</a>, <a class="el" href="classmlx_1_1core_1_1_gather_q_m_m.html#a6a7da6bcf657fcdb157c45bf35fdec11">mlx::core::GatherQMM</a>, <a class="el" href="classmlx_1_1core_1_1_greater.html#a6877a6888614a618dc64296763ccabb1">mlx::core::Greater</a>, <a class="el" href="classmlx_1_1core_1_1_greater_equal.html#a3daef8596b963026b602019bc56fc5fc">mlx::core::GreaterEqual</a>, <a class="el" href="classmlx_1_1core_1_1_hadamard.html#a8a528d8d69a7343bdfd704a3e74230b8">mlx::core::Hadamard</a>, <a class="el" href="classmlx_1_1core_1_1_imag.html#a51c15ae82855edebba2ba779516465f5">mlx::core::Imag</a>, <a class="el" href="classmlx_1_1core_1_1_less.html#a7d6ed6353a0dcefebd008026dbd3cd63">mlx::core::Less</a>, <a class="el" href="classmlx_1_1core_1_1_less_equal.html#a76ee1438cf4bd109eae4e0b3472b26af">mlx::core::LessEqual</a>, <a class="el" href="classmlx_1_1core_1_1_log.html#a2fc58ea4ca744db493b947d1136d05f8">mlx::core::Log</a>, <a class="el" href="classmlx_1_1core_1_1_log_add_exp.html#a3cf9a202c05aff39919d713d6e2b32e4">mlx::core::LogAddExp</a>, <a class="el" href="classmlx_1_1core_1_1_logical_and.html#a9572c35f72e0db2f7f86bbf42438a6be">mlx::core::LogicalAnd</a>, <a class="el" href="classmlx_1_1core_1_1_logical_not.html#aba53675da351cd9b71a73d475b4bbe99">mlx::core::LogicalNot</a>, <a class="el" href="classmlx_1_1core_1_1_logical_or.html#a9c8b10a5cf5c69fdc2362390197e4e71">mlx::core::LogicalOr</a>, <a class="el" href="classmlx_1_1core_1_1_matmul.html#aab372b59eae0840fc4f75ef5719a2630">mlx::core::Matmul</a>, <a class="el" href="classmlx_1_1core_1_1_maximum.html#a21fe93fbd7799682f481260aee8bdb46">mlx::core::Maximum</a>, <a class="el" href="classmlx_1_1core_1_1_minimum.html#a56c54ee3293cc2cd84462b9ec7ac36b4">mlx::core::Minimum</a>, <a class="el" href="classmlx_1_1core_1_1_multiply.html#ae288159fa2d6d35087a85aca8eafa9b2">mlx::core::Multiply</a>, <a class="el" href="classmlx_1_1core_1_1_negative.html#ac2a4d8159c548639d6289980c8975823">mlx::core::Negative</a>, <a class="el" href="classmlx_1_1core_1_1_not_equal.html#ac12fd6b3e2f2e7e4e622b59badf2c73d">mlx::core::NotEqual</a>, <a class="el" href="classmlx_1_1core_1_1_number_of_elements.html#ad6a32565ccc64499e368e15bba0b438f">mlx::core::NumberOfElements</a>, <a class="el" href="classmlx_1_1core_1_1_pad.html#aad7c3bfecafe435d6a8e807de4c7ea9b">mlx::core::Pad</a>, <a class="el" href="classmlx_1_1core_1_1_partition.html#aabdf6ef4f2159b2bfe93e0e87d4772f8">mlx::core::Partition</a>, <a class="el" href="classmlx_1_1core_1_1_power.html#a76b4ec9d1ff07f06189e414480453d68">mlx::core::Power</a>, <a class="el" href="classmlx_1_1core_1_1_primitive.html#a6140a502af4c2bbbc776ab26e9afebcd">mlx::core::Primitive</a>, <a class="el" href="classmlx_1_1core_1_1_quantized_matmul.html#af28b36e3f40ea41785387800326cc8e1">mlx::core::QuantizedMatmul</a>, <a class="el" href="classmlx_1_1core_1_1_random_bits.html#a72ec915debf5823e7c0463045b2894e6">mlx::core::RandomBits</a>, <a class="el" href="classmlx_1_1core_1_1_real.html#a6d9bed396862a9e9d6abfbdcd8d8d239">mlx::core::Real</a>, <a class="el" href="classmlx_1_1core_1_1_reduce.html#abe8f3327d617d0dd7438f066497ae08e">mlx::core::Reduce</a>, <a class="el" href="classmlx_1_1core_1_1_remainder.html#a802039faaa2ed7b763ec3d7debcce814">mlx::core::Remainder</a>, <a class="el" href="classmlx_1_1core_1_1_reshape.html#abd07c53af476777a04307e0423784cf3">mlx::core::Reshape</a>, <a class="el" href="classmlx_1_1core_1_1_round.html#aeb3d8607bbba7345a3142d4cbd4e6927">mlx::core::Round</a>, <a class="el" href="classmlx_1_1core_1_1_scan.html#a54445a4d677ca4fe2a58d08eb5223ac6">mlx::core::Scan</a>, <a class="el" href="classmlx_1_1core_1_1_scatter.html#a0208172562abdc90472e6eb5f84c987f">mlx::core::Scatter</a>, <a class="el" href="classmlx_1_1core_1_1_select.html#afc3c333fac7f902c98839921ef2874c8">mlx::core::Select</a>, <a class="el" href="classmlx_1_1core_1_1_sigmoid.html#a04814ba1b0edf8299d5ca1bcb8749d8e">mlx::core::Sigmoid</a>, <a class="el" href="classmlx_1_1core_1_1_sign.html#a8c0934acbcc4b146e5aacd35a8c445bb">mlx::core::Sign</a>, <a class="el" href="classmlx_1_1core_1_1_sin.html#af00b0e5516f884996ce7a97e6c1e3e6a">mlx::core::Sin</a>, <a class="el" href="classmlx_1_1core_1_1_sinh.html#adcb1878996fd4902cd550042dd6ad70d">mlx::core::Sinh</a>, <a class="el" href="classmlx_1_1core_1_1_slice.html#a43202c3b8966ae1db9ab82072e4918b0">mlx::core::Slice</a>, <a class="el" href="classmlx_1_1core_1_1_slice_update.html#a60f588acced42391e6e5615ae8d16119">mlx::core::SliceUpdate</a>, <a class="el" href="classmlx_1_1core_1_1_softmax.html#a9215ed7bd36bc11276c58dfb9808d728">mlx::core::Softmax</a>, <a class="el" href="classmlx_1_1core_1_1_sort.html#ae48f07cf641d54234fc4fb6529a33511">mlx::core::Sort</a>, <a class="el" href="classmlx_1_1core_1_1_split.html#af25a0cc259573b9dce60d285eee18345">mlx::core::Split</a>, <a class="el" href="classmlx_1_1core_1_1_sqrt.html#ab871c2b8ab4a27a3f782a005d0e87c46">mlx::core::Sqrt</a>, <a class="el" href="classmlx_1_1core_1_1_square.html#a6abc881d44071019aa15481e5ea75ab2">mlx::core::Square</a>, <a class="el" href="classmlx_1_1core_1_1_stop_gradient.html#a327539298b21d800d26482b94fce41b3">mlx::core::StopGradient</a>, <a class="el" href="classmlx_1_1core_1_1_subtract.html#af1c05e1e3f703ba916d54f8ccbbd102b">mlx::core::Subtract</a>, <a class="el" href="classmlx_1_1core_1_1_tan.html#afdf46288e7f60ea7f878688347dff7e4">mlx::core::Tan</a>, <a class="el" href="classmlx_1_1core_1_1_tanh.html#a0692a1de2373b86eb394252ed4fecfda">mlx::core::Tanh</a>, <a class="el" href="classmlx_1_1core_1_1_transpose.html#a799ec3c3fa9f1b9e6177c755252a3eab">mlx::core::Transpose</a>, <a class="el" href="classmlx_1_1core_1_1_uniform.html#abb6048807a7c5b2e35a77e06a17f801b">mlx::core::Uniform</a>, <a class="el" href="classmlx_1_1core_1_1_view.html#a7cb8403a96a47cb258caac4e3b850f64">mlx::core::View</a></li>
<li>is_open()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1io_1_1_file_writer.html#ad5d2ee671a81700cb1658c41309d6676">mlx::core::io::FileWriter</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_parallel_file_reader.html#a653009adbcbce8248bc666df502fdbde">mlx::core::io::ParallelFileReader</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_reader.html#a780f504058bd9c80cb3d105046a9f985">mlx::core::io::Reader</a>, <a class="el" href="classmlx_1_1core_1_1io_1_1_writer.html#a85aa36bdb0dbfb8c5b6cfd955b03417a">mlx::core::io::Writer</a></li>
<li>is_ready()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1threading_1_1latch.html#ab41ecc5adb6187aa2682ca190fd920f3">pocketfft::detail::threading::latch</a></li>
<li>is_signaled()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_event.html#a05a9a3de88185b4a89e154242b4e770a">mlx::core::Event</a></li>
<li>is_tracer()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#af9acb115019b995354d366c4ac6b968c">mlx::core::array</a></li>
<li>item()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a90c5afddc2fa3028c0f8099bd64c8a99">mlx::core::array</a></li>
<li>itemsize()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#af329d9432c92de87cbaa2de8454eefc0">mlx::core::array</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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>