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

259 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: File 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('globals_defs.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 macros with links to the files they belong to:</div>
<h3><a id="index__5F" name="index__5F"></a>- _ -</h3><ul>
<li>__MLX_BFLOAT_NAN__&#160;:&#160;<a class="el" href="types_2bf16_8h.html#a78cafe726142a0166894e0c0a70b19f6">bf16.h</a></li>
<li>__MLX_HALF_NAN__&#160;:&#160;<a class="el" href="fp16_8h.html#a10abf57a099efdbb9db0c78e9c120e50">fp16.h</a></li>
</ul>
<h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
<li>ADD_HALF_BINOPS&#160;:&#160;<a class="el" href="half__types_8h.html#a6bc906918877a7084068a9f0ed571dca">half_types.h</a></li>
</ul>
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
<li>bfloat_binop&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a7694892a131c0e31e5153c088cccb707">bf16.h</a></li>
<li>bfloat_binop_base&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a78c92beda4436da9a2e520fa98c59f70">bf16.h</a></li>
<li>bfloat_binop_helper&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#ac7ff36230dab17e8f17b7a7c80888594">bf16.h</a></li>
<li>bfloat_bitop&#160;:&#160;<a class="el" href="types_2bf16_8h.html#aac9ba86d4bf05bcda1936494f9b9b4d3">bf16.h</a></li>
<li>bfloat_compop&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a330a0883503cb640f1cf628a7ca50239">bf16.h</a></li>
<li>bfloat_inplace_bitop&#160;:&#160;<a class="el" href="types_2bf16_8h.html#af13b46bc58e6e6f675ae47aabec37711">bf16.h</a></li>
<li>bfloat_inplace_op&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a4ac82467fbc674e990090f482b9c1e5c">bf16.h</a></li>
<li>bfloat_inplace_op_addr_space_helper&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#af30a2cbd2c3415516203b83bd21872f8">bf16.h</a></li>
<li>bfloat_inplace_op_helper&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2metal__3__0_2bf16_8h.html#a2846fd11b5e19b435e9f7ef0998c9b1d">bf16.h</a></li>
<li>BINARY_SINGLE&#160;:&#160;<a class="el" href="cpu_2binary__ops_8h.html#ad606fe7b9586413e760cfe461c9be119">binary_ops.h</a></li>
</ul>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>complex_binop&#160;:&#160;<a class="el" href="types_2complex_8h.html#a9c7995d495359894e1b30c0f1678d6bd">complex.h</a></li>
<li>complex_binop_helper&#160;:&#160;<a class="el" href="types_2complex_8h.html#ac6890f9852de12339b09b65757ebc8c4">complex.h</a></li>
</ul>
<h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
<li>DEFAULT_BINARY&#160;:&#160;<a class="el" href="base__simd_8h.html#a1d01fad7230543d56f4facf17dcc4047">base_simd.h</a></li>
<li>DEFAULT_BINARY_OP&#160;:&#160;<a class="el" href="cpu_2binary__ops_8h.html#a3f97e0a58306201b54eb73fac0affc8a">binary_ops.h</a></li>
<li>DEFAULT_BOOL_OP&#160;:&#160;<a class="el" href="cpu_2binary__ops_8h.html#a98fb0ee78e9fd26ad6d0a2b365f7caa7">binary_ops.h</a></li>
<li>DEFAULT_COMPARISONS&#160;:&#160;<a class="el" href="base__simd_8h.html#af5153f51cdd18d56d1de24b5da9f4366">base_simd.h</a></li>
<li>DEFAULT_OP&#160;:&#160;<a class="el" href="cpu_2unary__ops_8h.html#a83702f31e6dbd79c339a6aad67319f64">unary_ops.h</a></li>
<li>DEFAULT_REDUCTION&#160;:&#160;<a class="el" href="base__simd_8h.html#a0adf6d25084019eff671abc59031573e">base_simd.h</a></li>
<li>DEFAULT_UNARY&#160;:&#160;<a class="el" href="base__simd_8h.html#a122d6a2fa4dcfe78b221e52155419124">base_simd.h</a></li>
<li>DEFINE_DEFAULT_IS_EQUIVALENT&#160;:&#160;<a class="el" href="primitives_8h.html#a0fb9d19207dc4869aca35abfbdf4d70a">primitives.h</a></li>
<li>DEFINE_GRADS&#160;:&#160;<a class="el" href="primitives_8h.html#a77abdcb55bc2eb0f9a45edc5ee639bf6">primitives.h</a></li>
<li>DEFINE_INPUT_OUTPUT_SHAPE&#160;:&#160;<a class="el" href="primitives_8h.html#a649a06267b75e007224ea4ddefedb999">primitives.h</a></li>
<li>DEFINE_NEON_BINARY_OP&#160;:&#160;<a class="el" href="neon__fp16__simd_8h.html#a63ba6e115ef14e134081310f7d4579a5">neon_fp16_simd.h</a></li>
<li>DEFINE_NEON_COMPARISON&#160;:&#160;<a class="el" href="neon__fp16__simd_8h.html#a9fcd94c7369a6b4437f9c310a805c79d">neon_fp16_simd.h</a></li>
<li>DEFINE_NEON_UNARY_OP&#160;:&#160;<a class="el" href="neon__fp16__simd_8h.html#af8138a463be93b9e0c9b685e94a1fd00">neon_fp16_simd.h</a></li>
<li>DEFINE_PRINT&#160;:&#160;<a class="el" href="primitives_8h.html#a1d3a37af519e16f6a703b1e9ebd0f592">primitives.h</a></li>
<li>DEFINE_SIMD_EXCLUSIVE_SCAN&#160;:&#160;<a class="el" href="scan_8h.html#a185f66aac8c5317587e6abd43f3013fc">scan.h</a></li>
<li>DEFINE_SIMD_REDUCE&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2reduction_2ops_8h.html#acacf99e0ba629ed062ccc3c2eba89b05">ops.h</a></li>
<li>DEFINE_SIMD_SCAN&#160;:&#160;<a class="el" href="scan_8h.html#a0d8d6a9b0f3a1263629380bda8eca7bc">scan.h</a></li>
<li>DEFINE_VMAP&#160;:&#160;<a class="el" href="primitives_8h.html#adc0fbd79fe0d1114dc85da4ed99798bd">primitives.h</a></li>
</ul>
<h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
<li>fp16_bf16_binop_helper&#160;:&#160;<a class="el" href="half__types_8h.html#a1f0d5d395d403bde764fffe4846617f9">half_types.h</a></li>
</ul>
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
<li>half_binop&#160;:&#160;<a class="el" href="fp16_8h.html#af58966694c5d80f9a0241670f3128199">fp16.h</a></li>
<li>half_binop_base&#160;:&#160;<a class="el" href="fp16_8h.html#a8420acf5d2687fbdafcc9052c949f323">fp16.h</a></li>
<li>half_binop_helper&#160;:&#160;<a class="el" href="fp16_8h.html#aa300338c53d5a9f52fbbde8fd777f13d">fp16.h</a></li>
<li>half_bitop&#160;:&#160;<a class="el" href="fp16_8h.html#a2242eaa64839925fd8f586dde7a59800">fp16.h</a></li>
<li>half_compop&#160;:&#160;<a class="el" href="fp16_8h.html#acec0b85a9974cbde7b270a121f382405">fp16.h</a></li>
<li>half_inplace_bitop&#160;:&#160;<a class="el" href="fp16_8h.html#a378e011e994bf62a961c3c1cd6f7c290">fp16.h</a></li>
<li>half_inplace_op&#160;:&#160;<a class="el" href="fp16_8h.html#a6348c00d31a50b2df1b47d18af49c4b8">fp16.h</a></li>
</ul>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>instantiate_default_limit&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2utils_8h.html#abedffa358e7ba7782cc78d6772064c7c">utils.h</a></li>
<li>instantiate_float_limit&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2utils_8h.html#a1e520e23f58ca645dea1ac20998d987a">utils.h</a></li>
<li>instantiate_kernel&#160;:&#160;<a class="el" href="defines_8h.html#a0cc4a821c1090d4183ff3a31da7e9f7b">defines.h</a></li>
<li>instantiate_metal_math_funcs&#160;:&#160;<a class="el" href="bf16__math_8h.html#a9e9f0fdd6e304522bc88acd22c576842">bf16_math.h</a></li>
<li>instantiate_metal_simd_comm_funcs&#160;:&#160;<a class="el" href="bf16__math_8h.html#aecc11cb898846d01bfc9faa109fcf791">bf16_math.h</a></li>
<li>instantiate_metal_simd_reduction_funcs&#160;:&#160;<a class="el" href="bf16__math_8h.html#a51688bc24fc9292aaec5f54a58eaa2d0">bf16_math.h</a></li>
<li>integral_const_binop&#160;:&#160;<a class="el" href="integral__constant_8h.html#ab28d2705f6fd4f54faccbb78fd5ddfb6">integral_constant.h</a></li>
</ul>
<h3><a id="index_j" name="index_j"></a>- j -</h3><ul>
<li>jit_else&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2jit_2bf16_8h.html#a4b2f08732045407adc7ee181e39e5ae3">bf16.h</a></li>
<li>jit_endif&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2jit_2bf16_8h.html#a5049b44a1fffcb837e0c470ae4cafc56">bf16.h</a></li>
<li>jit_if&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2jit_2bf16_8h.html#aaf5bb88c2349054a6c4c2aefee63d3d2">bf16.h</a></li>
</ul>
<h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
<li>MAX_OUTPUT_SIZE&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2fft_8h.html#a28d683cf067736d76f867f30c066317e">fft.h</a></li>
<li>MAX_RADIX&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2fft_8h.html#a7b6e56afa21f022c5e754b000955735a">fft.h</a>, <a class="el" href="readwrite_8h.html#a7b6e56afa21f022c5e754b000955735a">readwrite.h</a></li>
<li>MLX_LAPACK_FUNC&#160;:&#160;<a class="el" href="lapack_8h.html#ae22db9704827bf013a0a61f21a47464b">lapack.h</a></li>
<li>MLX_MTL_CONST&#160;:&#160;<a class="el" href="gemv__masked_8h.html#a0386011c52d03e60885a31e6fbd903dd">gemv_masked.h</a>, <a class="el" href="quantized_8h.html#a0386011c52d03e60885a31e6fbd903dd">quantized.h</a>, <a class="el" href="sort_8h.html#a0386011c52d03e60885a31e6fbd903dd">sort.h</a></li>
<li>MLX_MTL_LOOP_UNROLL&#160;:&#160;<a class="el" href="sort_8h.html#ad34b622323cebef136669fedd7229515">sort.h</a></li>
<li>MLX_MTL_PRAGMA_UNROLL&#160;:&#160;<a class="el" href="gemv__masked_8h.html#a069b682d7d21827461544817d722bfd3">gemv_masked.h</a>, <a class="el" href="backend_2metal_2kernels_2utils_8h.html#a069b682d7d21827461544817d722bfd3">utils.h</a></li>
<li>MLX_SIMD_LIBRARY_VERSION&#160;:&#160;<a class="el" href="accelerate__simd_8h.html#a628420ebe2f37d352c8c4b0dd0db59d0">accelerate_simd.h</a></li>
<li>MTL_CONST&#160;:&#160;<a class="el" href="defines_8h.html#a767ed9f2604de22b259cee02c4ce1d22">defines.h</a></li>
</ul>
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
<li>O_BINARY&#160;:&#160;<a class="el" href="io_2load_8h.html#a36fa9b2e726512bc17a7a6d3e39002be">load.h</a></li>
</ul>
<h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
<li>POCKETFFT_CACHE_SIZE&#160;:&#160;<a class="el" href="pocketfft_8h.html#a9e604bcf20603d70b62b233d3f306714">pocketfft.h</a></li>
<li>POCKETFFT_NO_VECTORS&#160;:&#160;<a class="el" href="pocketfft_8h.html#aa9cdaed0819c48f97fcd19f05c289160">pocketfft.h</a></li>
<li>POCKETFFT_NOINLINE&#160;:&#160;<a class="el" href="pocketfft_8h.html#a7020984e0ca1d6e565629ca6e7c1a7e0">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP11&#160;:&#160;<a class="el" href="pocketfft_8h.html#a1793d0d00f2e13101eb5ad0719c40817">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP11a&#160;:&#160;<a class="el" href="pocketfft_8h.html#ac35e1aa5ae84d655256b7a0afd9051c2">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP11a0&#160;:&#160;<a class="el" href="pocketfft_8h.html#ab2df44457945ab625fb38a777a46af1b">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP3a&#160;:&#160;<a class="el" href="pocketfft_8h.html#ac112b26e5130636ac1d91c2f0af45e0b">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP3b&#160;:&#160;<a class="el" href="pocketfft_8h.html#a41e646e5535a3a1c6e0d0e67122382f5">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP5a&#160;:&#160;<a class="el" href="pocketfft_8h.html#a078bc2bd38ab0ffb15b981878c9de03c">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP5b&#160;:&#160;<a class="el" href="pocketfft_8h.html#ab8a5da142555e059c5e9c618f75b46fa">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP7&#160;:&#160;<a class="el" href="pocketfft_8h.html#af7de1f82911a973d8446cf3f40ff3044">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP7a&#160;:&#160;<a class="el" href="pocketfft_8h.html#a2b27f6e1f0ee131765186870517255c6">pocketfft.h</a></li>
<li>POCKETFFT_PARTSTEP7a0&#160;:&#160;<a class="el" href="pocketfft_8h.html#a9c2fc2de74a031c38e9d8a21249ae1cd">pocketfft.h</a></li>
<li>POCKETFFT_PREP11&#160;:&#160;<a class="el" href="pocketfft_8h.html#a536d2ea61479d4b074bf52ce09fdbc3a">pocketfft.h</a></li>
<li>POCKETFFT_PREP3&#160;:&#160;<a class="el" href="pocketfft_8h.html#ae2fd9d433c417f0768fe1b58145b2e59">pocketfft.h</a></li>
<li>POCKETFFT_PREP5&#160;:&#160;<a class="el" href="pocketfft_8h.html#a73077c26d2a82754db2a9c48bc0e11a6">pocketfft.h</a></li>
<li>POCKETFFT_PREP7&#160;:&#160;<a class="el" href="pocketfft_8h.html#ae7c4d0cda5b3824f84eac54addabd6ec">pocketfft.h</a></li>
<li>POCKETFFT_REARRANGE&#160;:&#160;<a class="el" href="pocketfft_8h.html#acffdf2e1ab84f36a7a097e1b8b87a9f9">pocketfft.h</a></li>
<li>POCKETFFT_RESTRICT&#160;:&#160;<a class="el" href="pocketfft_8h.html#abbe177c4872821b32d76d5ce08d6ce82">pocketfft.h</a></li>
</ul>
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>RADIX_STEP&#160;:&#160;<a class="el" href="backend_2metal_2kernels_2fft_8h.html#a794032d3a9acff0e31c77c69d0007f10">fft.h</a></li>
</ul>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>SIMD_DEFAULT_BINARY&#160;:&#160;<a class="el" href="accelerate__simd_8h.html#a9aa795d90ddc485f24cd4a5268fe0e82">accelerate_simd.h</a></li>
<li>SIMD_DEFAULT_COMPARISONS&#160;:&#160;<a class="el" href="accelerate__simd_8h.html#aca22aa431d399cea13c969926689b459">accelerate_simd.h</a></li>
<li>SIMD_DEFAULT_UNARY&#160;:&#160;<a class="el" href="accelerate__simd_8h.html#a3b449b9ce2c623ab4dce3f6fe349bb6d">accelerate_simd.h</a></li>
<li>SIMD_FP16_DEFAULT_BINARY&#160;:&#160;<a class="el" href="accelerate__fp16__simd_8h.html#a6437645d67e6a8b7c1349b0040aaa6bb">accelerate_fp16_simd.h</a></li>
<li>SIMD_FP16_DEFAULT_UNARY&#160;:&#160;<a class="el" href="accelerate__fp16__simd_8h.html#a60af883c0392ecab270ecc1146f5e8a2">accelerate_fp16_simd.h</a></li>
<li>SINGLE&#160;:&#160;<a class="el" href="cpu_2unary__ops_8h.html#a602aea95990389a45c255195f849d5de">unary_ops.h</a></li>
<li>STEEL_CONST&#160;:&#160;<a class="el" href="steel_2defines_8h.html#a90b91c866313ffa46eff6d9cc944ad2b">defines.h</a></li>
<li>STEEL_PRAGMA_UNROLL&#160;:&#160;<a class="el" href="steel_2defines_8h.html#a5a5c3095b132a7589bc19cd5cb80e2c6">defines.h</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>