| <!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: /home/moaz/incubator-singa/include/singa/utils/factory.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">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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_54125cd652f9635a64a4101de1b8704d.html">utils</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">factory.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* distributed with this work for additional information</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* software distributed under the License is distributed on an</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">* specific language governing permissions and limitations</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">* under the License.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">*************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef SINGA_UTILS_FACTORY_H_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define SINGA_UTILS_FACTORY_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "singa/utils/logging.h"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define CreateInstance(SubClass, BaseClass) \</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"> [](void)->BaseClass* {return new SubClass();}</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> ID = std::<span class="keywordtype">string</span>></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classFactory.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classFactory.html">Factory</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084"> 54</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084">Register</a>(<span class="keyword">const</span> ID& <span class="keywordtype">id</span>,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> std::function<T*(<span class="keywordtype">void</span>)>& creator) {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  Registry* reg = GetRegistry();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// CHECK(reg->find(id) == reg->end())</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// << "The id " << id << " has been registered";</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  (*reg)[id] = creator;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49"> 67</a></span>  <span class="keyword">static</span> T* <a class="code" href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49">Create</a>(<span class="keyword">const</span> ID& <span class="keywordtype">id</span>) {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  Registry* reg = GetRegistry();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  CHECK(reg->find(<span class="keywordtype">id</span>) != reg->end())</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  << <span class="stringliteral">"The creation function for "</span> << <span class="keywordtype">id</span> << <span class="stringliteral">" has not been registered"</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> (*reg)[id]();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">static</span> <span class="keyword">const</span> std::vector<ID> GetIDs() {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  std::vector<ID> keys;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> entry : *GetRegistry())</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  keys.push_back(entry.first);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> keys;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Map that stores the registered creation functions</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">typedef</span> std::map<ID, std::function<T*(void)>> Registry;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">static</span> Registry* GetRegistry() {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">static</span> Registry reg;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> &reg;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">template</span><<span class="keyword">typename</span> Base, <span class="keyword">typename</span> Sub, <span class="keyword">typename</span> ID = std::<span class="keywordtype">string</span>></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classRegistra.html"> 91</a></span> <span class="keyword">class </span><a class="code" href="classRegistra.html">Registra</a> {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classRegistra.html">Registra</a>(<span class="keyword">const</span> ID& <span class="keywordtype">id</span>) {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084">Factory<Base, ID>::Register</a>(<span class="keywordtype">id</span>, [](<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> <span class="keyword">new</span> Sub(); });</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif // SINGA_UTILS_FACTORY_H_</span></div><div class="ttc" id="classRegistra_html"><div class="ttname"><a href="classRegistra.html">Registra</a></div><div class="ttdef"><b>Definition:</b> factory.h:91</div></div> |
| <div class="ttc" id="classFactory_html"><div class="ttname"><a href="classFactory.html">Factory</a></div><div class="ttdoc">Factory template to generate class (or a sub-class) object based on id. </div><div class="ttdef"><b>Definition:</b> factory.h:45</div></div> |
| <div class="ttc" id="classFactory_html_a59c8b156b2e87ee68b06a5dc1c07f084"><div class="ttname"><a href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084">Factory::Register</a></div><div class="ttdeci">static void Register(const ID &id, const std::function< T *(void)> &creator)</div><div class="ttdoc">Register functions to create user defined classes. </div><div class="ttdef"><b>Definition:</b> factory.h:54</div></div> |
| <div class="ttc" id="classFactory_html_aabedbbc02eae76edcccd8d6b6234dc49"><div class="ttname"><a href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49">Factory::Create</a></div><div class="ttdeci">static T * Create(const ID &id)</div><div class="ttdoc">create an instance by providing its id </div><div class="ttdef"><b>Definition:</b> factory.h:67</div></div> |
| </div><!-- fragment --></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> |
