2025-01-10 05:56:20 +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" / >
2025-01-10 05:56:20 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > MLX: mlx/export.h Source File< / 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& 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()" >   < / 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 -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2025-01-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& 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& dn=expat.txt MIT */
$(function(){initNavTree('export_8h_source.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 = "headertitle" > < div class = "title" > export.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "export_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "comment" > // Copyright © 2024 Apple Inc.< / span > < / div >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "preprocessor" > #include < map> < / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < span class = "preprocessor" > #include < set> < / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "preprocessor" > #include " < a class = "code" href = "array_8h.html" > mlx/array.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core.html" > mlx::core< / a > {< / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > 11< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > = std::vector< array> ;< / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > 12< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > = std::map< std::string, array> ;< / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "keyword" > struct < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_function_exporter.html" > FunctionExporter< / a > ;< / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7" > 20< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_function_exporter.html" > FunctionExporter< / a > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7" > exporter< / a > (< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "keyword" > const< / span > std::string& file,< / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#af2735df8513ecce88456585f5aea50f5" > 25< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_function_exporter.html" > FunctionExporter< / a > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7" > exporter< / a > (< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < span class = "keyword" > const< / span > std::string& file,< / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#af38d5718f517e50a590fdb3d63a90df1" > 30< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_function_exporter.html" > FunctionExporter< / a > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7" > exporter< / a > (< / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < span class = "keyword" > const< / span > std::string& path,< / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & , < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc" > 38< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc" > export_function< / a > (< / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "keyword" > const< / span > std::string& file,< / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & args,< / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#ace51644e2aa72f8d56b86eaa0e1a68b7" > 44< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc" > export_function< / a > (< / div >
< div class = "line" > < a id = "l00045" name = "l00045" > < / a > < span class = "lineno" > 45< / span > < span class = "keyword" > const< / span > std::string& file,< / div >
< div class = "line" > < a id = "l00046" name = "l00046" > < / a > < span class = "lineno" > 46< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00047" name = "l00047" > < / a > < span class = "lineno" > 47< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & kwargs,< / div >
< div class = "line" > < a id = "l00048" name = "l00048" > < / a > < span class = "lineno" > 48< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00049" name = "l00049" > < / a > < span class = "lineno" > 49< / span > < / div >
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a9692d7bb6de3456abc535d0f4bac7a94" > 50< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc" > export_function< / a > (< / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > < span class = "keyword" > const< / span > std::string& file,< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > < span class = "keyword" > const< / span > std::function< std::vector< array> (< span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & , < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & )> & fun,< / div >
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > Args< / a > & args,< / div >
< div class = "line" > < a id = "l00054" name = "l00054" > < / a > < span class = "lineno" > 54< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > Kwargs< / a > & kwargs,< / div >
< div class = "line" > < a id = "l00055" name = "l00055" > < / a > < span class = "lineno" > 55< / span > < span class = "keywordtype" > bool< / span > shapeless = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00056" name = "l00056" > < / a > < span class = "lineno" > 56< / span > < / div >
< div class = "line" > < a id = "l00057" name = "l00057" > < / a > < span class = "lineno" > 57< / span > < span class = "keyword" > struct < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_imported_function.html" > ImportedFunction< / a > ;< / div >
< div class = "line" > < a id = "l00058" name = "l00058" > < / a > < span class = "lineno" > 58< / span > < / div >
< div class = "line" > < a id = "l00062" name = "l00062" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a4fbb29691ee1ff22c3ee2a67cbc053d5" > 62< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_imported_function.html" > ImportedFunction< / a > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a4fbb29691ee1ff22c3ee2a67cbc053d5" > import_function< / a > (< span class = "keyword" > const< / span > std::string& file);< / div >
< div class = "line" > < a id = "l00063" name = "l00063" > < / a > < span class = "lineno" > 63< / span > < / div >
< div class = "line" > < a id = "l00064" name = "l00064" > < / a > < span class = "lineno" > 64< / span > } < span class = "comment" > // namespace mlx::core< / span > < / div >
< div class = "line" > < a id = "l00065" name = "l00065" > < / a > < span class = "lineno" > 65< / span > < / div >
< div class = "line" > < a id = "l00066" name = "l00066" > < / a > < span class = "lineno" > 66< / span > < span class = "preprocessor" > #include " < a class = "code" href = "export__impl_8h.html" > mlx/export_impl.h< / a > " < / span > < / div >
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
< div class = "ttc" id = "aexport__impl_8h_html" > < div class = "ttname" > < a href = "export__impl_8h.html" > export_impl.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html" > mlx::core< / a > < / div > < div class = "ttdef" > < b > Definition< / b > allocator.h:7< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a0303e26b737c9fd197ed9caa90fd21a7" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a0303e26b737c9fd197ed9caa90fd21a7" > mlx::core::exporter< / a > < / div > < div class = "ttdeci" > FunctionExporter exporter(const std::string & file, const std::function< std::vector< array > (const Args & )> & fun, bool shapeless=false)< / div > < div class = "ttdoc" > Make an exporter to save multiple traces of a given function to the same file.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a2afa4ea816ac9317200fd5c964fc89dc" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a2afa4ea816ac9317200fd5c964fc89dc" > mlx::core::export_function< / a > < / div > < div class = "ttdeci" > void export_function(const std::string & file, const std::function< std::vector< array > (const Args & )> & fun, const Args & args, bool shapeless=false)< / div > < div class = "ttdoc" > Export a function to a file.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a4fbb29691ee1ff22c3ee2a67cbc053d5" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a4fbb29691ee1ff22c3ee2a67cbc053d5" > mlx::core::import_function< / a > < / div > < div class = "ttdeci" > ImportedFunction import_function(const std::string & file)< / div > < div class = "ttdoc" > Import a function from a file.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_acace1870dbbc6a0af0c054e8e71adc1f" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#acace1870dbbc6a0af0c054e8e71adc1f" > mlx::core::Args< / a > < / div > < div class = "ttdeci" > std::vector< array > Args< / div > < div class = "ttdef" > < b > Definition< / b > export.h:11< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_af3efb38b31c0bc08754a4edfda656b83" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#af3efb38b31c0bc08754a4edfda656b83" > mlx::core::Kwargs< / a > < / div > < div class = "ttdeci" > std::map< std::string, array > Kwargs< / div > < div class = "ttdef" > < b > Definition< / b > export.h:12< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1_function_exporter_html" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1_function_exporter.html" > mlx::core::FunctionExporter< / a > < / div > < div class = "ttdef" > < b > Definition< / b > export_impl.h:11< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1_imported_function_html" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1_imported_function.html" > mlx::core::ImportedFunction< / a > < / div > < div class = "ttdef" > < b > Definition< / b > export_impl.h:54< / div > < / div >
< / div > <!-- fragment --> < / 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 >
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 >
< / body >
< / html >