mlx/docs/build/html/functions_i.html

154 lines
24 KiB
HTML
Raw Normal View History

2024-10-15 23:12:17 +08:00
<!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"/>
2025-02-07 04:16:29 +08:00
<meta name="generator" content="Doxygen 1.13.2"/>
2024-10-15 23:12:17 +08:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: Class 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"/>
2025-01-10 05:56:20 +08:00
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
2024-10-15 23:12:17 +08:00
<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>
2025-01-10 05:56:20 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
2024-10-15 23:12:17 +08:00
<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>
2025-01-10 05:56:20 +08:00
<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>
2024-10-15 23:12:17 +08:00
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08:00
<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 -->
2025-01-10 05:56:20 +08:00
<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>
2024-10-15 23:12:17 +08:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2025-01-10 05:56:20 +08:00
$(function(){initNavTree('functions_i.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
</script>
2025-01-10 05:56:20 +08:00
<div id="doc-content">
2024-10-15 23:12:17 +08:00
<!-- 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 class members with links to the classes they belong to:</div>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
2025-02-07 04:16:29 +08:00
<li>i&#160;:&#160;<a class="el" href="unionbool4__or__uint.html#ab24d95aaf4203ddf3e6b1ed19397ced7">bool4_or_uint</a>, <a class="el" href="structpocketfft_1_1detail_1_1cmplx.html#a35d2dce1b7de5f37d7029e639bc7f23d">pocketfft::detail::cmplx&lt; T &gt;</a></li>
2024-10-15 23:12:17 +08:00
<li>id()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#adfa53f3f26bb0f942fb1c67ec8cd5380">mlx::core::array</a></li>
<li>idil&#160;:&#160;<a class="el" href="struct_m_l_x_conv_params.html#af900fdb4c4d4ea35eed02940dee8d4d1">MLXConvParams&lt; NDIM &gt;</a></li>
2025-02-07 04:16:29 +08:00
<li>IdxT&#160;:&#160;<a class="el" href="struct_kernel_merge_sort.html#a587b32e6748cffd2ace5a70b8c59dee4">KernelMergeSort&lt; T, U, ARG_SORT, BLOCK_THREADS, N_PER_THREAD, CompareOp &gt;</a></li>
2024-10-19 03:13:44 +08:00
<li>Imag()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_imag.html#a284b7de34a316110fdc98e7b753372b2">mlx::core::Imag</a></li>
2024-10-15 23:12:17 +08:00
<li>imag&#160;:&#160;<a class="el" href="structcomplex64__t.html#a94037c0cf8451aaff7cb4d154a8426de">complex64_t</a></li>
2025-01-10 05:56:20 +08:00
<li>import_function&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_imported_function.html#a65f83405a292831a6fb2073a7db6fb90">mlx::core::ImportedFunction</a></li>
2024-10-15 23:12:17 +08:00
<li>in&#160;:&#160;<a class="el" href="struct_read_writer.html#ab6057215920138f28fd00f0e7ea8afa4">ReadWriter&lt; in_T, out_T, step, four_step_real &gt;</a></li>
2025-01-10 05:56:20 +08:00
<li>in_dynamic_tracing()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#af7780f0017267567ad6e5c9271e8933e">mlx::core::detail::InTracing</a></li>
<li>in_strides&#160;:&#160;<a class="el" href="struct_m_l_x_conv_params.html#a98e0b625974a98512b63b8a00bd8df5f">MLXConvParams&lt; NDIM &gt;</a></li>
2024-10-15 23:12:17 +08:00
<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>
2025-02-07 04:16:29 +08:00
<li>index&#160;:&#160;<a class="el" href="struct_looped_elem_to_loc.html#acbd070b3193d9e87fb2c2db8db571333">LoopedElemToLoc&lt; DIM, OffsetT, General &gt;</a>, <a class="el" href="struct_looped_elem_to_loc.html#acbd070b3193d9e87fb2c2db8db571333">LoopedElemToLoc&lt; 1, OffsetT, false &gt;</a>, <a class="el" href="struct_looped_elem_to_loc_3_011_00_01_offset_t_00_01true_01_4.html#a2cd3b616739b3d5b41e5b46ae335957d">LoopedElemToLoc&lt; 1, OffsetT, true &gt;</a>, <a class="el" href="structmlx_1_1core_1_1_device.html#a5e345748fe318a267833ab7398b364ac">mlx::core::Device</a>, <a class="el" href="structmlx_1_1core_1_1_stream.html#a9d0dafc1899333e1176eb2bbc0a8b626">mlx::core::Stream</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>, <a class="el" href="structmlx_1_1core_1_1numeric__limits_3_01bfloat16__t_01_4.html#a974982399d0211786599526abdb843b8">mlx::core::numeric_limits&lt; bfloat16_t &gt;</a>, <a class="el" href="structmlx_1_1core_1_1numeric__limits_3_01float16__t_01_4.html#a2a8f3f489b47b7e8398bec9895ae0c27">mlx::core::numeric_limits&lt; float16_t &gt;</a></li>
<li>init&#160;:&#160;<a class="el" href="struct_cum_max.html#a16480052a2eeb4340e546838aab59cc4">CumMax&lt; U &gt;</a>, <a class="el" href="struct_cum_min.html#a8b67f739c620d0cc194b533190990ab9">CumMin&lt; U &gt;</a>, <a class="el" href="struct_cum_prod_3_01bool_01_4.html#ae7a8b0ba9e6898356b87b18766e76d2c">CumProd&lt; bool &gt;</a>, <a class="el" href="struct_less_than.html#abf97a6b0163048e4ba96460939dbd3a3">LessThan&lt; T &gt;</a></li>
2025-01-10 05:56:20 +08:00
<li>inner_looper&#160;:&#160;<a class="el" href="struct_looped_elem_to_loc.html#a8fbe77b4a774a30af5734dd9c5bd1f40">LoopedElemToLoc&lt; DIM, OffsetT, General &gt;</a>, <a class="el" href="struct_looped_elem_to_loc.html#a8fbe77b4a774a30af5734dd9c5bd1f40">LoopedElemToLoc&lt; 1, OffsetT, false &gt;</a>, <a class="el" href="struct_looped_elem_to_loc.html#a8fbe77b4a774a30af5734dd9c5bd1f40">LoopedElemToLoc&lt; 1, OffsetT, true &gt;</a></li>
2024-10-15 23:12:17 +08:00
<li>inp_jump_c&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_implicit_gemm_conv2_d_params.html#a78d30e843d65d1829623afb0b607f0a5">mlx::steel::ImplicitGemmConv2DParams</a></li>
<li>inp_jump_h&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_implicit_gemm_conv2_d_params.html#a03685a4066cdb11ffb647408e2c5b122">mlx::steel::ImplicitGemmConv2DParams</a></li>
<li>inp_jump_w&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_implicit_gemm_conv2_d_params.html#acf168c72f4a86b72b8f5f386f07c9d8c">mlx::steel::ImplicitGemmConv2DParams</a></li>
2025-01-10 05:56:20 +08:00
<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_1_command_encoder.html#a27ded7e54bc1712063c874646b445509">mlx::core::CommandEncoder</a>, <a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a27ded7e54bc1712063c874646b445509">mlx::core::metal::CommandEncoder</a></li>
2024-10-26 04:23:45 +08:00
<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>
2025-01-10 05:56:20 +08:00
<li>InTracing()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1detail_1_1_in_tracing.html#a6beb74f83bde21734ab46b8d999b3b0b">mlx::core::detail::InTracing</a></li>
2024-10-15 23:12:17 +08:00
<li>inv&#160;:&#160;<a class="el" href="struct_read_writer.html#a773fa8524515bdc2ff8b0e2060741813">ReadWriter&lt; in_T, out_T, step, four_step_real &gt;</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&#160;:&#160;<a class="el" href="struct_m_l_x_conv_params.html#a72e1c3b4da0f70622cf18036bbf97fe6">MLXConvParams&lt; NDIM &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>
2025-02-15 05:44:39 +08:00
<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_bitwise_invert.html#a22457fe46135c2df426b89cc15b1f940">mlx::core::BitwiseInvert</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_broadcast_axes.html#a44d14b22b995e643cb04cc43654d7b16">mlx::core::BroadcastAxes</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_contiguous.html#aa5d273a461fc6e64f3c9a67c24cb3372">mlx::core::Contiguous</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_dynamic_slice.html#a0325271def8d9ea9ed21eb27e51994b4">mlx::core::DynamicSlice</a>, <a class="el" href="classmlx_1_1core_1_1_dynamic_slice_update.html#ae6292d2b1f3221a7c8ef6b77cb466481">mlx::core::DynamicSliceUpdate</a>, <a class="el" href="classmlx_1_1core_1_1_eigh.html#a09414e3fe88a952408d164d6dd0af381">mlx::core::Eigh</a>, <a class="el" href="
2024-10-15 23:12:17 +08:00
<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>
<li>iterator_category&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_array_iterator.html#a2cbf481e39164245668b3be6cbcc614d">mlx::core::array::ArrayIterator</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
2025-01-10 05:56:20 +08:00
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
2025-02-07 04:16:29 +08:00
<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>
2025-01-10 05:56:20 +08:00
</ul>
</div>
2024-10-15 23:12:17 +08:00
</body>
</html>