| <!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::FunctionRegEntryBase< EntryType, FunctionType > Class 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.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_1FunctionRegEntryBase.html">FunctionRegEntryBase</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classdmlc_1_1FunctionRegEntryBase-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::FunctionRegEntryBase< EntryType, FunctionType > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Common base class for function registry. |
| <a href="classdmlc_1_1FunctionRegEntryBase.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_source.html">registry.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::FunctionRegEntryBase< EntryType, FunctionType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1FunctionRegEntryBase__coll__graph.png" border="0" usemap="#dmlc_1_1FunctionRegEntryBase_3_01EntryType_00_01FunctionType_01_4_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:aae5d8d68715179c22059867aae4d67fc"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">set_body</a> (FunctionType <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">body</a>)</td></tr> |
| <tr class="memdesc:aae5d8d68715179c22059867aae4d67fc"><td class="mdescLeft"> </td><td class="mdescRight">Set the function body. <a href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">More...</a><br /></td></tr> |
| <tr class="separator:aae5d8d68715179c22059867aae4d67fc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa523755edc43af8a7ae4dad12e187200"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">describe</a> (const std::string &<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a>)</td></tr> |
| <tr class="memdesc:aa523755edc43af8a7ae4dad12e187200"><td class="mdescLeft"> </td><td class="mdescRight">Describe the function. <a href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">More...</a><br /></td></tr> |
| <tr class="separator:aa523755edc43af8a7ae4dad12e187200"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec3cb7574c8c2401e7dac0cccb352f31"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31">add_argument</a> (const std::string &<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">name</a>, const std::string &type, const std::string &<a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a>)</td></tr> |
| <tr class="memdesc:aec3cb7574c8c2401e7dac0cccb352f31"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a349dbdc935529bc4ffa7385b5c45614f"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f">add_arguments</a> (const std::vector< ParamFieldInfo > &args)</td></tr> |
| <tr class="memdesc:a349dbdc935529bc4ffa7385b5c45614f"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ee038abad273d717df33a4dbc88ef14"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">set_return_type</a> (const std::string &type)</td></tr> |
| <tr class="memdesc:a2ee038abad273d717df33a4dbc88ef14"><td class="mdescLeft"> </td><td class="mdescRight">Set the return type. <a href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">More...</a><br /></td></tr> |
| <tr class="separator:a2ee038abad273d717df33a4dbc88ef14"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:af2acc06f141492afe85d4fff777d7f31"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">name</a></td></tr> |
| <tr class="memdesc:af2acc06f141492afe85d4fff777d7f31"><td class="mdescLeft"> </td><td class="mdescRight">name of the entry <a href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">More...</a><br /></td></tr> |
| <tr class="separator:af2acc06f141492afe85d4fff777d7f31"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9de2f3ee312f470556e73ab56288ae25"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a></td></tr> |
| <tr class="memdesc:a9de2f3ee312f470556e73ab56288ae25"><td class="mdescLeft"> </td><td class="mdescRight">description of the entry <a href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">More...</a><br /></td></tr> |
| <tr class="separator:a9de2f3ee312f470556e73ab56288ae25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6565edeffefa127ea939f9ff9774d09d"><td class="memItemLeft" align="right" valign="top">std::vector< ParamFieldInfo > </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d">arguments</a></td></tr> |
| <tr class="memdesc:a6565edeffefa127ea939f9ff9774d09d"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac593e3ad3722e750b01b110ae01dd5ee"><td class="memItemLeft" align="right" valign="top">FunctionType </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">body</a></td></tr> |
| <tr class="memdesc:ac593e3ad3722e750b01b110ae01dd5ee"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8187718b95987b655716c2de9bbe7b06"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06">return_type</a></td></tr> |
| <tr class="memdesc:a8187718b95987b655716c2de9bbe7b06"><td class="mdescLeft"> </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"><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:a6c04cf9a322f60d106af1f0b4826f586"><td class="memItemLeft" align="right" valign="top">EntryType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1FunctionRegEntryBase.html#a6c04cf9a322f60d106af1f0b4826f586">self</a> ()</td></tr> |
| <tr class="separator:a6c04cf9a322f60d106af1f0b4826f586"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename EntryType, typename FunctionType><br /> |
| class dmlc::FunctionRegEntryBase< EntryType, FunctionType ></h3> |
| |
| <p>Common base class for function registry. </p> |
| <div class="fragment"><div class="line"><span class="comment">// This example demonstrates how to use Registry to create a factory of trees.</span></div> |
| <div class="line"><span class="keyword">struct </span>TreeFactory :</div> |
| <div class="line"> <span class="keyword">public</span> FunctionRegEntryBase<TreeFactory, std::function<Tree*()> > {</div> |
| <div class="line">};</div> |
| <div class="line"> </div> |
| <div class="line"><span class="comment">// in a independent cc file</span></div> |
| <div class="line"><span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div> |
| <div class="line"><a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#a30edfc9f7bcb9862348b512dd73354ff">DMLC_REGISTRY_ENABLE</a>(TreeFactory);</div> |
| <div class="line">}</div> |
| <div class="line"><span class="comment">// register binary tree constructor into the registry.</span></div> |
| <div class="line"><a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a>(TreeFactory, TreeFactory, BinaryTree)</div> |
| <div class="line"> .describe(<span class="stringliteral">"Constructor of BinaryTree"</span>)</div> |
| <div class="line"> .set_body([]() { <span class="keywordflow">return</span> <span class="keyword">new</span> BinaryTree(); });</div> |
| </div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">EntryType</td><td>The type of subclass that inheritate the base. </td></tr> |
| <tr><td class="paramname">FunctionType</td><td>The function type this registry is registerd. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aec3cb7574c8c2401e7dac0cccb352f31"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aec3cb7574c8c2401e7dac0cccb352f31">◆ </a></span>add_argument()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::add_argument </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>description</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>Add argument information to the function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Name of the argument. </td></tr> |
| <tr><td class="paramname">type</td><td>Type of the argument. </td></tr> |
| <tr><td class="paramname">description</td><td>Description of the argument. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a349dbdc935529bc4ffa7385b5c45614f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a349dbdc935529bc4ffa7385b5c45614f">◆ </a></span>add_arguments()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::add_arguments </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< ParamFieldInfo > & </td> |
| <td class="paramname"><em>args</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>Append list if arguments to the end. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">args</td><td>Additional list of arguments. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa523755edc43af8a7ae4dad12e187200"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa523755edc43af8a7ae4dad12e187200">◆ </a></span>describe()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::describe </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>description</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>Describe the function. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">description</td><td>The description of the factory function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6c04cf9a322f60d106af1f0b4826f586"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6c04cf9a322f60d106af1f0b4826f586">◆ </a></span>self()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::self </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"> |
| <dl class="section return"><dt>Returns</dt><dd>reference of self as derived type </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aae5d8d68715179c22059867aae4d67fc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aae5d8d68715179c22059867aae4d67fc">◆ </a></span>set_body()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::set_body </td> |
| <td>(</td> |
| <td class="paramtype">FunctionType </td> |
| <td class="paramname"><em>body</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 the function body. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">body</td><td>Function body to set. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a2ee038abad273d717df33a4dbc88ef14"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ee038abad273d717df33a4dbc88ef14">◆ </a></span>set_return_type()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EntryType& <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::set_return_type </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>type</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 the return type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">type</td><td>Return type of the function, could be Symbol or Symbol[] </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to self. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a6565edeffefa127ea939f9ff9774d09d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6565edeffefa127ea939f9ff9774d09d">◆ </a></span>arguments</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<ParamFieldInfo> <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::arguments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>additional arguments to the factory function </p> |
| |
| </div> |
| </div> |
| <a id="ac593e3ad3722e750b01b110ae01dd5ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac593e3ad3722e750b01b110ae01dd5ee">◆ </a></span>body</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">FunctionType <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::body</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Function body to create ProductType. </p> |
| |
| </div> |
| </div> |
| <a id="a9de2f3ee312f470556e73ab56288ae25"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9de2f3ee312f470556e73ab56288ae25">◆ </a></span>description</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::description</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>description of the entry </p> |
| |
| </div> |
| </div> |
| <a id="af2acc06f141492afe85d4fff777d7f31"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af2acc06f141492afe85d4fff777d7f31">◆ </a></span>name</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::name</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>name of the entry </p> |
| |
| </div> |
| </div> |
| <a id="a8187718b95987b655716c2de9bbe7b06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8187718b95987b655716c2de9bbe7b06">◆ </a></span>return_type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename EntryType , typename FunctionType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a>< EntryType, FunctionType >::return_type</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return type of the function. </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="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_source.html">registry.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <div class="ttc" id="a3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_html_a30edfc9f7bcb9862348b512dd73354ff"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#a30edfc9f7bcb9862348b512dd73354ff">DMLC_REGISTRY_ENABLE</a></div><div class="ttdeci">#define DMLC_REGISTRY_ENABLE(EntryType)</div><div class="ttdoc">Macro to enable the registry of EntryType. This macro must be used under namespace dmlc,...</div><div class="ttdef"><b>Definition:</b> registry.h:234</div></div> |
| <div class="ttc" id="anamespacedmlc_html"><div class="ttname"><a href="namespacedmlc.html">dmlc</a></div><div class="ttdoc">namespace for dmlc</div><div class="ttdef"><b>Definition:</b> array_view.h:12</div></div> |
| <div class="ttc" id="a3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_html_af6870c3bce5b56d427a4d225b1194816"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816">DMLC_REGISTRY_REGISTER</a></div><div class="ttdeci">#define DMLC_REGISTRY_REGISTER(EntryType, EntryTypeName, Name)</div><div class="ttdoc">Generic macro to register an EntryType There is a complete example in FactoryRegistryEntryBase.</div><div class="ttdef"><b>Definition:</b> registry.h:250</div></div> |
| <!-- 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> |
