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

164 lines
13 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: mlx/export.h File Reference</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('export_8h.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="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">export.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;map&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
<code>#include &quot;<a class="el" href="array_8h_source.html">mlx/array.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="export__impl_8h_source.html">mlx/export_impl.h</a>&quot;</code><br />
</div>
<p><a href="export_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx.html">mlx</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html">mlx::core</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:acace1870dbbc6a0af0c054e8e71adc1f" id="r_acace1870dbbc6a0af0c054e8e71adc1f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">mlx::core::Args</a> = std::vector&lt;<a class="el" href="classmlx_1_1core_1_1array.html">array</a>&gt;</td></tr>
<tr class="separator:acace1870dbbc6a0af0c054e8e71adc1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3efb38b31c0bc08754a4edfda656b83" id="r_af3efb38b31c0bc08754a4edfda656b83"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">mlx::core::Kwargs</a> = std::map&lt;std::string, <a class="el" href="classmlx_1_1core_1_1array.html">array</a>&gt;</td></tr>
<tr class="separator:af3efb38b31c0bc08754a4edfda656b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0303e26b737c9fd197ed9caa90fd21a7" id="r_a0303e26b737c9fd197ed9caa90fd21a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_function_exporter.html">FunctionExporter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7">mlx::core::exporter</a> (const std::string &amp;file, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;)&gt; &amp;fun, bool shapeless=false)</td></tr>
<tr class="memdesc:a0303e26b737c9fd197ed9caa90fd21a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make an exporter to save multiple traces of a given function to the same file. <br /></td></tr>
<tr class="separator:a0303e26b737c9fd197ed9caa90fd21a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2735df8513ecce88456585f5aea50f5" id="r_af2735df8513ecce88456585f5aea50f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_function_exporter.html">FunctionExporter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af2735df8513ecce88456585f5aea50f5">mlx::core::exporter</a> (const std::string &amp;file, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;)&gt; &amp;fun, bool shapeless=false)</td></tr>
<tr class="separator:af2735df8513ecce88456585f5aea50f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af38d5718f517e50a590fdb3d63a90df1" id="r_af38d5718f517e50a590fdb3d63a90df1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_function_exporter.html">FunctionExporter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#af38d5718f517e50a590fdb3d63a90df1">mlx::core::exporter</a> (const std::string &amp;path, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;, const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;)&gt; &amp;fun, bool shapeless=false)</td></tr>
<tr class="separator:af38d5718f517e50a590fdb3d63a90df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2afa4ea816ac9317200fd5c964fc89dc" id="r_a2afa4ea816ac9317200fd5c964fc89dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc">mlx::core::export_function</a> (const std::string &amp;file, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;)&gt; &amp;fun, const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;args, bool shapeless=false)</td></tr>
<tr class="memdesc:a2afa4ea816ac9317200fd5c964fc89dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export a function to a file. <br /></td></tr>
<tr class="separator:a2afa4ea816ac9317200fd5c964fc89dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace51644e2aa72f8d56b86eaa0e1a68b7" id="r_ace51644e2aa72f8d56b86eaa0e1a68b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#ace51644e2aa72f8d56b86eaa0e1a68b7">mlx::core::export_function</a> (const std::string &amp;file, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;)&gt; &amp;fun, const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;kwargs, bool shapeless=false)</td></tr>
<tr class="separator:ace51644e2aa72f8d56b86eaa0e1a68b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9692d7bb6de3456abc535d0f4bac7a94" id="r_a9692d7bb6de3456abc535d0f4bac7a94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a9692d7bb6de3456abc535d0f4bac7a94">mlx::core::export_function</a> (const std::string &amp;file, const std::function&lt; std::vector&lt; <a class="el" href="classmlx_1_1core_1_1array.html">array</a> &gt;(const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;, const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;)&gt; &amp;fun, const <a class="el" href="namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f">Args</a> &amp;args, const <a class="el" href="namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83">Kwargs</a> &amp;kwargs, bool shapeless=false)</td></tr>
<tr class="separator:a9692d7bb6de3456abc535d0f4bac7a94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fbb29691ee1ff22c3ee2a67cbc053d5" id="r_a4fbb29691ee1ff22c3ee2a67cbc053d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmlx_1_1core_1_1_imported_function.html">ImportedFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlx_1_1core.html#a4fbb29691ee1ff22c3ee2a67cbc053d5">mlx::core::import_function</a> (const std::string &amp;file)</td></tr>
<tr class="memdesc:a4fbb29691ee1ff22c3ee2a67cbc053d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Import a function from a file. <br /></td></tr>
<tr class="separator:a4fbb29691ee1ff22c3ee2a67cbc053d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_938ab0ecf10b8b860ff766c820f665fd.html">mlx</a></li><li class="navelem"><a class="el" href="export_8h.html">export.h</a></li>
<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>