mlx/docs/build/html/functions_d.html

152 lines
16 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_d.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_d" name="index_d"></a>- d -</h3><ul>
2024-11-23 04:24:16 +08:00
<li>D&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_attn_params.html#a07ae31628e43e09bce533c7682c8dae3">mlx::steel::AttnParams</a></li>
2024-12-07 05:22:39 +08:00
<li>d&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_data.html#a0534c6fb5dfbd7fcf1d6269fac3c1e9e">mlx::core::array::Data</a>, <a class="el" href="classpocketfft_1_1detail_1_1cndarr.html#ac29c769aebb03f81fbcf16ba6e766af2">pocketfft::detail::cndarr&lt; T &gt;</a></li>
<li>Data()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_data.html#a123d7c1738773dedfc9db075fdd7062d">mlx::core::array::Data</a></li>
2024-10-15 23:12:17 +08:00
<li>data()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a72e3ce6c03fefe272cadf214bd127b95">mlx::core::array</a>, <a class="el" href="classpocketfft_1_1detail_1_1arr.html#aec0f2191b4663b4187aab92454c34de8">pocketfft::detail::arr&lt; T &gt;</a></li>
<li>data_shared_ptr()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#ab84c792117e29cdf90ef3433303f6141">mlx::core::array</a></li>
<li>data_size()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#afaf2a370fa35d96af1b27a4b814e3bfd">mlx::core::array</a></li>
<li>deallocate()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1threading_1_1aligned__allocator.html#a2a99b8e296d26b255e9937ba5f30e76f">pocketfft::detail::threading::aligned_allocator&lt; T &gt;</a></li>
<li>default_()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1random_1_1_key_sequence.html#ab5993daeed822c6b970caddab7e3fd90">mlx::core::random::KeySequence</a></li>
2025-01-10 05:56:20 +08:00
<li>DEFINE_INPUT_OUTPUT_SHAPE()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_layer_norm.html#afd0818925ffea79f4e3dda0dd8cf0366">mlx::core::fast::LayerNorm</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_r_m_s_norm.html#a2965dbda1bed67128e97c3c5d864c82f">mlx::core::fast::RMSNorm</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_ro_p_e.html#a361cc8e0e56ff45ec98dbf81ed8eff2c">mlx::core::fast::RoPE</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_scaled_dot_product_attention.html#a64d2ce4b46b529a6a9ef068947bc623e">mlx::core::fast::ScaledDotProductAttention</a></li>
2024-10-15 23:12:17 +08:00
<li>DEFINE_PRINT()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#a8af1e90d4aa56f31ec40ad152ebd2421">mlx::core::distributed::AllGather</a>, <a class="el" href="classmlx_1_1core_1_1distributed_1_1_recv.html#a7a0cad13da7cf8e565934318a2bc34f1">mlx::core::distributed::Recv</a>, <a class="el" href="classmlx_1_1core_1_1distributed_1_1_send.html#a31bf76e24cf3836cf1fd26da30712e31">mlx::core::distributed::Send</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_affine_quantize.html#a4b8f1b1f633002c8ca6fa8f0ef4dd587">mlx::core::fast::AffineQuantize</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_custom_kernel.html#a116ecf31c8672c94e5ea06c1d43e9534">mlx::core::fast::CustomKernel</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_layer_norm.html#a467fcf02b3ddf1d8b6d476b244ae3568">mlx::core::fast::LayerNorm</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_layer_norm_v_j_p.html#a5ab3eb5402c7e8060916056eb2b7887f">mlx::core::fast::LayerNormVJP</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_r_m_s_norm.html#ae6eea81b5e3789c2f6f376cc07f0a47c">mlx::core::fast::RMSNorm</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_r_m_s_norm_v_j_p.html#a9895733eab845e11484d86cf6ecedced">mlx::core::fast::RMSNormVJP</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_ro_p_e.html#a2b06fe64fa8feca65140632087065e16">mlx::core::fast::RoPE</a>, <a class="el" href="classmlx_1_1core_1_1fast_1_1_scaled_dot_product_attention.html#a6cc2092fa5b8e7585921b8e0f3ec3db7">mlx::core::fast::ScaledDotProductAttention</a></li>
<li>denorm_min()&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#a6a9dbcba4dd79cad50876dda506b9eed">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>Depends()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_depends.html#a4ccb792c99f5d8d133d3fac29f7d3f62">mlx::core::Depends</a></li>
<li>detach()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a84948c29df8c957904919c8602692bd2">mlx::core::array</a></li>
<li>Device()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_device.html#a481ccfb94d689994396bd353e966b489">mlx::core::Device</a>, <a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#ae0db74570eb4b19d8cf19774db91bfd6">mlx::core::metal::Device</a></li>
<li>device()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_primitive.html#a8ae61e3289c4134232a69295268f8261">mlx::core::Primitive</a>, <a class="el" href="structmlx_1_1core_1_1_stream.html#a406b1b0162287a4162fab1f70e2ff3bb">mlx::core::Stream</a></li>
2024-10-26 04:23:45 +08:00
<li>DeviceStream()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1metal_1_1_device_stream.html#a573326bc8b48e39076850c7bf52ad0d7">mlx::core::metal::DeviceStream</a></li>
2024-10-15 23:12:17 +08:00
<li>DeviceType&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_device.html#ac45b3de9b3458d8f31005136cde20fdb">mlx::core::Device</a></li>
<li>difference_type&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_array_iterator.html#adcee44c77980fc2370a2c31e203aead5">mlx::core::array::ArrayIterator</a></li>
<li>digits&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#af6a681edff230c8d734a1feefb8d1879">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
<li>digits10&#160;:&#160;<a class="el" href="structmetal_1_1__numeric__limits__impl_3_01bfloat16__t_01_4.html#a0f48dd0c8a2d2dfa825067fb212b2e6b">metal::_numeric_limits_impl&lt; bfloat16_t &gt;</a></li>
2025-02-07 04:16:29 +08:00
<li>dim&#160;:&#160;<a class="el" href="struct_looped_elem_to_loc.html#af8285112846769aba2c0d8615f6f1364">LoopedElemToLoc&lt; DIM, OffsetT, General &gt;</a>, <a class="el" href="struct_looped_elem_to_loc.html#af8285112846769aba2c0d8615f6f1364">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#a7be6bf560080472d61e74b522979ef1e">LoopedElemToLoc&lt; 1, OffsetT, true &gt;</a></li>
2025-01-10 05:56:20 +08:00
<li>dispatch_threadgroups()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_command_encoder.html#a85796b2bf41dbf347ae0978d4660600d">mlx::core::CommandEncoder</a>, <a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a85796b2bf41dbf347ae0978d4660600d">mlx::core::metal::CommandEncoder</a></li>
<li>dispatch_threads()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_command_encoder.html#a0a8501b940e5a347475fa4bc38fb4c05">mlx::core::CommandEncoder</a>, <a class="el" href="structmlx_1_1core_1_1metal_1_1_command_encoder.html#a0a8501b940e5a347475fa4bc38fb4c05">mlx::core::metal::CommandEncoder</a></li>
2024-10-15 23:12:17 +08:00
<li>DistPrimitive()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_dist_primitive.html#a8c54166951522c2a52ef39fce8c87f8f">mlx::core::distributed::DistPrimitive</a></li>
<li>Divide()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_divide.html#a62fc71e8998be65ff18285dbbd21eedb">mlx::core::Divide</a></li>
<li>DivMod()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_div_mod.html#a859e3b6149cdceab1c7ccfd2246fb826">mlx::core::DivMod</a></li>
<li>do_read&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader.html#a13eb86acf6abe288c19645935a47d2ad">mlx::steel::Conv2DWeightBlockLoader&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader_small_channels.html#a640155880483e1042ec5f647b9adaac6">mlx::steel::Conv2DWeightBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a></li>
2024-11-23 04:24:16 +08:00
<li>dst&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_loader.html#af1c6c35a42e9da4408c1013ff1741bc2">mlx::steel::BlockLoader&lt; T, BROWS, BCOLS, dst_ld, reduction_dim, tgp_size, alignment, n_reads, TCOLS, TROWS &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_block_loader_t.html#a6eb4e566b687395e27f290da288362db">mlx::steel::BlockLoaderT&lt; T, BROWS, BCOLS, kDstStrRow, kDstStrCol, reduction_dim, tgp_size, n_reads, TCOLS, TROWS &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_general.html#aa84c4ad43a5defb83ba1a5f49a7adb2a">mlx::steel::Conv2DInputBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_large_filter.html#ae048eb79f8b8d98f0fe8805c30fbb09f">mlx::steel::Conv2DInputBlockLoaderLargeFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_channels.html#a59a4fffc1dc2f3fadfb3fdd1b886da70">mlx::steel::Conv2DInputBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_filter.html#a8598bf23a2bce6af13c876cbfa76449f">mlx::steel::Conv2DInputBlockLoaderSmallFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader.html#aea6494838175225d02cbc7768a646ec7">mlx::steel::Conv2DWeightBlockLoader&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader_general.html#a8474daf268013e138a84fc1c4bff7352">mlx::steel::Conv2DWeightBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader_small_channels.html#a24e20e4c1dd1ebf9534bfa2b3e050ed3">mlx::steel::Conv2DWeightBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a>, <a class="el" href="struct_quantized_block_loader.html#a9857214690fe6abad0e19d1045152f83">QuantizedBlockLoader&lt; T, BROWS, BCOLS, dst_ld, reduction_dim, tgp_size, group_size, bits &gt;</a></li>
2024-10-15 23:12:17 +08:00
<li>dst_ld&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_general.html#a07c85eab8cbf7b02c60df29cf32031ef">mlx::steel::Conv2DInputBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_large_filter.html#a91192d512e7a18c2d16a139065000959">mlx::steel::Conv2DInputBlockLoaderLargeFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_channels.html#ae71570942c7b0ad8e67c62662b336c4a">mlx::steel::Conv2DInputBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_input_block_loader_small_filter.html#a9e59da7e4436e61b2d3c3f982355910b">mlx::steel::Conv2DInputBlockLoaderSmallFilter&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader.html#a0ff5a6d503e0bbac4634030a75ab818d">mlx::steel::Conv2DWeightBlockLoader&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader_general.html#aae121ca6016fc6c7255027b3641f3a09">mlx::steel::Conv2DWeightBlockLoaderGeneral&lt; T, BM, BN, BK, tgp_size, tgp_padding &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_conv2_d_weight_block_loader_small_channels.html#ac18eeebea26cc6da434ead6eb4397350">mlx::steel::Conv2DWeightBlockLoaderSmallChannels&lt; T, BM, BN, BK, tgp_size, n_channels, tgp_padding &gt;</a></li>
<li>Dtype()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1_dtype.html#aec17f0a4a51729e5ac40b62f0aa765d1">mlx::core::Dtype</a></li>
2025-01-10 05:56:20 +08:00
<li>dtype()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#ae29e7d6fbfbea1e5e321a8d1ea3cfacd">mlx::core::array</a>, <a class="el" href="structmlx_1_1core_1_1finfo.html#a4edcbcfae55c1ef3cb8e61d427ac9124">mlx::core::finfo</a></li>
<li>DynamicSlice()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_dynamic_slice.html#a97f23f7d45b69219dee1a208d9a3063b">mlx::core::DynamicSlice</a></li>
<li>DynamicSliceUpdate()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_dynamic_slice_update.html#a16bbd8d756598cf620e3b3c95dd23213">mlx::core::DynamicSliceUpdate</a></li>
2024-10-15 23:12:17 +08:00
</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>