| <!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"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/lua.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> |
| <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> |
| <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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- 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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> </div> |
| <div class="headertitle"> |
| <div class="title">lua.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>C++11 header only interface to easily interact with Lua and Torch. This code is evolved from torch plugin code for MXNet. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <<a class="el" href="lua_8h_source.html">lua.h</a>></code><br /> |
| <code>#include <luaT.h></code><br /> |
| <code>#include <lualib.h></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <stdexcept></code><br /> |
| <code>#include <tuple></code><br /> |
| <code>#include <mutex></code><br /> |
| <code>#include <memory></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include <utility></code><br /> |
| <code>#include <algorithm></code><br /> |
| <code>#include <unordered_map></code><br /> |
| <code>#include <type_traits></code><br /> |
| <code>#include "<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>"</code><br /> |
| <code>#include "./logging.h"</code><br /> |
| <code>#include "<a class="el" href="thread__local_8h_source.html">./thread_local.h</a>"</code><br /> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for lua.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="lua_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2lua_8h" alt=""/></div> |
| <!-- MAP 0 --> |
| </div> |
| </div><div class="textblock"><div class="dynheader"> |
| This graph shows which files directly or indirectly include this file:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="lua_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2lua_8hdep" alt=""/></div> |
| <!-- MAP 1 --> |
| </div> |
| </div> |
| <p><a href="lua_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 name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1lua__stack_1_1Handler.html">dmlc::lua_stack::Handler< T ></a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html">dmlc::LuaRef</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">an reference to lua object <a href="classdmlc_1_1LuaRef.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html">dmlc::LuaState</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A Lua state. <a href="classdmlc_1_1LuaState.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr> |
| <tr class="memdesc:namespacedmlc"><td class="mdescLeft"> </td><td class="mdescRight">namespace for dmlc <br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:namespacedmlc_1_1lua__stack"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc_1_1lua__stack.html">dmlc::lua_stack</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>C++11 header only interface to easily interact with Lua and Torch. This code is evolved from torch plugin code for MXNet. </p> |
| <p>Copyright (c) 2016 by Contributors</p> |
| <p>This header will require Torch and Lua to be presented, do not include.</p> |
| <dl class="section author"><dt>Author</dt><dd>Junyuan Xie, Min Lin, Tianqi Chen</dd></dl> |
| <div class="fragment"><div class="line"><span class="comment">// Example code to use the lua module.</span></div> |
| <div class="line"><a class="code" href="classdmlc_1_1LuaState.html">dmlc::LuaState</a>* lua = <a class="code" href="classdmlc_1_1LuaState.html#a5eaebefa148bfd110e3c50b45154b221">dmlc::LuaState::ThreadLocalState</a>();</div> |
| <div class="line"><span class="comment">// vectors converts automatically to lua table.</span></div> |
| <div class="line"><span class="keyword">auto</span> tbl = lua-><a class="code" href="classdmlc_1_1LuaState.html#a33446cb9b59326e0e7746bcf7cf46330">Convert</a>(std::vector<int>{1,2,3});</div> |
| <div class="line"><span class="comment">// use eval to get lua reference, this is a function</span></div> |
| <div class="line"><span class="keyword">auto</span> print = lua-><a class="code" href="classdmlc_1_1LuaState.html#a0d19f8d8507c33502ce4c00e1b1e5134">Eval</a>(<span class="stringliteral">"return function(x) print(x) end"</span>);</div> |
| <div class="line"><span class="comment">// lua function can be directly called from c++, arguments are converted.</span></div> |
| <div class="line">print(100);</div> |
| <div class="line"> </div> |
| <div class="line"><span class="comment">// set field in the table.</span></div> |
| <div class="line">tbl.SetField(<span class="stringliteral">"square"</span>, lua-><a class="code" href="classdmlc_1_1LuaState.html#a0d19f8d8507c33502ce4c00e1b1e5134">Eval</a>(<span class="stringliteral">"return function(x) x*x end"</span>));</div> |
| <div class="line"><span class="comment">// call the function, covert back to C++ values.</span></div> |
| <div class="line"><span class="keywordtype">int</span> x = tbl[<span class="stringliteral">"square"</span>](100).Get<int>();</div> |
| </div><!-- fragment --> </div></div><!-- contents --> |
| <div class="ttc" id="aclassdmlc_1_1LuaState_html"><div class="ttname"><a href="classdmlc_1_1LuaState.html">dmlc::LuaState</a></div><div class="ttdoc">A Lua state.</div><div class="ttdef"><b>Definition:</b> lua.h:173</div></div> |
| <div class="ttc" id="aclassdmlc_1_1LuaState_html_a33446cb9b59326e0e7746bcf7cf46330"><div class="ttname"><a href="classdmlc_1_1LuaState.html#a33446cb9b59326e0e7746bcf7cf46330">dmlc::LuaState::Convert</a></div><div class="ttdeci">LuaRef Convert(const T &value)</div><div class="ttdoc">convert a C++ type to lua type</div></div> |
| <div class="ttc" id="aclassdmlc_1_1LuaState_html_a0d19f8d8507c33502ce4c00e1b1e5134"><div class="ttname"><a href="classdmlc_1_1LuaState.html#a0d19f8d8507c33502ce4c00e1b1e5134">dmlc::LuaState::Eval</a></div><div class="ttdeci">LuaRef Eval(const char *lua_code)</div><div class="ttdoc">evaluate a piece of lua code, return the first result.</div></div> |
| <div class="ttc" id="aclassdmlc_1_1LuaState_html_a5eaebefa148bfd110e3c50b45154b221"><div class="ttname"><a href="classdmlc_1_1LuaState.html#a5eaebefa148bfd110e3c50b45154b221">dmlc::LuaState::ThreadLocalState</a></div><div class="ttdeci">static LuaState * ThreadLocalState()</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Nov 5 2022 01:16:57 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |