blob: 03ca273bf0c5913145c5d6d0fd2c438f246e8bbf [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: dmlc::ParserFactoryReg&lt; IndexType, DType &gt; Struct Template 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="structdmlc_1_1ParserFactoryReg-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::ParserFactoryReg&lt; IndexType, DType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>registry entry of parser factory
<a href="structdmlc_1_1ParserFactoryReg.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data_8h_source.html">data.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for dmlc::ParserFactoryReg&lt; IndexType, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structdmlc_1_1ParserFactoryReg__inherit__graph.png" border="0" usemap="#dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_inherit__map" id="dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_inherit__map">
<area shape="rect" id="node2" href="classdmlc_1_1FunctionRegEntryBase.html" title="{dmlc::FunctionRegEntryBase\l\&lt; ParserFactoryReg\&lt; IndexType,\l DType \&gt;, Parser\&lt; IndexType,\l DType \&gt;::Factory \&gt;\n|+ name\l+ description\l+ arguments\l+ body\l+ return_type\l|+ set_body()\l+ describe()\l+ add_argument()\l+ add_arguments()\l+ set_return_type()\l# self()\l}" alt="" coords="5,5,239,259"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for dmlc::ParserFactoryReg&lt; IndexType, DType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structdmlc_1_1ParserFactoryReg__coll__graph.png" border="0" usemap="#dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_coll__map" id="dmlc_1_1ParserFactoryReg_3_01IndexType_00_01DType_01_4_coll__map">
<area shape="rect" id="node2" href="classdmlc_1_1FunctionRegEntryBase.html" title="{dmlc::FunctionRegEntryBase\l\&lt; ParserFactoryReg\&lt; IndexType,\l DType \&gt;, Parser\&lt; IndexType,\l DType \&gt;::Factory \&gt;\n|+ name\l+ description\l+ arguments\l+ body\l+ return_type\l|+ set_body()\l+ describe()\l+ add_argument()\l+ add_arguments()\l+ set_return_type()\l# self()\l}" alt="" coords="5,5,239,259"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_classdmlc_1_1FunctionRegEntryBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdmlc_1_1FunctionRegEntryBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase&lt; ParserFactoryReg&lt; IndexType, DType &gt;, Parser&lt; IndexType, DType &gt;::Factory &gt;</a></td></tr>
<tr class="memitem:aae5d8d68715179c22059867aae4d67fc inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">set_body</a> (<a class="el" href="classdmlc_1_1Parser.html">Parser</a>&lt; IndexType, DType &gt;::Factory <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">body</a>)</td></tr>
<tr class="memdesc:aae5d8d68715179c22059867aae4d67fc inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the function body. <a href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">More...</a><br /></td></tr>
<tr class="separator:aae5d8d68715179c22059867aae4d67fc inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa523755edc43af8a7ae4dad12e187200 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">describe</a> (const std::string &amp;<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a>)</td></tr>
<tr class="memdesc:aa523755edc43af8a7ae4dad12e187200 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describe the function. <a href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">More...</a><br /></td></tr>
<tr class="separator:aa523755edc43af8a7ae4dad12e187200 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec3cb7574c8c2401e7dac0cccb352f31 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31">add_argument</a> (const std::string &amp;<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">name</a>, const std::string &amp;type, const std::string &amp;<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a>)</td></tr>
<tr class="memdesc:aec3cb7574c8c2401e7dac0cccb352f31 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add argument information to the function. <a href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31">More...</a><br /></td></tr>
<tr class="separator:aec3cb7574c8c2401e7dac0cccb352f31 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a349dbdc935529bc4ffa7385b5c45614f inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f">add_arguments</a> (const std::vector&lt; ParamFieldInfo &gt; &amp;args)</td></tr>
<tr class="memdesc:a349dbdc935529bc4ffa7385b5c45614f inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append list if arguments to the end. <a href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f">More...</a><br /></td></tr>
<tr class="separator:a349dbdc935529bc4ffa7385b5c45614f inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ee038abad273d717df33a4dbc88ef14 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">set_return_type</a> (const std::string &amp;type)</td></tr>
<tr class="memdesc:a2ee038abad273d717df33a4dbc88ef14 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the return type. <a href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">More...</a><br /></td></tr>
<tr class="separator:a2ee038abad273d717df33a4dbc88ef14 inherit pub_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classdmlc_1_1FunctionRegEntryBase')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase&lt; ParserFactoryReg&lt; IndexType, DType &gt;, Parser&lt; IndexType, DType &gt;::Factory &gt;</a></td></tr>
<tr class="memitem:af2acc06f141492afe85d4fff777d7f31 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">name</a></td></tr>
<tr class="memdesc:af2acc06f141492afe85d4fff777d7f31 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of the entry <a href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">More...</a><br /></td></tr>
<tr class="separator:af2acc06f141492afe85d4fff777d7f31 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9de2f3ee312f470556e73ab56288ae25 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a></td></tr>
<tr class="memdesc:a9de2f3ee312f470556e73ab56288ae25 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">description of the entry <a href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">More...</a><br /></td></tr>
<tr class="separator:a9de2f3ee312f470556e73ab56288ae25 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6565edeffefa127ea939f9ff9774d09d inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top">std::vector&lt; ParamFieldInfo &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d">arguments</a></td></tr>
<tr class="memdesc:a6565edeffefa127ea939f9ff9774d09d inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">additional arguments to the factory function <a href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d">More...</a><br /></td></tr>
<tr class="separator:a6565edeffefa127ea939f9ff9774d09d inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac593e3ad3722e750b01b110ae01dd5ee inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1Parser.html">Parser</a>&lt; IndexType, DType &gt;::Factory&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">body</a></td></tr>
<tr class="memdesc:ac593e3ad3722e750b01b110ae01dd5ee inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function body to create ProductType. <a href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">More...</a><br /></td></tr>
<tr class="separator:ac593e3ad3722e750b01b110ae01dd5ee inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8187718b95987b655716c2de9bbe7b06 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06">return_type</a></td></tr>
<tr class="memdesc:a8187718b95987b655716c2de9bbe7b06 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return type of the function. <a href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06">More...</a><br /></td></tr>
<tr class="separator:a8187718b95987b655716c2de9bbe7b06 inherit pub_attribs_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classdmlc_1_1FunctionRegEntryBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classdmlc_1_1FunctionRegEntryBase')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase&lt; ParserFactoryReg&lt; IndexType, DType &gt;, Parser&lt; IndexType, DType &gt;::Factory &gt;</a></td></tr>
<tr class="memitem:a6c04cf9a322f60d106af1f0b4826f586 inherit pro_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdmlc_1_1ParserFactoryReg.html">ParserFactoryReg</a>&lt; IndexType, DType &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a6c04cf9a322f60d106af1f0b4826f586">self</a> ()</td></tr>
<tr class="separator:a6c04cf9a322f60d106af1f0b4826f586 inherit pro_methods_classdmlc_1_1FunctionRegEntryBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename IndexType, typename DType = real_t&gt;<br />
struct dmlc::ParserFactoryReg&lt; IndexType, DType &gt;</h3>
<p>registry entry of parser factory </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">IndexType</td><td>The type of index </td></tr>
<tr><td class="paramname">DType</td><td>The type of label and value </td></tr>
</table>
</dd>
</dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="data_8h_source.html">data.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>