| <!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: dmlc::LuaState Class 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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1LuaState.html">LuaState</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classdmlc_1_1LuaState-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::LuaState Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A Lua state. |
| <a href="classdmlc_1_1LuaState.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="lua_8h_source.html">lua.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::LuaState:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1LuaState__coll__graph.png" border="0" usemap="#dmlc_1_1LuaState_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a00653ef79293ad2e4797326295028ce7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">Option</a> { <a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7a6480c008fb889ce1b21c7a9180f993b2">kNoThreadProtect</a>, |
| <a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7a5350b9ee8b057163d888bfef054921f6">kThreadLocal</a>, |
| <a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7a7c8af5ada7569e1a33e4d075fed0b143">kLocking</a> |
| }</td></tr> |
| <tr class="memdesc:a00653ef79293ad2e4797326295028ce7"><td class="mdescLeft"> </td><td class="mdescRight">options to be provided in lua state <a href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">More...</a><br /></td></tr> |
| <tr class="separator:a00653ef79293ad2e4797326295028ce7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1734dbf3c2f3f036773a7a257de055aa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a1734dbf3c2f3f036773a7a257de055aa">~LuaState</a> ()</td></tr> |
| <tr class="memdesc:a1734dbf3c2f3f036773a7a257de055aa"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classdmlc_1_1LuaState.html#a1734dbf3c2f3f036773a7a257de055aa">More...</a><br /></td></tr> |
| <tr class="separator:a1734dbf3c2f3f036773a7a257de055aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d19f8d8507c33502ce4c00e1b1e5134"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a0d19f8d8507c33502ce4c00e1b1e5134">Eval</a> (const char *lua_code)</td></tr> |
| <tr class="memdesc:a0d19f8d8507c33502ce4c00e1b1e5134"><td class="mdescLeft"> </td><td class="mdescRight">evaluate a piece of lua code, return the first result. <a href="classdmlc_1_1LuaState.html#a0d19f8d8507c33502ce4c00e1b1e5134">More...</a><br /></td></tr> |
| <tr class="separator:a0d19f8d8507c33502ce4c00e1b1e5134"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a640071bc366a5bed96093191addc50f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a640071bc366a5bed96093191addc50f2">Eval</a> (const std::string &lua_code)</td></tr> |
| <tr class="memdesc:a640071bc366a5bed96093191addc50f2"><td class="mdescLeft"> </td><td class="mdescRight">evaluate a piece of lua code, return the first result. <a href="classdmlc_1_1LuaState.html#a640071bc366a5bed96093191addc50f2">More...</a><br /></td></tr> |
| <tr class="separator:a640071bc366a5bed96093191addc50f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a33446cb9b59326e0e7746bcf7cf46330"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:a33446cb9b59326e0e7746bcf7cf46330"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a33446cb9b59326e0e7746bcf7cf46330">Convert</a> (const T &value)</td></tr> |
| <tr class="memdesc:a33446cb9b59326e0e7746bcf7cf46330"><td class="mdescLeft"> </td><td class="mdescRight">convert a C++ type to lua type <a href="classdmlc_1_1LuaState.html#a33446cb9b59326e0e7746bcf7cf46330">More...</a><br /></td></tr> |
| <tr class="separator:a33446cb9b59326e0e7746bcf7cf46330"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad9140fd83d79254f4a5f06e136f05602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#ad9140fd83d79254f4a5f06e136f05602">operator[]</a> (const std::string &key)</td></tr> |
| <tr class="memdesc:ad9140fd83d79254f4a5f06e136f05602"><td class="mdescLeft"> </td><td class="mdescRight">get global field from the state <a href="classdmlc_1_1LuaState.html#ad9140fd83d79254f4a5f06e136f05602">More...</a><br /></td></tr> |
| <tr class="separator:ad9140fd83d79254f4a5f06e136f05602"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acff2a74578e591476dc2be889c7a4d4e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#acff2a74578e591476dc2be889c7a4d4e">SetGlobalField</a> (const std::string &key, const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &value)</td></tr> |
| <tr class="memdesc:acff2a74578e591476dc2be889c7a4d4e"><td class="mdescLeft"> </td><td class="mdescRight">Set the value to the global table. <a href="classdmlc_1_1LuaState.html#acff2a74578e591476dc2be889c7a4d4e">More...</a><br /></td></tr> |
| <tr class="separator:acff2a74578e591476dc2be889c7a4d4e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade7455050ecf9d82053d2d71d1272a82"><td class="memTemplParams" colspan="2">template<typename F > </td></tr> |
| <tr class="memitem:ade7455050ecf9d82053d2d71d1272a82"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#ade7455050ecf9d82053d2d71d1272a82">PRun_</a> (F f)</td></tr> |
| <tr class="memdesc:ade7455050ecf9d82053d2d71d1272a82"><td class="mdescLeft"> </td><td class="mdescRight">protected run f, this is used by API developers. always call this to access lua state f must not destruct <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a>, or access the mutex <a href="classdmlc_1_1LuaState.html#ade7455050ecf9d82053d2d71d1272a82">More...</a><br /></td></tr> |
| <tr class="separator:ade7455050ecf9d82053d2d71d1272a82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70e5476fac877e46a0f582fa76147618"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a70e5476fac877e46a0f582fa76147618">SameLuaState</a> (lua_State *L) const</td></tr> |
| <tr class="separator:a70e5476fac877e46a0f582fa76147618"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a5eaebefa148bfd110e3c50b45154b221"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdmlc_1_1LuaState.html">LuaState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a5eaebefa148bfd110e3c50b45154b221">ThreadLocalState</a> ()</td></tr> |
| <tr class="separator:a5eaebefa148bfd110e3c50b45154b221"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dcdffce5b1f9526568f37b7d4e7b8f1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdmlc_1_1LuaState.html">LuaState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a7dcdffce5b1f9526568f37b7d4e7b8f1">Create_</a> (<a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">Option</a> option)</td></tr> |
| <tr class="separator:a7dcdffce5b1f9526568f37b7d4e7b8f1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:ae76399cb24c8a82c491947f304ede429"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#ae76399cb24c8a82c491947f304ede429">LuaState</a> ()</td></tr> |
| <tr class="memdesc:ae76399cb24c8a82c491947f304ede429"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="classdmlc_1_1LuaState.html#ae76399cb24c8a82c491947f304ede429">More...</a><br /></td></tr> |
| <tr class="separator:ae76399cb24c8a82c491947f304ede429"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a99241e18fc7e404a97b405deebb95927"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">Option</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#a99241e18fc7e404a97b405deebb95927">option_</a> {<a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7a5350b9ee8b057163d888bfef054921f6">kThreadLocal</a>}</td></tr> |
| <tr class="memdesc:a99241e18fc7e404a97b405deebb95927"><td class="mdescLeft"> </td><td class="mdescRight">internal option, default to thread local <a href="classdmlc_1_1LuaState.html#a99241e18fc7e404a97b405deebb95927">More...</a><br /></td></tr> |
| <tr class="separator:a99241e18fc7e404a97b405deebb95927"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca1618783c1afc81b9f1dd0fb2512820"><td class="memItemLeft" align="right" valign="top">lua_State * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#aca1618783c1afc81b9f1dd0fb2512820">L_</a></td></tr> |
| <tr class="memdesc:aca1618783c1afc81b9f1dd0fb2512820"><td class="mdescLeft"> </td><td class="mdescRight">internal lua state <a href="classdmlc_1_1LuaState.html#aca1618783c1afc81b9f1dd0fb2512820">More...</a><br /></td></tr> |
| <tr class="separator:aca1618783c1afc81b9f1dd0fb2512820"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa745e60787db0b7d33894bb234352a19"><td class="memItemLeft" align="right" valign="top">std::mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#aa745e60787db0b7d33894bb234352a19">mutex_</a></td></tr> |
| <tr class="memdesc:aa745e60787db0b7d33894bb234352a19"><td class="mdescLeft"> </td><td class="mdescRight">internal lock about the state <a href="classdmlc_1_1LuaState.html#aa745e60787db0b7d33894bb234352a19">More...</a><br /></td></tr> |
| <tr class="separator:aa745e60787db0b7d33894bb234352a19"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:ad76f409b883ed4be17beb2f183154ec4"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#ad76f409b883ed4be17beb2f183154ec4">LuaRef</a></td></tr> |
| <tr class="separator:ad76f409b883ed4be17beb2f183154ec4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaba7c1ea3faf0c24670fb29976286c87"><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaState.html#aaba7c1ea3faf0c24670fb29976286c87">ThreadLocalStore< LuaState ></a></td></tr> |
| <tr class="separator:aaba7c1ea3faf0c24670fb29976286c87"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A Lua state. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="a00653ef79293ad2e4797326295028ce7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a00653ef79293ad2e4797326295028ce7">◆ </a></span>Option</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">dmlc::LuaState::Option</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>options to be provided in lua state </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a00653ef79293ad2e4797326295028ce7a6480c008fb889ce1b21c7a9180f993b2"></a>kNoThreadProtect </td><td class="fielddoc"></td></tr> |
| <tr><td class="fieldname"><a id="a00653ef79293ad2e4797326295028ce7a5350b9ee8b057163d888bfef054921f6"></a>kThreadLocal </td><td class="fielddoc"></td></tr> |
| <tr><td class="fieldname"><a id="a00653ef79293ad2e4797326295028ce7a7c8af5ada7569e1a33e4d075fed0b143"></a>kLocking </td><td class="fielddoc"></td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a1734dbf3c2f3f036773a7a257de055aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1734dbf3c2f3f036773a7a257de055aa">◆ </a></span>~LuaState()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::LuaState::~LuaState </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>destructor </p> |
| |
| </div> |
| </div> |
| <a id="ae76399cb24c8a82c491947f304ede429"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae76399cb24c8a82c491947f304ede429">◆ </a></span>LuaState()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::LuaState::LuaState </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>constructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a33446cb9b59326e0e7746bcf7cf46330"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a33446cb9b59326e0e7746bcf7cf46330">◆ </a></span>Convert()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> dmlc::LuaState::Convert </td> |
| <td>(</td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>convert a C++ type to lua type </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The data to be converted. vector, map will be converted to table. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a converted value. </dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type to be converted. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7dcdffce5b1f9526568f37b7d4e7b8f1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7dcdffce5b1f9526568f37b7d4e7b8f1">◆ </a></span>Create_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdmlc_1_1LuaState.html">LuaState</a>* dmlc::LuaState::Create_ </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">Option</a> </td> |
| <td class="paramname"><em>option</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Create a new lua state. </p><dl class="section note"><dt>Note</dt><dd>It is highly recommended to use ThreadLocalState instead.</dd></dl> |
| <p>Most Lua program assumes it only runs from the same thread. Some Lua code that wraps C library(e.g. Torch) could rely on thread_local storage to store global state such as random number generator. This means if the code is invoked by another thread, the thread_local might become inavailable, depending on the implementation.</p> |
| <p>If the global state is stored only in Lua's global table, then it is safe to use kLocking mode and call the code from multiple thread. Never-the-less, using ThreadLocalState removes the need to lock, and is the desirable usecase in most times.</p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classdmlc_1_1LuaState.html#a5eaebefa148bfd110e3c50b45154b221">ThreadLocalState</a> </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">option</td><td>The option to use the state. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a newly created lua state </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0d19f8d8507c33502ce4c00e1b1e5134"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0d19f8d8507c33502ce4c00e1b1e5134">◆ </a></span>Eval() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> dmlc::LuaState::Eval </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>lua_code</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>evaluate a piece of lua code, return the first result. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">lua_code</td><td>Lua code </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> object of the first returned result, Can be nil if the code did not return LuaRefthing. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a640071bc366a5bed96093191addc50f2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a640071bc366a5bed96093191addc50f2">◆ </a></span>Eval() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> dmlc::LuaState::Eval </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>lua_code</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>evaluate a piece of lua code, return the first result. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">lua_code</td><td>Lua code </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> object of the first returned result, Can be nil if the code did not return anything. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad9140fd83d79254f4a5f06e136f05602"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad9140fd83d79254f4a5f06e136f05602">◆ </a></span>operator[]()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> dmlc::LuaState::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get global field from the state </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>The key to the global field. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The global field value. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ade7455050ecf9d82053d2d71d1272a82"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ade7455050ecf9d82053d2d71d1272a82">◆ </a></span>PRun_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename F > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::LuaState::PRun_ </td> |
| <td>(</td> |
| <td class="paramtype">F </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>protected run f, this is used by API developers. always call this to access lua state f must not destruct <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a>, or access the mutex </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>the function to be called. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">F</td><td>the function to be called, signiture (lua_State *L) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a70e5476fac877e46a0f582fa76147618"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a70e5476fac877e46a0f582fa76147618">◆ </a></span>SameLuaState()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool dmlc::LuaState::SameLuaState </td> |
| <td>(</td> |
| <td class="paramtype">lua_State * </td> |
| <td class="paramname"><em>L</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">L</td><td>the other lua state. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>if the internal lua state is same as L </dd></dl> |
| |
| </div> |
| </div> |
| <a id="acff2a74578e591476dc2be889c7a4d4e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acff2a74578e591476dc2be889c7a4d4e">◆ </a></span>SetGlobalField()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::LuaState::SetGlobalField </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> & </td> |
| <td class="paramname"><em>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the value to the global table. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>The key of the global field. </td></tr> |
| <tr><td class="paramname">value</td><td>The value to the set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5eaebefa148bfd110e3c50b45154b221"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5eaebefa148bfd110e3c50b45154b221">◆ </a></span>ThreadLocalState()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdmlc_1_1LuaState.html">LuaState</a>* dmlc::LuaState::ThreadLocalState </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get a thread local version of lua state. The <a class="el" href="classdmlc_1_1LuaState.html" title="A Lua state.">LuaState</a> runs in thread local mode, all the <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> can only be run on the current thread. This is the recommended behavior when invoking Lua.</p> |
| <dl class="section return"><dt>Returns</dt><dd>a threadlocal version of lua state. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="ad76f409b883ed4be17beb2f183154ec4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad76f409b883ed4be17beb2f183154ec4">◆ </a></span>LuaRef</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend class <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aaba7c1ea3faf0c24670fb29976286c87"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaba7c1ea3faf0c24670fb29976286c87">◆ </a></span>ThreadLocalStore< LuaState ></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend struct <a class="el" href="classdmlc_1_1ThreadLocalStore.html">ThreadLocalStore</a>< <a class="el" href="classdmlc_1_1LuaState.html">LuaState</a> ></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="aca1618783c1afc81b9f1dd0fb2512820"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca1618783c1afc81b9f1dd0fb2512820">◆ </a></span>L_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">lua_State* dmlc::LuaState::L_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>internal lua state </p> |
| |
| </div> |
| </div> |
| <a id="aa745e60787db0b7d33894bb234352a19"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa745e60787db0b7d33894bb234352a19">◆ </a></span>mutex_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::mutex dmlc::LuaState::mutex_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>internal lock about the state </p> |
| |
| </div> |
| </div> |
| <a id="a99241e18fc7e404a97b405deebb95927"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a99241e18fc7e404a97b405deebb95927">◆ </a></span>option_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7">Option</a> dmlc::LuaState::option_ {<a class="el" href="classdmlc_1_1LuaState.html#a00653ef79293ad2e4797326295028ce7a5350b9ee8b057163d888bfef054921f6">kThreadLocal</a>}</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>internal option, default to thread local </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="lua_8h_source.html">lua.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 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> |