| <!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: mxnet::runtime::Registry 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.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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1runtime.html">runtime</a></li><li class="navelem"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classmxnet_1_1runtime_1_1Registry-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::runtime::Registry Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classmxnet_1_1runtime_1_1Registry.html" title="Registry for global function. ">Registry</a> for global function. |
| <a href="classmxnet_1_1runtime_1_1Registry.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2runtime_2registry_8h_source.html">registry.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::runtime::Registry:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1runtime_1_1Registry__coll__graph.png" border="0" usemap="#mxnet_1_1runtime_1_1Registry_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1runtime_1_1Registry_coll__map" id="mxnet_1_1runtime_1_1Registry_coll__map"> |
| <area shape="rect" id="node2" href="classmxnet_1_1runtime_1_1PackedFunc.html" title="Packed function is a type-erased function. The arguments are passed by packed format. " alt="" coords="5,5,212,185"/> |
| </map> |
| </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:a4657565cf25ff21f59d171058dbf2356"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> <a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a4657565cf25ff21f59d171058dbf2356">set_body</a> (<a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a> f)</td></tr> |
| <tr class="memdesc:a4657565cf25ff21f59d171058dbf2356"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be f <a href="#a4657565cf25ff21f59d171058dbf2356">More...</a><br /></td></tr> |
| <tr class="separator:a4657565cf25ff21f59d171058dbf2356"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7d6f9db397965176fcd18ae48e1a041"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#af7d6f9db397965176fcd18ae48e1a041">set_body</a> (<a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html#ac40ab6eaaccdd24e7fff95913ee0494d">PackedFunc::FType</a> f)</td></tr> |
| <tr class="memdesc:af7d6f9db397965176fcd18ae48e1a041"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be f <a href="#af7d6f9db397965176fcd18ae48e1a041">More...</a><br /></td></tr> |
| <tr class="separator:af7d6f9db397965176fcd18ae48e1a041"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad051e07569637abfa8398775ad29893"><td class="memTemplParams" colspan="2">template<typename FType , typename FLambda > </td></tr> |
| <tr class="memitem:aad051e07569637abfa8398775ad29893"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#aad051e07569637abfa8398775ad29893">set_body_typed</a> (FLambda f)</td></tr> |
| <tr class="memdesc:aad051e07569637abfa8398775ad29893"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be <a class="el" href="classmxnet_1_1runtime_1_1TypedPackedFunc.html" title="Please refer to TypedPackedFunc<R(Args..)>. ">TypedPackedFunc</a>. <a href="#aad051e07569637abfa8398775ad29893">More...</a><br /></td></tr> |
| <tr class="separator:aad051e07569637abfa8398775ad29893"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac3e7b40d387462801af56893b7934b6c"><td class="memTemplParams" colspan="2">template<typename R , typename ... Args> </td></tr> |
| <tr class="memitem:ac3e7b40d387462801af56893b7934b6c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#ac3e7b40d387462801af56893b7934b6c">set_body_typed</a> (R(*f)(Args...))</td></tr> |
| <tr class="memdesc:ac3e7b40d387462801af56893b7934b6c"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to the given function pointer. Note that this doesn't work with lambdas, you need to explicitly give a type for those. Note that this will ignore default arg values and always require all arguments to be provided. <a href="#ac3e7b40d387462801af56893b7934b6c">More...</a><br /></td></tr> |
| <tr class="separator:ac3e7b40d387462801af56893b7934b6c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b54885f07cb2cb78be6cccb25bbb65b"><td class="memTemplParams" colspan="2">template<typename T , typename R , typename ... Args> </td></tr> |
| <tr class="memitem:a9b54885f07cb2cb78be6cccb25bbb65b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a9b54885f07cb2cb78be6cccb25bbb65b">set_body_method</a> (R(T::*f)(Args...))</td></tr> |
| <tr class="memdesc:a9b54885f07cb2cb78be6cccb25bbb65b"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be the passed method pointer. Note that this will ignore default arg values and always require all arguments to be provided. <a href="#a9b54885f07cb2cb78be6cccb25bbb65b">More...</a><br /></td></tr> |
| <tr class="separator:a9b54885f07cb2cb78be6cccb25bbb65b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93319d6ac88353d6667a5af15ab15949"><td class="memTemplParams" colspan="2">template<typename T , typename R , typename ... Args> </td></tr> |
| <tr class="memitem:a93319d6ac88353d6667a5af15ab15949"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a93319d6ac88353d6667a5af15ab15949">set_body_method</a> (R(T::*f)(Args...) const)</td></tr> |
| <tr class="memdesc:a93319d6ac88353d6667a5af15ab15949"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be the passed method pointer. Note that this will ignore default arg values and always require all arguments to be provided. <a href="#a93319d6ac88353d6667a5af15ab15949">More...</a><br /></td></tr> |
| <tr class="separator:a93319d6ac88353d6667a5af15ab15949"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af521aa4503015975c77b10f1c5728968"><td class="memTemplParams" colspan="2">template<typename TObjectRef , typename TNode , typename R , typename ... Args, typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type> </td></tr> |
| <tr class="memitem:af521aa4503015975c77b10f1c5728968"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#af521aa4503015975c77b10f1c5728968">set_body_method</a> (R(TNode::*f)(Args...))</td></tr> |
| <tr class="memdesc:af521aa4503015975c77b10f1c5728968"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be the passed method pointer. Used when calling a method on a Node subclass through a <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html" title="Base class of all object reference. ">ObjectRef</a> subclass. Note that this will ignore default arg values and always require all arguments to be provided. <a href="#af521aa4503015975c77b10f1c5728968">More...</a><br /></td></tr> |
| <tr class="separator:af521aa4503015975c77b10f1c5728968"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48e61a7dfbcb70cc466637dd8c3d4e13"><td class="memTemplParams" colspan="2">template<typename TObjectRef , typename TNode , typename R , typename ... Args, typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type> </td></tr> |
| <tr class="memitem:a48e61a7dfbcb70cc466637dd8c3d4e13"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a48e61a7dfbcb70cc466637dd8c3d4e13">set_body_method</a> (R(TNode::*f)(Args...) const)</td></tr> |
| <tr class="memdesc:a48e61a7dfbcb70cc466637dd8c3d4e13"><td class="mdescLeft"> </td><td class="mdescRight">set the body of the function to be the passed method pointer. Used when calling a method on a Node subclass through a <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html" title="Base class of all object reference. ">ObjectRef</a> subclass. Note that this will ignore default arg values and always require all arguments to be provided. <a href="#a48e61a7dfbcb70cc466637dd8c3d4e13">More...</a><br /></td></tr> |
| <tr class="separator:a48e61a7dfbcb70cc466637dd8c3d4e13"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1d574df0edaa072df58a09f6788e72ac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> <a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a1d574df0edaa072df58a09f6788e72ac">Register</a> (const std::string &name, bool override=false)</td></tr> |
| <tr class="memdesc:a1d574df0edaa072df58a09f6788e72ac"><td class="mdescLeft"> </td><td class="mdescRight">Register a function with given name. <a href="#a1d574df0edaa072df58a09f6788e72ac">More...</a><br /></td></tr> |
| <tr class="separator:a1d574df0edaa072df58a09f6788e72ac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4503295adccaf352f093830a598533e0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a4503295adccaf352f093830a598533e0">Remove</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:a4503295adccaf352f093830a598533e0"><td class="mdescLeft"> </td><td class="mdescRight">Erase global function from registry, if exist. <a href="#a4503295adccaf352f093830a598533e0">More...</a><br /></td></tr> |
| <tr class="separator:a4503295adccaf352f093830a598533e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ff89d9cade47e4ed662b75f17a34bb6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> const <a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a2ff89d9cade47e4ed662b75f17a34bb6">Get</a> (const std::string &name)</td></tr> |
| <tr class="memdesc:a2ff89d9cade47e4ed662b75f17a34bb6"><td class="mdescLeft"> </td><td class="mdescRight">Get the global function by name. <a href="#a2ff89d9cade47e4ed662b75f17a34bb6">More...</a><br /></td></tr> |
| <tr class="separator:a2ff89d9cade47e4ed662b75f17a34bb6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a247140f6d3a198a08d5a7ba270c9be48"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a247140f6d3a198a08d5a7ba270c9be48">ListNames</a> ()</td></tr> |
| <tr class="memdesc:a247140f6d3a198a08d5a7ba270c9be48"><td class="mdescLeft"> </td><td class="mdescRight">Get the names of currently registered global function. <a href="#a247140f6d3a198a08d5a7ba270c9be48">More...</a><br /></td></tr> |
| <tr class="separator:a247140f6d3a198a08d5a7ba270c9be48"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:afbdc86a65bc2e84552a90a56dfcd028c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#afbdc86a65bc2e84552a90a56dfcd028c">name_</a></td></tr> |
| <tr class="memdesc:afbdc86a65bc2e84552a90a56dfcd028c"><td class="mdescLeft"> </td><td class="mdescRight">name of the function <a href="#afbdc86a65bc2e84552a90a56dfcd028c">More...</a><br /></td></tr> |
| <tr class="separator:afbdc86a65bc2e84552a90a56dfcd028c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a64a1897bc4e1a3290f6ba52093453916"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a64a1897bc4e1a3290f6ba52093453916">func_</a></td></tr> |
| <tr class="memdesc:a64a1897bc4e1a3290f6ba52093453916"><td class="mdescLeft"> </td><td class="mdescRight">internal packed function <a href="#a64a1897bc4e1a3290f6ba52093453916">More...</a><br /></td></tr> |
| <tr class="separator:a64a1897bc4e1a3290f6ba52093453916"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a1fd6b9bc3f72bb2b64e602de3982929d"><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html#a1fd6b9bc3f72bb2b64e602de3982929d">Manager</a></td></tr> |
| <tr class="separator:a1fd6b9bc3f72bb2b64e602de3982929d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classmxnet_1_1runtime_1_1Registry.html" title="Registry for global function. ">Registry</a> for global function. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2ff89d9cade47e4ed662b75f17a34bb6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ff89d9cade47e4ed662b75f17a34bb6">◆ </a></span>Get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> const <a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a>* mxnet::runtime::Registry::Get </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the global function by name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>pointer to the registered function, nullptr if it does not exist. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a247140f6d3a198a08d5a7ba270c9be48"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a247140f6d3a198a08d5a7ba270c9be48">◆ </a></span>ListNames()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> std::vector<std::string> mxnet::runtime::Registry::ListNames </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the names of currently registered global function. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The names </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1d574df0edaa072df58a09f6788e72ac"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1d574df0edaa072df58a09f6788e72ac">◆ </a></span>Register()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> <a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::Register </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">bool </td> |
| <td class="paramname"><em>override</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register a function with given name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the function. </td></tr> |
| <tr><td class="paramname">override</td><td>Whether allow oveeride existing function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Reference to theregistry. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4503295adccaf352f093830a598533e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4503295adccaf352f093830a598533e0">◆ </a></span>Remove()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> bool mxnet::runtime::Registry::Remove </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Erase global function from registry, if exist. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Whether function exist. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4657565cf25ff21f59d171058dbf2356"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4657565cf25ff21f59d171058dbf2356">◆ </a></span>set_body() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> <a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a> </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be f </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>The body of the function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af7d6f9db397965176fcd18ae48e1a041"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7d6f9db397965176fcd18ae48e1a041">◆ </a></span>set_body() <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="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1runtime_1_1PackedFunc.html#ac40ab6eaaccdd24e7fff95913ee0494d">PackedFunc::FType</a> </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be f </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>The body of the function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a9b54885f07cb2cb78be6cccb25bbb65b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b54885f07cb2cb78be6cccb25bbb65b">◆ </a></span>set_body_method() <span class="overload">[1/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename R , typename ... Args> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_method </td> |
| <td>(</td> |
| <td class="paramtype">R(T::*)(Args...) </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be the passed method pointer. Note that this will ignore default arg values and always require all arguments to be provided. </p> |
| <div class="fragment"><div class="line"><span class="comment">// node subclass:</span></div><div class="line"><span class="keyword">struct </span>Example {</div><div class="line"> <span class="keywordtype">int</span> doThing(<span class="keywordtype">int</span> x);</div><div class="line">}</div><div class="line">TVM_REGISTER_API(<span class="stringliteral">"Example_doThing"</span>)</div><div class="line">.set_body_method(&Example::doThing); <span class="comment">// will have type int(Example, int)</span></div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>the method pointer to forward to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type containing the method (inferred). </td></tr> |
| <tr><td class="paramname">R</td><td>the return type of the function (inferred). </td></tr> |
| <tr><td class="paramname">Args</td><td>the argument types of the function (inferred). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a93319d6ac88353d6667a5af15ab15949"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a93319d6ac88353d6667a5af15ab15949">◆ </a></span>set_body_method() <span class="overload">[2/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename R , typename ... Args> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_method </td> |
| <td>(</td> |
| <td class="paramtype">R(T::*)(Args...) const </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be the passed method pointer. Note that this will ignore default arg values and always require all arguments to be provided. </p> |
| <div class="fragment"><div class="line"><span class="comment">// node subclass:</span></div><div class="line"><span class="keyword">struct </span>Example {</div><div class="line"> <span class="keywordtype">int</span> doThing(<span class="keywordtype">int</span> x);</div><div class="line">}</div><div class="line">TVM_REGISTER_API(<span class="stringliteral">"Example_doThing"</span>)</div><div class="line">.set_body_method(&Example::doThing); <span class="comment">// will have type int(Example, int)</span></div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>the method pointer to forward to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type containing the method (inferred). </td></tr> |
| <tr><td class="paramname">R</td><td>the return type of the function (inferred). </td></tr> |
| <tr><td class="paramname">Args</td><td>the argument types of the function (inferred). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af521aa4503015975c77b10f1c5728968"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af521aa4503015975c77b10f1c5728968">◆ </a></span>set_body_method() <span class="overload">[3/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename TObjectRef , typename TNode , typename R , typename ... Args, typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_method </td> |
| <td>(</td> |
| <td class="paramtype">R(TNode::*)(Args...) </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be the passed method pointer. Used when calling a method on a Node subclass through a <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html" title="Base class of all object reference. ">ObjectRef</a> subclass. Note that this will ignore default arg values and always require all arguments to be provided. </p> |
| <div class="fragment"><div class="line"><span class="comment">// node subclass:</span></div><div class="line"><span class="keyword">struct </span>ExampleNode: BaseNode {</div><div class="line"> <span class="keywordtype">int</span> doThing(<span class="keywordtype">int</span> x);</div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// noderef subclass</span></div><div class="line"><span class="keyword">struct </span>Example;</div><div class="line"></div><div class="line">TVM_REGISTER_API(<span class="stringliteral">"Example_doThing"</span>)</div><div class="line">.set_body_method<Example>(&ExampleNode::doThing); <span class="comment">// will have type int(Example, int)</span></div><div class="line"></div><div class="line"><span class="comment">// note that just doing:</span></div><div class="line"><span class="comment">// .set_body_method(&ExampleNode::doThing);</span></div><div class="line"><span class="comment">// wouldn't work, because ExampleNode can't be taken from a TVMArgValue.</span></div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>the method pointer to forward to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">TObjectRef</td><td>the node reference type to call the method on </td></tr> |
| <tr><td class="paramname">TNode</td><td>the node type containing the method (inferred). </td></tr> |
| <tr><td class="paramname">R</td><td>the return type of the function (inferred). </td></tr> |
| <tr><td class="paramname">Args</td><td>the argument types of the function (inferred). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a48e61a7dfbcb70cc466637dd8c3d4e13"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a48e61a7dfbcb70cc466637dd8c3d4e13">◆ </a></span>set_body_method() <span class="overload">[4/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename TObjectRef , typename TNode , typename R , typename ... Args, typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_method </td> |
| <td>(</td> |
| <td class="paramtype">R(TNode::*)(Args...) const </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be the passed method pointer. Used when calling a method on a Node subclass through a <a class="el" href="classmxnet_1_1runtime_1_1ObjectRef.html" title="Base class of all object reference. ">ObjectRef</a> subclass. Note that this will ignore default arg values and always require all arguments to be provided. </p> |
| <div class="fragment"><div class="line"><span class="comment">// node subclass:</span></div><div class="line"><span class="keyword">struct </span>ExampleNode: BaseNode {</div><div class="line"> <span class="keywordtype">int</span> doThing(<span class="keywordtype">int</span> x);</div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// noderef subclass</span></div><div class="line"><span class="keyword">struct </span>Example;</div><div class="line"></div><div class="line">TVM_REGISTER_API(<span class="stringliteral">"Example_doThing"</span>)</div><div class="line">.set_body_method<Example>(&ExampleNode::doThing); <span class="comment">// will have type int(Example, int)</span></div><div class="line"></div><div class="line"><span class="comment">// note that just doing:</span></div><div class="line"><span class="comment">// .set_body_method(&ExampleNode::doThing);</span></div><div class="line"><span class="comment">// wouldn't work, because ExampleNode can't be taken from a TVMArgValue.</span></div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>the method pointer to forward to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">TObjectRef</td><td>the node reference type to call the method on </td></tr> |
| <tr><td class="paramname">TNode</td><td>the node type containing the method (inferred). </td></tr> |
| <tr><td class="paramname">R</td><td>the return type of the function (inferred). </td></tr> |
| <tr><td class="paramname">Args</td><td>the argument types of the function (inferred). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aad051e07569637abfa8398775ad29893"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aad051e07569637abfa8398775ad29893">◆ </a></span>set_body_typed() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename FType , typename FLambda > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_typed </td> |
| <td>(</td> |
| <td class="paramtype">FLambda </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to be <a class="el" href="classmxnet_1_1runtime_1_1TypedPackedFunc.html" title="Please refer to TypedPackedFunc<R(Args..)>. ">TypedPackedFunc</a>. </p> |
| <div class="fragment"><div class="line">TVM_REGISTER_API(<span class="stringliteral">"addone"</span>)</div><div class="line">.set_body_typed<int(<span class="keywordtype">int</span>)>([](<span class="keywordtype">int</span> x) { <span class="keywordflow">return</span> x + 1; });</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>The body of the function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">FType</td><td>the signature of the function. </td></tr> |
| <tr><td class="paramname">FLambda</td><td>The type of f. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac3e7b40d387462801af56893b7934b6c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac3e7b40d387462801af56893b7934b6c">◆ </a></span>set_body_typed() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename R , typename ... Args> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1Registry.html">Registry</a>& mxnet::runtime::Registry::set_body_typed </td> |
| <td>(</td> |
| <td class="paramtype">R(*)(Args...) </td> |
| <td class="paramname"><em>f</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set the body of the function to the given function pointer. Note that this doesn't work with lambdas, you need to explicitly give a type for those. Note that this will ignore default arg values and always require all arguments to be provided. </p> |
| <div class="fragment"><div class="line"><span class="keywordtype">int</span> multiply(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) {</div><div class="line"> <span class="keywordflow">return</span> x * y;</div><div class="line">}</div><div class="line"></div><div class="line">TVM_REGISTER_API(<span class="stringliteral">"multiply"</span>)</div><div class="line">.set_body_typed(multiply); <span class="comment">// will have type int(int, int)</span></div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">f</td><td>The function to forward to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">R</td><td>the return type of the function (inferred). </td></tr> |
| <tr><td class="paramname">Args</td><td>the argument types of the function (inferred). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Function Documentation</h2> |
| <a id="a1fd6b9bc3f72bb2b64e602de3982929d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1fd6b9bc3f72bb2b64e602de3982929d">◆ </a></span>Manager</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">friend struct Manager</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a64a1897bc4e1a3290f6ba52093453916"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a64a1897bc4e1a3290f6ba52093453916">◆ </a></span>func_</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="classmxnet_1_1runtime_1_1PackedFunc.html">PackedFunc</a> mxnet::runtime::Registry::func_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>internal packed function </p> |
| |
| </div> |
| </div> |
| <a id="afbdc86a65bc2e84552a90a56dfcd028c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbdc86a65bc2e84552a90a56dfcd028c">◆ </a></span>name_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mxnet::runtime::Registry::name_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>name of the function </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/runtime/<a class="el" href="include_2mxnet_2runtime_2registry_8h_source.html">registry.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:44 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
