| <!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>Apache Singa: Factory< T, ID > 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">Apache Singa |
| </div> |
| <div id="projectbrief">A General Distributed Deep Learning Library</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><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classFactory-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Factory< T, ID > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classFactory.html" title="Factory template to generate class (or a sub-class) object based on id. ">Factory</a> template to generate class (or a sub-class) object based on id. |
| <a href="classFactory.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="factory_8h_source.html">factory.h</a>></code></p> |
| <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:a59c8b156b2e87ee68b06a5dc1c07f084"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084">Register</a> (const ID &id, const std::function< T *(void)> &creator)</td></tr> |
| <tr class="memdesc:a59c8b156b2e87ee68b06a5dc1c07f084"><td class="mdescLeft"> </td><td class="mdescRight">Register functions to create user defined classes. <a href="#a59c8b156b2e87ee68b06a5dc1c07f084">More...</a><br /></td></tr> |
| <tr class="separator:a59c8b156b2e87ee68b06a5dc1c07f084"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aabedbbc02eae76edcccd8d6b6234dc49"><td class="memItemLeft" align="right" valign="top">static T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49">Create</a> (const ID &id)</td></tr> |
| <tr class="memdesc:aabedbbc02eae76edcccd8d6b6234dc49"><td class="mdescLeft"> </td><td class="mdescRight">create an instance by providing its id <a href="#aabedbbc02eae76edcccd8d6b6234dc49">More...</a><br /></td></tr> |
| <tr class="separator:aabedbbc02eae76edcccd8d6b6234dc49"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acdc19403e18871ac47d333c1d2c6a064"><td class="memItemLeft" align="right" valign="top"><a id="acdc19403e18871ac47d333c1d2c6a064"></a> |
| static const std::vector< ID > </td><td class="memItemRight" valign="bottom"><b>GetIDs</b> ()</td></tr> |
| <tr class="separator:acdc19403e18871ac47d333c1d2c6a064"><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 T, typename ID = std::string><br /> |
| class Factory< T, ID ></h3> |
| |
| <p><a class="el" href="classFactory.html" title="Factory template to generate class (or a sub-class) object based on id. ">Factory</a> template to generate class (or a sub-class) object based on id. </p> |
| <ol type="1"> |
| <li>register class creation function that generates a class object based on id.</li> |
| <li>call <a class="el" href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49" title="create an instance by providing its id ">Create()</a> func to call the creation function and return a pointer to the base calss. </li> |
| </ol> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aabedbbc02eae76edcccd8d6b6234dc49"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aabedbbc02eae76edcccd8d6b6234dc49">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename ID = std::string> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static T* <a class="el" href="classFactory.html">Factory</a>< T, ID >::Create </td> |
| <td>(</td> |
| <td class="paramtype">const ID & </td> |
| <td class="paramname"><em>id</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>create an instance by providing its id </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">id</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a59c8b156b2e87ee68b06a5dc1c07f084"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a59c8b156b2e87ee68b06a5dc1c07f084">◆ </a></span>Register()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T , typename ID = std::string> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void <a class="el" href="classFactory.html">Factory</a>< T, ID >::Register </td> |
| <td>(</td> |
| <td class="paramtype">const ID & </td> |
| <td class="paramname"><em>id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::function< T *(void)> & </td> |
| <td class="paramname"><em>creator</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 class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register functions to create user defined classes. </p> |
| <p>This function is called by the REGISTER_FACTORY macro.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">id</td><td>Identifier of the creating function/class </td></tr> |
| <tr><td class="paramname">func</td><td>a function that creates a layer instance </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/utils/<a class="el" href="factory_8h_source.html">factory.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Apr 22 2019 12:27:05 for Apache Singa 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> |
