mlx/docs/build/html/functions_a.html
CircleCI Docs c7080f89ca rebase
2025-06-04 01:01:55 +00:00

173 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.13.2"/>
<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"/>
<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('functions_a.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 class members with links to the classes they belong to:</div>
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
<li>a&#160;:&#160;<a class="el" href="struct_max.html#adfee65117dbf49404241861d374b9c4d">Max&lt; U &gt;</a></li>
<li>A_str_k&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#a257287702dc849d0d8a078fced453142">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>A_str_m&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#ab9c7f5386594497f5f4df7e59670b877">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>Abs()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_abs.html#a1247e72feb640fb562d036b2dd1ae4ad">mlx::core::Abs</a></li>
<li>accum_type&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_accum_helper.html#ae52abf69e7ba6af1a73d65d57182ed26">mlx::steel::AccumHelper&lt; T &gt;</a></li>
<li>Add()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_add.html#ae3fd5483f3454eac3df256e3f5f3cdae">mlx::core::Add</a></li>
<li>add_temporaries()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#a72ad17c96fc6ce825bc77f0bed657901">mlx::core::metal::Device</a></li>
<li>add_temporary()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#acb90010af0cffe27fd8cc6c253d3a576">mlx::core::metal::Device</a></li>
<li>AddMM()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_add_m_m.html#a8ae4372b3f96e72e8a5a06d59de8a550">mlx::core::AddMM</a></li>
<li>adj_implicit_m&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_general_jump_params.html#a5bfca3bc43055013d28430cb1f023756">mlx::steel::Conv2DGeneralJumpParams</a></li>
<li>adj_out_h&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_general_jump_params.html#a879cc9757f59605a87d936ec4156040d">mlx::steel::Conv2DGeneralJumpParams</a></li>
<li>adj_out_hw&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_general_jump_params.html#aed0ffd63fbc85fd5d5c4cc7b43f68363">mlx::steel::Conv2DGeneralJumpParams</a></li>
<li>adj_out_w&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_conv2_d_general_jump_params.html#ab971bf879079895189331fbeaf33c211">mlx::steel::Conv2DGeneralJumpParams</a></li>
<li>advance()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1multi__iter.html#a5ddcc0666125b3cb6c0d62b30befdd2c">pocketfft::detail::multi_iter&lt; N &gt;</a>, <a class="el" href="classpocketfft_1_1detail_1_1rev__iter.html#ad1918c84ae963188afc7599629b29686">pocketfft::detail::rev_iter</a>, <a class="el" href="classpocketfft_1_1detail_1_1simple__iter.html#a73a9ecd3008d2bd35aaa00bf9fac074f">pocketfft::detail::simple_iter</a></li>
<li>AffineQuantize()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1fast_1_1_affine_quantize.html#a84d5fa9e8c3de407fbcc5f38d2ed1473">mlx::core::fast::AffineQuantize</a></li>
<li>aligned_allocator()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1threading_1_1aligned__allocator.html#a57c07047ac09c6cf48a269429de2b0fb">pocketfft::detail::threading::aligned_allocator&lt; T &gt;</a></li>
<li>all_gather()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html#a04bb1df23abe5b1f3fa0126375c6cea4">mlx::core::distributed::detail::GroupImpl</a></li>
<li>all_sum()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html#ae163a6f444c6cc8820288b20f294e483">mlx::core::distributed::detail::GroupImpl</a></li>
<li>AllGather()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_gather.html#af4b10a5b61f160fb64353057c185b661">mlx::core::distributed::AllGather</a></li>
<li>allocate()&#160;:&#160;<a class="el" href="structpocketfft_1_1detail_1_1threading_1_1aligned__allocator.html#a4f785747b898980756af9e5515363826">pocketfft::detail::threading::aligned_allocator&lt; T &gt;</a></li>
<li>Allocator()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1allocator_1_1_allocator.html#a5803678a418fef687fc65fa9d5c37b65">mlx::core::allocator::Allocator</a></li>
<li>allocator&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1allocator_1_1_common_allocator.html#abf84c726a37df68345589b897b2e35f0">mlx::core::allocator::CommonAllocator</a>, <a class="el" href="classmlx_1_1core_1_1metal_1_1_metal_allocator.html#afa1c5a725309caff163c492b5b84491e">mlx::core::metal::MetalAllocator</a></li>
<li>AllReduce()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#a2d1ea56cbf72a316680ea90aa6da1c2d">mlx::core::distributed::AllReduce</a></li>
<li>alpha&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_g_e_m_m_add_m_m_params.html#af8693d96512eff3e125d33d203920710">mlx::steel::GEMMAddMMParams</a>, <a class="el" href="structmlx_1_1steel_1_1_transform_axpby.html#ab3223b49c6b3b7f89eba91aeaff9dcff">mlx::steel::TransformAxpby&lt; OutT, InT &gt;</a></li>
<li>And&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_bitwise_binary.html#a6f8b5d455d0c1770428a6bef1608f23dab14e7d426f45ae7f029f4e00210fbae4">mlx::core::BitwiseBinary</a>, <a class="el" href="classmlx_1_1core_1_1distributed_1_1_all_reduce.html#abb4560980e5d01aed14175ce8f6fc924aba3b7fb927f6b6c8b198a9cdc3dd9e02">mlx::core::distributed::AllReduce</a>, <a class="el" href="classmlx_1_1core_1_1_reduce.html#a0848518b16ae6d4043d6be247bdf31c9a5cc3412a1f243dcb11661bca42daea93">mlx::core::Reduce</a></li>
<li>apply()&#160;:&#160;<a class="el" href="struct_div_op.html#a1b8df47142dc6ea15315ce3a310f9221">DivOp</a>, <a class="el" href="struct_exp_sub_op.html#a00e457a01cb38f959dfd789455e7f334">ExpSubOp</a>, <a class="el" href="struct_max_op.html#ab3d3c3040017a13c170e7bdd1ffac46e">MaxOp</a>, <a class="el" href="structmlx_1_1steel_1_1_transform_add.html#afbb688d84443fd622b4dd2768cfe0acf">mlx::steel::TransformAdd&lt; OutT, InT &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_transform_axpby.html#a14ad48b0189d6bdde06c66f1b567ae87">mlx::steel::TransformAxpby&lt; OutT, InT &gt;</a>, <a class="el" href="structmlx_1_1steel_1_1_transform_none.html#a84daa89be5b3348b5715bf8c5a01da75">mlx::steel::TransformNone&lt; OutT, InT &gt;</a>, <a class="el" href="struct_mul_op.html#a1b93d804653d92fc7e46747de9e9c756">MulOp</a>, <a class="el" href="struct_scale_op.html#a69f82bc925843a4e1c14dfe8ad2f3218">ScaleOp&lt; OutT, InT &gt;</a>, <a class="el" href="struct_sub_op.html#ad211f879a212ed0e98136217ca8e4143">SubOp</a>, <a class="el" href="struct_sum_op.html#aa9563a98cbbe1b1921ade0c63ab38b4d">SumOp</a>, <a class="el" href="struct_transform_scale.html#a9dd329422e5b8da43486cdce17132e16">TransformScale&lt; T &gt;</a></li>
<li>apply_epilogue()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#af653c0808ba4fa9a25286f1febb7baff">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>apply_epilogue_safe()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#a9e48f2d51099ec00171506724faab54a">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>apply_inplace_op()&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_loader.html#adb4ca2cc193630a779de552fa8847ddf">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#a2b136fad00dc54300e68aa6b905eff97">mlx::steel::BlockLoaderT&lt; T, BROWS, BCOLS, kDstStrRow, kDstStrCol, reduction_dim, tgp_size, n_reads, TCOLS, TROWS &gt;</a></li>
<li>Arange()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arange.html#a1a70c3b0b9c67d5a9446c141c5b7c574">mlx::core::Arange</a></li>
<li>ArcCos()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_cos.html#a66f4ee841d17923d93241b71ea5103e9">mlx::core::ArcCos</a></li>
<li>ArcCosh()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_cosh.html#a34597054db467941a2a883c653ba4d71">mlx::core::ArcCosh</a></li>
<li>ArcSin()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_sin.html#a97cb8c3d4d9d6abc627dec49a404f013">mlx::core::ArcSin</a></li>
<li>ArcSinh()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_sinh.html#a30076b222788deeaaf9ad92d3c535f20">mlx::core::ArcSinh</a></li>
<li>ArcTan()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_tan.html#a3511153bbd421e89fd9294cdb3f79b44">mlx::core::ArcTan</a></li>
<li>ArcTan2()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_tan2.html#aa1a4ebab9924b6bcc80df5b52ed0121a">mlx::core::ArcTan2</a></li>
<li>ArcTanh()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arc_tanh.html#a17857bd0e2a3ecf1f7bf8e1a3d354358">mlx::core::ArcTanh</a></li>
<li>ArgMax&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_reduce.html#a920ed48caaba76683be0d1f1ed4a8bd3acc6659315ab0001abd37cbfcbe837e7e">mlx::core::ArgReduce</a></li>
<li>ArgMin&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_reduce.html#a920ed48caaba76683be0d1f1ed4a8bd3a93a8a9221545ae9518d289d9ac4d09e9">mlx::core::ArgReduce</a></li>
<li>ArgPartition()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_partition.html#ab54b13dbf92351ba1ac06fd3e5a802df">mlx::core::ArgPartition</a></li>
<li>ArgReduce()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_reduce.html#aaccf8021dc24895656e25142eb65aa03">mlx::core::ArgReduce</a></li>
<li>ArgSort()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_arg_sort.html#a38507a8445302a81cb44674c4a5fc0b0">mlx::core::ArgSort</a></li>
<li>argument_encoder()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1metal_1_1_device.html#a6e33e2b1287324fb4a6575e0da5e5881">mlx::core::metal::Device</a></li>
<li>arr()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1arr.html#a961a24410638b35129cd6b81850d2a42">pocketfft::detail::arr&lt; T &gt;</a></li>
<li>arr_info()&#160;:&#160;<a class="el" href="classpocketfft_1_1detail_1_1arr__info.html#a0dbddb7d86ca306159fc9ef9a453b21e">pocketfft::detail::arr_info</a></li>
<li>array()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a75fac72da3ce214fa3737df92a64b232">mlx::core::array</a></li>
<li>ArrayIterator()&#160;:&#160;<a class="el" href="structmlx_1_1core_1_1array_1_1_array_iterator.html#ad3afcb24c6db7642bbc06835f7f3e27a">mlx::core::array::ArrayIterator</a></li>
<li>As_offset&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#a138ed1bbad2ca88d3a3c7d162cd36562">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>AsStrided()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_as_strided.html#aee21aadc21343fd15aacb8f2f8ac3761">mlx::core::AsStrided</a></li>
<li>AsType()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1_as_type.html#a8c3241d402a8977bb4db037e225f5b47">mlx::core::AsType</a></li>
<li>Atile&#160;:&#160;<a class="el" href="structmlx_1_1steel_1_1_block_m_m_a.html#a47e614120c650f7479db79f23a0df586">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>atomic_update()&#160;:&#160;<a class="el" href="struct_none.html#aecbce7c97e8b1d5dc4afd2e788c24e06">None</a></li>
<li>attach_event()&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a000c3cfe13cb378bf0523b62816190da">mlx::core::array</a></li>
<li>available&#160;:&#160;<a class="el" href="classmlx_1_1core_1_1array.html#a199726612fa8a4bcd5c2d05eadad7078a308bd3e5bf976888b120dd36d0c2d2ae">mlx::core::array</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>