Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / 3rdparty_2dmlc-core_2include_2dmlc_2registry_8h_source.html
blob: 85274c2f0c462893db7d9fc859996697339c5a60 [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: /work/mxnet/3rdparty/dmlc-core/include/dmlc/registry.h Source File</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="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">registry.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef DMLC_REGISTRY_H_</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define DMLC_REGISTRY_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html">./base.h</a>&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;./logging.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="parameter_8h.html">./parameter.h</a>&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="type__traits_8h.html">./type_traits.h</a>&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> EntryType&gt;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1Registry.html">Registry</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a7332aad0c884773f70eb9fdd30344e6a"> 30</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::vector&lt;const EntryType*&gt;&amp; <a class="code" href="classdmlc_1_1Registry.html#a7332aad0c884773f70eb9fdd30344e6a">List</a>() {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">Get</a>()-&gt;const_list_;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a32cd6bfc4ed75261eef555da8310ec30"> 34</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">static</span> std::vector&lt;std::string&gt; <a class="code" href="classdmlc_1_1Registry.html#a32cd6bfc4ed75261eef555da8310ec30">ListAllNames</a>() {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> std::map&lt;std::string, EntryType*&gt; &amp;fmap = <a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">Get</a>()-&gt;fmap_;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">typename</span> std::map&lt;std::string, EntryType*&gt;::const_iterator p;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::vector&lt;std::string&gt; names;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">for</span> (p = fmap.begin(); p !=fmap.end(); ++p) {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; names.push_back(p-&gt;first);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> names;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a9cd0277c8d3da72b3c85d48f662e7faa"> 48</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> EntryType *<a class="code" href="classdmlc_1_1Registry.html#a9cd0277c8d3da72b3c85d48f662e7faa">Find</a>(<span class="keyword">const</span> std::string &amp;name) {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> std::map&lt;std::string, EntryType*&gt; &amp;fmap = <a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">Get</a>()-&gt;fmap_;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">typename</span> std::map&lt;std::string, EntryType*&gt;::const_iterator p = fmap.find(name);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (p != fmap.end()) {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> p-&gt;second;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> NULL;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a53edeb1439d0c6b63bb08f26c010be02"> 62</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1Registry.html#a53edeb1439d0c6b63bb08f26c010be02">AddAlias</a>(<span class="keyword">const</span> std::string&amp; key_name,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">const</span> std::string&amp; alias) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; EntryType* e = fmap_.at(key_name);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">if</span> (fmap_.count(alias)) {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; CHECK_EQ(e, fmap_.at(alias))</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; &lt;&lt; <span class="stringliteral">&quot;Trying to register alias &quot;</span> &lt;&lt; alias &lt;&lt; <span class="stringliteral">&quot; for key &quot;</span> &lt;&lt; key_name</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; &lt;&lt; <span class="stringliteral">&quot; but &quot;</span> &lt;&lt; alias &lt;&lt; <span class="stringliteral">&quot; is already taken&quot;</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; fmap_[alias] = e;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a0b71def33966eca79ad304b9da04fecc"> 78</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1Registry.html#a0b71def33966eca79ad304b9da04fecc">__REGISTER__</a>(<span class="keyword">const</span> std::string&amp; name) {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::lock_guard&lt;std::mutex&gt; guard(registering_mutex);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">if</span> (fmap_.count(name) &gt; 0) {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">return</span> *fmap_[name];</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; EntryType *e = <span class="keyword">new</span> EntryType();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; e-&gt;name = name;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; fmap_[name] = e;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; const_list_.push_back(e);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; entry_list_.push_back(e);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> *e;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classdmlc_1_1Registry.html#a92bb4906a07d6b41cc3b3a52cc929440"> 95</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1Registry.html#a92bb4906a07d6b41cc3b3a52cc929440">__REGISTER_OR_GET__</a>(<span class="keyword">const</span> std::string&amp; name) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">if</span> (fmap_.count(name) == 0) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1Registry.html#a0b71def33966eca79ad304b9da04fecc">__REGISTER__</a>(name);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> *fmap_.at(name);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">static</span> <a class="code" href="classdmlc_1_1Registry.html">Registry</a> *<a class="code" href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">Get</a>();</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; std::vector&lt;EntryType*&gt; entry_list_;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; std::vector&lt;const EntryType*&gt; const_list_;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; std::map&lt;std::string, EntryType*&gt; fmap_;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; std::mutex registering_mutex;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <a class="code" href="classdmlc_1_1Registry.html">Registry</a>() {}</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; ~<a class="code" href="classdmlc_1_1Registry.html">Registry</a>() {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; entry_list_.size(); ++i) {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">delete</span> entry_list_[i];</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; }</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;};</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> EntryType, <span class="keyword">typename</span> FunctionType&gt;</div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html"> 151</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1FunctionRegEntryBase.html">FunctionRegEntryBase</a> {</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00154"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31"> 154</a></span>&#160; std::string <a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">name</a>;</div><div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25"> 156</a></span>&#160; std::string <a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">description</a>;</div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d"> 158</a></span>&#160; std::vector&lt;ParamFieldInfo&gt; <a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d">arguments</a>;</div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee"> 160</a></span>&#160; FunctionType <a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">body</a>;</div><div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06"> 162</a></span>&#160; std::string <a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06">return_type</a>;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div><div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc"> 169</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">set_body</a>(FunctionType body) {</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; this-&gt;body = body;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordflow">return</span> this-&gt;<span class="keyword">self</span>();</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; }</div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200"> 178</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">describe</a>(<span class="keyword">const</span> std::string &amp;description) {</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; this-&gt;description = description;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordflow">return</span> this-&gt;<span class="keyword">self</span>();</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; }</div><div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31"> 189</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31">add_argument</a>(<span class="keyword">const</span> std::string &amp;name,</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keyword">const</span> std::string &amp;type,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keyword">const</span> std::string &amp;description) {</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; ParamFieldInfo info;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; info.name = name;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; info.type = type;</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; info.type_info_str = info.type;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; info.description = description;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; arguments.push_back(info);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keywordflow">return</span> this-&gt;<span class="keyword">self</span>();</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; }</div><div class="line"><a name="l00205"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f"> 205</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f">add_arguments</a>(<span class="keyword">const</span> std::vector&lt;ParamFieldInfo&gt; &amp;args) {</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; arguments.insert(arguments.end(), args.begin(), args.end());</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="keywordflow">return</span> this-&gt;<span class="keyword">self</span>();</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; }</div><div class="line"><a name="l00214"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14"> 214</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<a class="code" href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">set_return_type</a>(<span class="keyword">const</span> std::string &amp;type) {</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; return_type = type;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordflow">return</span> this-&gt;<span class="keyword">self</span>();</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; }</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00223"></a><span class="lineno"><a class="line" href="classdmlc_1_1FunctionRegEntryBase.html#a6c04cf9a322f60d106af1f0b4826f586"> 223</a></span>&#160; <span class="keyword">inline</span> EntryType &amp;<span class="keyword">self</span>() {</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keywordflow">return</span> *(<span class="keyword">static_cast&lt;</span>EntryType*<span class="keyword">&gt;</span>(<span class="keyword">this</span>));</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; }</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;};</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#a30edfc9f7bcb9862348b512dd73354ff"> 234</a></span>&#160;<span class="preprocessor">#define DMLC_REGISTRY_ENABLE(EntryType) \</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;<span class="preprocessor"> template&lt;&gt; \</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="preprocessor"> Registry&lt;EntryType &gt; *Registry&lt;EntryType &gt;::Get() { \</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="preprocessor"> static Registry&lt;EntryType &gt; inst; \</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;<span class="preprocessor"> return &amp;inst; \</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="preprocessor"> } \</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="preprocessor"></span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;</div><div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#af6870c3bce5b56d427a4d225b1194816"> 250</a></span>&#160;<span class="preprocessor">#define DMLC_REGISTRY_REGISTER(EntryType, EntryTypeName, Name) \</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;<span class="preprocessor"> static DMLC_ATTRIBUTE_UNUSED EntryType &amp; __make_ ## EntryTypeName ## _ ## Name ## __ = \</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;<span class="preprocessor"> ::dmlc::Registry&lt;EntryType&gt;::Get()-&gt;__REGISTER__(#Name) \</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;<span class="preprocessor"></span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;</div><div class="line"><a name="l00263"></a><span class="lineno"><a class="line" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#a4948c95b9237182a8c10fb02bb3e9dc2"> 263</a></span>&#160;<span class="preprocessor">#define DMLC_REGISTRY_FILE_TAG(UniqueTag) \</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="preprocessor"> int __dmlc_registry_file_tag_ ## UniqueTag ## __() { return 0; }</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;</div><div class="line"><a name="l00305"></a><span class="lineno"><a class="line" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html#a7b08353ab775fb48862638173cf1ce38"> 305</a></span>&#160;<span class="preprocessor">#define DMLC_REGISTRY_LINK_TAG(UniqueTag) \</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="preprocessor"> int __dmlc_registry_file_tag_ ## UniqueTag ## __(); \</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<span class="preprocessor"> static int DMLC_ATTRIBUTE_UNUSED __reg_file_tag_ ## UniqueTag ## __ = \</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<span class="preprocessor"> __dmlc_registry_file_tag_ ## UniqueTag ## __();</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;} <span class="comment">// namespace dmlc</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="preprocessor">#endif // DMLC_REGISTRY_H_</span></div><div class="ttc" id="classdmlc_1_1Registry_html"><div class="ttname"><a href="classdmlc_1_1Registry.html">dmlc::Registry</a></div><div class="ttdoc">Registry class. Registry can be used to register global singletons. The most commonly use case are fa...</div><div class="ttdef"><b>Definition:</b> registry.h:27</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html">dmlc::FunctionRegEntryBase</a></div><div class="ttdoc">Common base class for function registry. </div><div class="ttdef"><b>Definition:</b> registry.h:151</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a53edeb1439d0c6b63bb08f26c010be02"><div class="ttname"><a href="classdmlc_1_1Registry.html#a53edeb1439d0c6b63bb08f26c010be02">dmlc::Registry::AddAlias</a></div><div class="ttdeci">void AddAlias(const std::string &amp;key_name, const std::string &amp;alias)</div><div class="ttdoc">Add alias to the key_name. </div><div class="ttdef"><b>Definition:</b> registry.h:62</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a7332aad0c884773f70eb9fdd30344e6a"><div class="ttname"><a href="classdmlc_1_1Registry.html#a7332aad0c884773f70eb9fdd30344e6a">dmlc::Registry::List</a></div><div class="ttdeci">static const std::vector&lt; const EntryType * &gt; &amp; List()</div><div class="ttdef"><b>Definition:</b> registry.h:30</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a9cd0277c8d3da72b3c85d48f662e7faa"><div class="ttname"><a href="classdmlc_1_1Registry.html#a9cd0277c8d3da72b3c85d48f662e7faa">dmlc::Registry::Find</a></div><div class="ttdeci">static const EntryType * Find(const std::string &amp;name)</div><div class="ttdoc">Find the entry with corresponding name. </div><div class="ttdef"><b>Definition:</b> registry.h:48</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a92bb4906a07d6b41cc3b3a52cc929440"><div class="ttname"><a href="classdmlc_1_1Registry.html#a92bb4906a07d6b41cc3b3a52cc929440">dmlc::Registry::__REGISTER_OR_GET__</a></div><div class="ttdeci">EntryType &amp; __REGISTER_OR_GET__(const std::string &amp;name)</div><div class="ttdoc">Internal function to either register or get registered entry. </div><div class="ttdef"><b>Definition:</b> registry.h:95</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_aec3cb7574c8c2401e7dac0cccb352f31"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#aec3cb7574c8c2401e7dac0cccb352f31">dmlc::FunctionRegEntryBase::add_argument</a></div><div class="ttdeci">EntryType &amp; add_argument(const std::string &amp;name, const std::string &amp;type, const std::string &amp;description)</div><div class="ttdoc">Add argument information to the function. </div><div class="ttdef"><b>Definition:</b> registry.h:189</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_a349dbdc935529bc4ffa7385b5c45614f"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#a349dbdc935529bc4ffa7385b5c45614f">dmlc::FunctionRegEntryBase::add_arguments</a></div><div class="ttdeci">EntryType &amp; add_arguments(const std::vector&lt; ParamFieldInfo &gt; &amp;args)</div><div class="ttdoc">Append list if arguments to the end. </div><div class="ttdef"><b>Definition:</b> registry.h:205</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_ae41428f0ae40e5545df63a2dd0af50d6"><div class="ttname"><a href="classdmlc_1_1Registry.html#ae41428f0ae40e5545df63a2dd0af50d6">dmlc::Registry::Get</a></div><div class="ttdeci">static Registry * Get()</div><div class="ttdoc">get a singleton of the Registry. This function can be defined by DMLC_REGISTRY_ENABLE. </div></div>
<div class="ttc" id="namespacedmlc_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="classdmlc_1_1FunctionRegEntryBase_html_a9de2f3ee312f470556e73ab56288ae25"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#a9de2f3ee312f470556e73ab56288ae25">dmlc::FunctionRegEntryBase::description</a></div><div class="ttdeci">std::string description</div><div class="ttdoc">description of the entry </div><div class="ttdef"><b>Definition:</b> registry.h:156</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a0b71def33966eca79ad304b9da04fecc"><div class="ttname"><a href="classdmlc_1_1Registry.html#a0b71def33966eca79ad304b9da04fecc">dmlc::Registry::__REGISTER__</a></div><div class="ttdeci">EntryType &amp; __REGISTER__(const std::string &amp;name)</div><div class="ttdoc">Internal function to register a name function under name. </div><div class="ttdef"><b>Definition:</b> registry.h:78</div></div>
<div class="ttc" id="classdmlc_1_1Registry_html_a32cd6bfc4ed75261eef555da8310ec30"><div class="ttname"><a href="classdmlc_1_1Registry.html#a32cd6bfc4ed75261eef555da8310ec30">dmlc::Registry::ListAllNames</a></div><div class="ttdeci">static std::vector&lt; std::string &gt; ListAllNames()</div><div class="ttdef"><b>Definition:</b> registry.h:34</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_a8187718b95987b655716c2de9bbe7b06"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#a8187718b95987b655716c2de9bbe7b06">dmlc::FunctionRegEntryBase::return_type</a></div><div class="ttdeci">std::string return_type</div><div class="ttdoc">Return type of the function. </div><div class="ttdef"><b>Definition:</b> registry.h:162</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_aae5d8d68715179c22059867aae4d67fc"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#aae5d8d68715179c22059867aae4d67fc">dmlc::FunctionRegEntryBase::set_body</a></div><div class="ttdeci">EntryType &amp; set_body(FunctionType body)</div><div class="ttdoc">Set the function body. </div><div class="ttdef"><b>Definition:</b> registry.h:169</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_af2acc06f141492afe85d4fff777d7f31"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#af2acc06f141492afe85d4fff777d7f31">dmlc::FunctionRegEntryBase::name</a></div><div class="ttdeci">std::string name</div><div class="ttdoc">name of the entry </div><div class="ttdef"><b>Definition:</b> registry.h:154</div></div>
<div class="ttc" id="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_html"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html">base.h</a></div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_a6565edeffefa127ea939f9ff9774d09d"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#a6565edeffefa127ea939f9ff9774d09d">dmlc::FunctionRegEntryBase::arguments</a></div><div class="ttdeci">std::vector&lt; ParamFieldInfo &gt; arguments</div><div class="ttdoc">additional arguments to the factory function </div><div class="ttdef"><b>Definition:</b> registry.h:158</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_ac593e3ad3722e750b01b110ae01dd5ee"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#ac593e3ad3722e750b01b110ae01dd5ee">dmlc::FunctionRegEntryBase::body</a></div><div class="ttdeci">FunctionType body</div><div class="ttdoc">Function body to create ProductType. </div><div class="ttdef"><b>Definition:</b> registry.h:160</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_a2ee038abad273d717df33a4dbc88ef14"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#a2ee038abad273d717df33a4dbc88ef14">dmlc::FunctionRegEntryBase::set_return_type</a></div><div class="ttdeci">EntryType &amp; set_return_type(const std::string &amp;type)</div><div class="ttdoc">Set the return type. </div><div class="ttdef"><b>Definition:</b> registry.h:214</div></div>
<div class="ttc" id="classdmlc_1_1FunctionRegEntryBase_html_aa523755edc43af8a7ae4dad12e187200"><div class="ttname"><a href="classdmlc_1_1FunctionRegEntryBase.html#aa523755edc43af8a7ae4dad12e187200">dmlc::FunctionRegEntryBase::describe</a></div><div class="ttdeci">EntryType &amp; describe(const std::string &amp;description)</div><div class="ttdoc">Describe the function. </div><div class="ttdef"><b>Definition:</b> registry.h:178</div></div>
<div class="ttc" id="parameter_8h_html"><div class="ttname"><a href="parameter_8h.html">parameter.h</a></div><div class="ttdoc">Provide lightweight util to do parameter setup and checking. </div></div>
<div class="ttc" id="type__traits_8h_html"><div class="ttname"><a href="type__traits_8h.html">type_traits.h</a></div><div class="ttdoc">type traits information header </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 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>