Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / classdmlc_1_1LuaRef.html
blob: d7a4fab751352ee68e95d4474fd506bbcb9533e8 [file] [log] [blame]
<!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::LuaRef 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&amp;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&amp;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_1LuaRef.html">LuaRef</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classdmlc_1_1LuaRef-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::LuaRef Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>an reference to lua object
<a href="classdmlc_1_1LuaRef.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="lua_8h_source.html">lua.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::LuaRef:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1LuaRef__coll__graph.png" border="0" usemap="#dmlc_1_1LuaRef_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<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:ad23fff4bb8e821afb892c144c7f1ce5d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#ad23fff4bb8e821afb892c144c7f1ce5d">LuaRef</a> ()=default</td></tr>
<tr class="memdesc:ad23fff4bb8e821afb892c144c7f1ce5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">construct an nil ref <a href="classdmlc_1_1LuaRef.html#ad23fff4bb8e821afb892c144c7f1ce5d">More...</a><br /></td></tr>
<tr class="separator:ad23fff4bb8e821afb892c144c7f1ce5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55c013902c3cf966acf3be8c726ad4e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a55c013902c3cf966acf3be8c726ad4e8">LuaRef</a> (<a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&amp;other)</td></tr>
<tr class="memdesc:a55c013902c3cf966acf3be8c726ad4e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">move constructor from another <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> <a href="classdmlc_1_1LuaRef.html#a55c013902c3cf966acf3be8c726ad4e8">More...</a><br /></td></tr>
<tr class="separator:a55c013902c3cf966acf3be8c726ad4e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a781844328d26ca6674276c8eab45c689"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a781844328d26ca6674276c8eab45c689">LuaRef</a> (const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;other)</td></tr>
<tr class="memdesc:a781844328d26ca6674276c8eab45c689"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor <a href="classdmlc_1_1LuaRef.html#a781844328d26ca6674276c8eab45c689">More...</a><br /></td></tr>
<tr class="separator:a781844328d26ca6674276c8eab45c689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4767414e9463eeb59728b65babed6cf6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a4767414e9463eeb59728b65babed6cf6">operator=</a> (<a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&amp;other)</td></tr>
<tr class="memdesc:a4767414e9463eeb59728b65babed6cf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">assign operator from other <a href="classdmlc_1_1LuaRef.html#a4767414e9463eeb59728b65babed6cf6">More...</a><br /></td></tr>
<tr class="separator:a4767414e9463eeb59728b65babed6cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacf6a1947887a2b541caa18bda33b259"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#aacf6a1947887a2b541caa18bda33b259">operator=</a> (const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;other)</td></tr>
<tr class="memdesc:aacf6a1947887a2b541caa18bda33b259"><td class="mdescLeft">&#160;</td><td class="mdescRight">assign operator from other <a href="classdmlc_1_1LuaRef.html#aacf6a1947887a2b541caa18bda33b259">More...</a><br /></td></tr>
<tr class="separator:aacf6a1947887a2b541caa18bda33b259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab97c83cda0db04b89cb587ee54d5b3ec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#ab97c83cda0db04b89cb587ee54d5b3ec">~LuaRef</a> ()</td></tr>
<tr class="memdesc:ab97c83cda0db04b89cb587ee54d5b3ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="classdmlc_1_1LuaRef.html#ab97c83cda0db04b89cb587ee54d5b3ec">More...</a><br /></td></tr>
<tr class="separator:ab97c83cda0db04b89cb587ee54d5b3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a500b446e89436303fbdf50af76c78308"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a500b446e89436303fbdf50af76c78308">swap</a> (<a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;other)</td></tr>
<tr class="memdesc:a500b446e89436303fbdf50af76c78308"><td class="mdescLeft">&#160;</td><td class="mdescRight">swap content with another ref <a href="classdmlc_1_1LuaRef.html#a500b446e89436303fbdf50af76c78308">More...</a><br /></td></tr>
<tr class="separator:a500b446e89436303fbdf50af76c78308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c914179f15723b62e58057becf7ba5a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a2c914179f15723b62e58057becf7ba5a"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a2c914179f15723b62e58057becf7ba5a">Get</a> () const</td></tr>
<tr class="memdesc:a2c914179f15723b62e58057becf7ba5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get content out as type T. <a href="classdmlc_1_1LuaRef.html#a2c914179f15723b62e58057becf7ba5a">More...</a><br /></td></tr>
<tr class="separator:a2c914179f15723b62e58057becf7ba5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03de3ceda60bec3096850404200d035f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a03de3ceda60bec3096850404200d035f"><td class="memTemplItemLeft" align="right" valign="top">T *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a03de3ceda60bec3096850404200d035f">GetUDataPtr</a> () const</td></tr>
<tr class="memdesc:a03de3ceda60bec3096850404200d035f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get user data pointer from <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a>. <a href="classdmlc_1_1LuaRef.html#a03de3ceda60bec3096850404200d035f">More...</a><br /></td></tr>
<tr class="separator:a03de3ceda60bec3096850404200d035f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae34de268bd2fbe266baa875d87803ccf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#ae34de268bd2fbe266baa875d87803ccf">is_nil</a> () const</td></tr>
<tr class="separator:ae34de268bd2fbe266baa875d87803ccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4fddefd9dd3dae96a2c555c5479e403"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:ae4fddefd9dd3dae96a2c555c5479e403"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#ae4fddefd9dd3dae96a2c555c5479e403">operator()</a> (Args &amp;&amp;...args) const</td></tr>
<tr class="memdesc:ae4fddefd9dd3dae96a2c555c5479e403"><td class="mdescLeft">&#160;</td><td class="mdescRight">invoke the <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> as function <a href="classdmlc_1_1LuaRef.html#ae4fddefd9dd3dae96a2c555c5479e403">More...</a><br /></td></tr>
<tr class="separator:ae4fddefd9dd3dae96a2c555c5479e403"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf490ec150141576d8cad9da826d8a0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#acf490ec150141576d8cad9da826d8a0c">operator[]</a> (const std::string &amp;key) const</td></tr>
<tr class="memdesc:acf490ec150141576d8cad9da826d8a0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get field from the lua table. The reference must be a table. <a href="classdmlc_1_1LuaRef.html#acf490ec150141576d8cad9da826d8a0c">More...</a><br /></td></tr>
<tr class="separator:acf490ec150141576d8cad9da826d8a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8866487d6c0e889165c3c9ef03328590"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a8866487d6c0e889165c3c9ef03328590">operator[]</a> (size_t index) const</td></tr>
<tr class="memdesc:a8866487d6c0e889165c3c9ef03328590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get field from the lua array The reference must be a array. <a href="classdmlc_1_1LuaRef.html#a8866487d6c0e889165c3c9ef03328590">More...</a><br /></td></tr>
<tr class="separator:a8866487d6c0e889165c3c9ef03328590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bdf62b429d73a5b50d73fb7f7358e16"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a1bdf62b429d73a5b50d73fb7f7358e16"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a1bdf62b429d73a5b50d73fb7f7358e16">SetField</a> (const std::string &amp;key, const T &amp;value)</td></tr>
<tr class="memdesc:a1bdf62b429d73a5b50d73fb7f7358e16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set field of lua table. The reference must be a table. <a href="classdmlc_1_1LuaRef.html#a1bdf62b429d73a5b50d73fb7f7358e16">More...</a><br /></td></tr>
<tr class="separator:a1bdf62b429d73a5b50d73fb7f7358e16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd04623a03af2f2d0ca2c3a1d58c6f05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#abd04623a03af2f2d0ca2c3a1d58c6f05">SetByPopStack_</a> (<a class="el" href="classdmlc_1_1LuaState.html">LuaState</a> *s)</td></tr>
<tr class="memdesc:abd04623a03af2f2d0ca2c3a1d58c6f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to the value on top of the stack. This state must be nil. This is API used by developer. <a href="classdmlc_1_1LuaRef.html#abd04623a03af2f2d0ca2c3a1d58c6f05">More...</a><br /></td></tr>
<tr class="separator:abd04623a03af2f2d0ca2c3a1d58c6f05"><td class="memSeparator" colspan="2">&#160;</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:a97a0aabb9d8d59dbccf720f68ecc951b"><td class="memItemLeft" align="right" valign="top">struct&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a97a0aabb9d8d59dbccf720f68ecc951b">lua_stack::Handler&lt; LuaRef &gt;</a></td></tr>
<tr class="separator:a97a0aabb9d8d59dbccf720f68ecc951b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9aa251d710bba4f257a519ebc5d01d51"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a9aa251d710bba4f257a519ebc5d01d51">LuaState</a></td></tr>
<tr class="separator:a9aa251d710bba4f257a519ebc5d01d51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e27b89ec3ca72252e3e63920f7f003"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1LuaRef.html#a61e27b89ec3ca72252e3e63920f7f003">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;r)</td></tr>
<tr class="separator:a61e27b89ec3ca72252e3e63920f7f003"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>an reference to lua object </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad23fff4bb8e821afb892c144c7f1ce5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad23fff4bb8e821afb892c144c7f1ce5d">&#9670;&nbsp;</a></span>LuaRef() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::LuaRef::LuaRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>construct an nil ref </p>
</div>
</div>
<a id="a55c013902c3cf966acf3be8c726ad4e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55c013902c3cf966acf3be8c726ad4e8">&#9670;&nbsp;</a></span>LuaRef() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::LuaRef::LuaRef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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>move constructor from another <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to be moved </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a781844328d26ca6674276c8eab45c689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a781844328d26ca6674276c8eab45c689">&#9670;&nbsp;</a></span>LuaRef() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::LuaRef::LuaRef </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>copy constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to be copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab97c83cda0db04b89cb587ee54d5b3ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab97c83cda0db04b89cb587ee54d5b3ec">&#9670;&nbsp;</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">dmlc::LuaRef::~LuaRef </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2c914179f15723b62e58057becf7ba5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c914179f15723b62e58057becf7ba5a">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T dmlc::LuaRef::Get </td>
<td>(</td>
<td class="paramname"></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">
<p>Get content out as type T. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the type to be fetched. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding c type. </dd></dl>
</div>
</div>
<a id="a03de3ceda60bec3096850404200d035f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03de3ceda60bec3096850404200d035f">&#9670;&nbsp;</a></span>GetUDataPtr()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* dmlc::LuaRef::GetUDataPtr </td>
<td>(</td>
<td class="paramname"></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">
<p>Get user data pointer from <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a>. </p>
<p>CAREFUL when getting userdata(e.g. pointer to Tensor's storage) from <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a>. Remember they are managed by Lua, and can get deleted when all the <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to the userdata destructs. A good practice is always use a <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to keep the userdata alive when you need them from C++ side.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the type of pointer to be fetched. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding c type. </dd></dl>
</div>
</div>
<a id="ae34de268bd2fbe266baa875d87803ccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae34de268bd2fbe266baa875d87803ccf">&#9670;&nbsp;</a></span>is_nil()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::LuaRef::is_nil </td>
<td>(</td>
<td class="paramname"></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="section return"><dt>Returns</dt><dd>whether the value is nil </dd></dl>
</div>
</div>
<a id="ae4fddefd9dd3dae96a2c555c5479e403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4fddefd9dd3dae96a2c555c5479e403">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Args&gt; </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::LuaRef::operator() </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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">
<p>invoke the <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> as function </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Arguments to be passed. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Args</td><td>arguments to be passed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The first return value. </dd></dl>
</div>
</div>
<a id="aacf6a1947887a2b541caa18bda33b259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacf6a1947887a2b541caa18bda33b259">&#9670;&nbsp;</a></span>operator=() <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>&amp; dmlc::LuaRef::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>assign operator from other </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to be copy or moved. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>self </dd></dl>
</div>
</div>
<a id="a4767414e9463eeb59728b65babed6cf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4767414e9463eeb59728b65babed6cf6">&#9670;&nbsp;</a></span>operator=() <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>&amp; dmlc::LuaRef::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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>assign operator from other </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to be copy or moved. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>self </dd></dl>
</div>
</div>
<a id="acf490ec150141576d8cad9da826d8a0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf490ec150141576d8cad9da826d8a0c">&#9670;&nbsp;</a></span>operator[]() <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::LuaRef::operator[] </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</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">
<p>Get field from the lua table. The reference must be a table. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to the table </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new ref to the corresponding field. </dd></dl>
</div>
</div>
<a id="a8866487d6c0e889165c3c9ef03328590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8866487d6c0e889165c3c9ef03328590">&#9670;&nbsp;</a></span>operator[]() <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::LuaRef::operator[] </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>index</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">
<p>Get field from the lua array The reference must be a array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index to the array, Note: the index convention follows lua table, starts from 1 </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new ref to the corresponding field. </dd></dl>
</div>
</div>
<a id="abd04623a03af2f2d0ca2c3a1d58c6f05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd04623a03af2f2d0ca2c3a1d58c6f05">&#9670;&nbsp;</a></span>SetByPopStack_()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::LuaRef::SetByPopStack_ </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1LuaState.html">LuaState</a> *&#160;</td>
<td class="paramname"><em>s</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>Set <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to the value on top of the stack. This state must be nil. This is API used by developer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the corresponding lua state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1bdf62b429d73a5b50d73fb7f7358e16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bdf62b429d73a5b50d73fb7f7358e16">&#9670;&nbsp;</a></span>SetField()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&amp; dmlc::LuaRef::SetField </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</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 field of lua table. The reference must be a table. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to the table </td></tr>
<tr><td class="paramname">value</td><td>Lua convertable value to be setted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>self. </dd></dl>
</div>
</div>
<a id="a500b446e89436303fbdf50af76c78308"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a500b446e89436303fbdf50af76c78308">&#9670;&nbsp;</a></span>swap()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::LuaRef::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td>
<td class="paramname"><em>other</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>swap content with another ref </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>another <a class="el" href="classdmlc_1_1LuaRef.html" title="an reference to lua object">LuaRef</a> to be swaped. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a97a0aabb9d8d59dbccf720f68ecc951b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97a0aabb9d8d59dbccf720f68ecc951b">&#9670;&nbsp;</a></span>lua_stack::Handler&lt; LuaRef &gt;</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="structdmlc_1_1lua__stack_1_1Handler.html">lua_stack::Handler</a>&lt; <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &gt;</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="a9aa251d710bba4f257a519ebc5d01d51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9aa251d710bba4f257a519ebc5d01d51">&#9670;&nbsp;</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">friend class <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>
<a id="a61e27b89ec3ca72252e3e63920f7f003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61e27b89ec3ca72252e3e63920f7f003">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdmlc_1_1LuaRef.html">LuaRef</a> &amp;&#160;</td>
<td class="paramname"><em>r</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>
<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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>