Added: incubator/singa/site/trunk/doxygen/html/channel_8h_source.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/channel_8h_source.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/channel_8h_source.html (added) +++ incubator/singa/site/trunk/doxygen/html/channel_8h_source.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,89 @@ +<!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/channel.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">channel.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></di v><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 clas s="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_CHANNEL_H_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define SINGA_UTILS_CHANNEL_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 <google/protobuf/message.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <fstream></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classsinga_1_1Channel.html"> 35</a></span> <span class="keyword">class </span><a cl ass="code" href="classsinga_1_1Channel.html">Channel</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1Channel.html">Channel</a>(<span class="keyword">const</span> std::string& name);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ~<a class="code" href="classsinga_1_1Channel.html">Channel</a>();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classsinga_1_1Channel.html#aba152cf4c1848dacb6a50f351d8bdc99"> 41</a></span>  <span class="keyword">inline</span> <span class="keyword">const</span> std::string& <a class="code" href="classsinga_1_1Channel.html#aba152cf4c1848dacb6a50f351d8 bdc99">GetName</a>() { <span class="keywordflow">return</span> name_; }</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classsinga_1_1Channel.html#ae95a868b2cbce464b2b7e065ab4dfaa7"> 43</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Channel.html#ae95a868b2cbce464b2b7e065ab4dfaa7">EnableDestStderr</a>(<span class="keywordtype">bool</span> enable) { stderr_ = enable; }</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classsinga_1_1Channel.html#a1b6759cf2879bc0b42dcfdbf3cfed1f0"> 45</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Channel.html#a1b6759cf2879bc0b42dcfdbf3cfed1f0">EnableDestFile</a>(<span class="keywordtype">bool</span> enable) { file_ = enable; }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <spa n class="keywordtype">void</span> <a class="code" href="classsinga_1_1Channel.html#a13af9ce49d21bf3b04c198f5580097dd">SetDestFilePath</a>(<span class="keyword">const</span> std::string& file);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Channel.html#aa951f405d0cf20944afa5a73c2e166f6">Send</a>(<span class="keyword">const</span> std::string& message);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Channel.html#aa951f405d0cf20944afa5a73c2e166f6">Send</a>(<span class="keyword">const</span> google::protobuf::Message& message);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">private</span>:</div><div class="line">< a name="l00055"></a><span class="lineno"> 55</span>  std::string name_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">bool</span> stderr_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span> file_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::ofstream os_;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classsinga_1_1ChannelManager.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1ChannelManager.html">ChannelManager</a> {< /div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classsinga_1_1ChannelManager.html">ChannelManager</a>() {}</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ~<a class="code" href="classsinga_1_1ChannelManager.html">ChannelManager</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> Init();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> SetDefaultDir(<span class="keyword">const</span> <span class="keywordtype">char</span>* dir);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classs inga_1_1Channel.html">Channel</a>* GetInstance(<span class="keyword">const</span> std::string& channel);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  std::string dir_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::map<std::string, Channel*> name2ptr_;</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> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">void</span> <a class="code" href="namespacesinga.html#a89d23cb2a4ace11df4c98f6912facc5e">InitChannel</a>(<span class ="keyword">const</span> <span class="keywordtype">char</span>* argv);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code" href="namespacesinga.html#adc9d8f53816244f6006141817e3b86db">SetChannelDirectory</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="classsinga_1_1Channel.html">Channel</a>* <a class="code" href="namespacesinga.html#a8f76ab8b6f81bc2400f9b8df855f40aa">GetChannel</a>(<span class="keyword">const</span> std::string& channel_name);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class=" line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif // SINGA_UTILS_CHANNEL_H__</span></div><div class="ttc" id="classsinga_1_1Channel_html_aba152cf4c1848dacb6a50f351d8bdc99"><div class="ttname"><a href="classsinga_1_1Channel.html#aba152cf4c1848dacb6a50f351d8bdc99">singa::Channel::GetName</a></div><div class="ttdeci">const std::string & GetName()</div><div class="ttdoc">Return the channel name, which is also used for naming the output file. </div><div class="ttdef"><b>Definition:</b> channel.h:41</div></div> +<div class="ttc" id="classsinga_1_1Channel_html_aa951f405d0cf20944afa5a73c2e166f6"><div class="ttname"><a href="classsinga_1_1Channel.html#aa951f405d0cf20944afa5a73c2e166f6">singa::Channel::Send</a></div><div class="ttdeci">void Send(const std::string &message)</div><div class="ttdoc">Append a string message. </div></div> +<div class="ttc" id="classsinga_1_1ChannelManager_html"><div class="ttname"><a href="classsinga_1_1ChannelManager.html">singa::ChannelManager</a></div><div class="ttdef"><b>Definition:</b> channel.h:61</div></div> +<div class="ttc" id="classsinga_1_1Channel_html_ae95a868b2cbce464b2b7e065ab4dfaa7"><div class="ttname"><a href="classsinga_1_1Channel.html#ae95a868b2cbce464b2b7e065ab4dfaa7">singa::Channel::EnableDestStderr</a></div><div class="ttdeci">void EnableDestStderr(bool enable)</div><div class="ttdoc">Disabled by default. </div><div class="ttdef"><b>Definition:</b> channel.h:43</div></div> +<div class="ttc" id="classsinga_1_1Channel_html_a1b6759cf2879bc0b42dcfdbf3cfed1f0"><div class="ttname"><a href="classsinga_1_1Channel.html#a1b6759cf2879bc0b42dcfdbf3cfed1f0">singa::Channel::EnableDestFile</a></div><div class="ttdeci">void EnableDestFile(bool enable)</div><div class="ttdoc">Enabled by default. </div><div class="ttdef"><b>Definition:</b> channel.h:45</div></div> +<div class="ttc" id="namespacesinga_html_adc9d8f53816244f6006141817e3b86db"><div class="ttname"><a href="namespacesinga.html#adc9d8f53816244f6006141817e3b86db">singa::SetChannelDirectory</a></div><div class="ttdeci">void SetChannelDirectory(const char *path)</div><div class="ttdoc">Set the directory name for persisting channel content. </div></div> +<div class="ttc" id="classsinga_1_1Channel_html_a13af9ce49d21bf3b04c198f5580097dd"><div class="ttname"><a href="classsinga_1_1Channel.html#a13af9ce49d21bf3b04c198f5580097dd">singa::Channel::SetDestFilePath</a></div><div class="ttdeci">void SetDestFilePath(const std::string &file)</div><div class="ttdoc">Reset the output file path. </div></div> +<div class="ttc" id="classsinga_1_1Channel_html"><div class="ttname"><a href="classsinga_1_1Channel.html">singa::Channel</a></div><div class="ttdoc">Channel for appending metrics or other information into files or screen. </div><div class="ttdef"><b>Definition:</b> channel.h:35</div></div> +<div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div> +<div class="ttc" id="namespacesinga_html_a8f76ab8b6f81bc2400f9b8df855f40aa"><div class="ttname"><a href="namespacesinga.html#a8f76ab8b6f81bc2400f9b8df855f40aa">singa::GetChannel</a></div><div class="ttdeci">Channel * GetChannel(const std::string &channel_name)</div><div class="ttdoc">Get the channel instance. </div></div> +<div class="ttc" id="namespacesinga_html_a89d23cb2a4ace11df4c98f6912facc5e"><div class="ttname"><a href="namespacesinga.html#a89d23cb2a4ace11df4c98f6912facc5e">singa::InitChannel</a></div><div class="ttdeci">void InitChannel(const char *argv)</div><div class="ttdoc">Initial function for global usage of channel. </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>
Added: incubator/singa/site/trunk/doxygen/html/classFactory-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classFactory-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classFactory-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classFactory-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,80 @@ +<!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: Member List</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="headertitle"> +<div class="title">Factory< T, ID > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classFactory.html">Factory< T, ID ></a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classFactory.html#aabedbbc02eae76edcccd8d6b6234dc49">Create</a>(const ID &id)</td><td class="entry"><a class="el" href="classFactory.html">Factory< T, ID ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>GetIDs</b>() (defined in <a class="el" href="classFactory.html">Factory< T, ID ></a>)</td><td class="entry"><a class="el" href="classFactory.html">Factory< T, ID ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classFactory.html#a59c8b156b2e87ee68b06a5dc1c07f084">Register</a>(const ID &id, const std::function< T *(void)> &creator)</td><td class="entry"><a class="el" href="classFactory.html">Factory< T, ID ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classFactory.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classFactory.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classFactory.html (added) +++ incubator/singa/site/trunk/doxygen/html/classFactory.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,192 @@ +<!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> Added: incubator/singa/site/trunk/doxygen/html/classPriorityQueue-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classPriorityQueue-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classPriorityQueue-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classPriorityQueue-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,83 @@ +<!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: Member List</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="headertitle"> +<div class="title">PriorityQueue< T > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classPriorityQueue.html#a5ad922c1a6314471d82498e195e3e223">Pop</a>(T &e)</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classPriorityQueue.html#a17af3058e1a4168184c1fd308af858c1">Pop</a>(T &e, std::uint64_t timeout)</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>PriorityQueue</b>()=default (defined in <a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a>)</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classPriorityQueue.html#a5c1c5a72e53dcf23e92b7877f9ed764a">Push</a>(const T &e, int priority)</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classPriorityQueue.html#a4e37ab2e501407763e3a1f35ce417739">Size</a>() const</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classPriorityQueue.html#a39433c1537f78686e95f0242d3d1d245">TryPop</a>(T &e)</td><td class="entry"><a class="el" href="classPriorityQueue.html">PriorityQueue< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classPriorityQueue.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classPriorityQueue.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classPriorityQueue.html (added) +++ incubator/singa/site/trunk/doxygen/html/classPriorityQueue.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,287 @@ +<!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: PriorityQueue< T > 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="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="classPriorityQueue-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">PriorityQueue< T > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Thread safe priority queue. + <a href="classPriorityQueue.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="safe__queue_8h_source.html">safe_queue.h</a>></code></p> +<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:a5c1c5a72e53dcf23e92b7877f9ed764a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPriorityQueue.html#a5c1c5a72e53dcf23e92b7877f9ed764a">Push</a> (const T &e, int priority)</td></tr> +<tr class="memdesc:a5c1c5a72e53dcf23e92b7877f9ed764a"><td class="mdescLeft"> </td><td class="mdescRight">Push an element into the queue with a given priority. <a href="#a5c1c5a72e53dcf23e92b7877f9ed764a">More...</a><br /></td></tr> +<tr class="separator:a5c1c5a72e53dcf23e92b7877f9ed764a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ad922c1a6314471d82498e195e3e223"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPriorityQueue.html#a5ad922c1a6314471d82498e195e3e223">Pop</a> (T &e)</td></tr> +<tr class="memdesc:a5ad922c1a6314471d82498e195e3e223"><td class="mdescLeft"> </td><td class="mdescRight">Pop an element from the queue with the highest priority. <a href="#a5ad922c1a6314471d82498e195e3e223">More...</a><br /></td></tr> +<tr class="separator:a5ad922c1a6314471d82498e195e3e223"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a17af3058e1a4168184c1fd308af858c1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPriorityQueue.html#a17af3058e1a4168184c1fd308af858c1">Pop</a> (T &e, std::uint64_t timeout)</td></tr> +<tr class="memdesc:a17af3058e1a4168184c1fd308af858c1"><td class="mdescLeft"> </td><td class="mdescRight">Pop the item with the highest priority from the queue until one element is poped or timeout. <a href="#a17af3058e1a4168184c1fd308af858c1">More...</a><br /></td></tr> +<tr class="separator:a17af3058e1a4168184c1fd308af858c1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39433c1537f78686e95f0242d3d1d245"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPriorityQueue.html#a39433c1537f78686e95f0242d3d1d245">TryPop</a> (T &e)</td></tr> +<tr class="memdesc:a39433c1537f78686e95f0242d3d1d245"><td class="mdescLeft"> </td><td class="mdescRight">Try to pop an element from the queue. <a href="#a39433c1537f78686e95f0242d3d1d245">More...</a><br /></td></tr> +<tr class="separator:a39433c1537f78686e95f0242d3d1d245"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4e37ab2e501407763e3a1f35ce417739"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPriorityQueue.html#a4e37ab2e501407763e3a1f35ce417739">Size</a> () const</td></tr> +<tr class="separator:a4e37ab2e501407763e3a1f35ce417739"><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><br /> +class PriorityQueue< T ></h3> + +<p>Thread safe priority queue. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a5ad922c1a6314471d82498e195e3e223"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5ad922c1a6314471d82498e195e3e223">◆ </a></span>Pop() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classPriorityQueue.html">PriorityQueue</a>< T >::Pop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>e</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>Pop an element from the queue with the highest priority. </p> +<p>It blocks until one element is poped. </p> + +</div> +</div> +<a id="a17af3058e1a4168184c1fd308af858c1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a17af3058e1a4168184c1fd308af858c1">◆ </a></span>Pop() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPriorityQueue.html">PriorityQueue</a>< T >::Pop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>e</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::uint64_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Pop the item with the highest priority from the queue until one element is poped or timeout. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout,return</td><td>false if no element is poped after this number of microseconds. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a5c1c5a72e53dcf23e92b7877f9ed764a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5c1c5a72e53dcf23e92b7877f9ed764a">◆ </a></span>Push()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPriorityQueue.html">PriorityQueue</a>< T >::Push </td> + <td>(</td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>e</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>priority</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Push an element into the queue with a given priority. </p> +<p>The queue should not be a priority queue. </p><dl class="section return"><dt>Returns</dt><dd>true if success; otherwise false, e.g., due to capacity constraint. </dd></dl> + +</div> +</div> +<a id="a4e37ab2e501407763e3a1f35ce417739"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e37ab2e501407763e3a1f35ce417739">◆ </a></span>Size()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">unsigned int <a class="el" href="classPriorityQueue.html">PriorityQueue</a>< T >::Size </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of elements in the queue. </dd></dl> + +</div> +</div> +<a id="a39433c1537f78686e95f0242d3d1d245"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a39433c1537f78686e95f0242d3d1d245">◆ </a></span>TryPop()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPriorityQueue.html">PriorityQueue</a>< T >::TryPop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>e</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>Try to pop an element from the queue. </p> +<dl class="section return"><dt>Returns</dt><dd>false if the queue is empty now. </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="safe__queue_8h_source.html">safe_queue.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> Added: incubator/singa/site/trunk/doxygen/html/classRegistra-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classRegistra-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classRegistra-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classRegistra-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,78 @@ +<!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: Member List</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="headertitle"> +<div class="title">Registra< Base, Sub, ID > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classRegistra.html">Registra< Base, Sub, ID ></a>, including all inherited members.</p> +<table class="directory"> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Registra</b>(const ID &id) (defined in <a class="el" href="classRegistra.html">Registra< Base, Sub, ID ></a>)</td><td class="entry"><a class="el" href="classRegistra.html">Registra< Base, Sub, ID ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classRegistra.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classRegistra.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classRegistra.html (added) +++ incubator/singa/site/trunk/doxygen/html/classRegistra.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,87 @@ +<!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: Registra< Base, Sub, 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-methods">Public Member Functions</a> | +<a href="classRegistra-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Registra< Base, Sub, ID > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> +<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:a8e88c8b4ba38ed9878c86855ead33f2a"><td class="memItemLeft" align="right" valign="top"><a id="a8e88c8b4ba38ed9878c86855ead33f2a"></a> + </td><td class="memItemRight" valign="bottom"><b>Registra</b> (const ID &id)</td></tr> +<tr class="separator:a8e88c8b4ba38ed9878c86855ead33f2a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<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> Added: incubator/singa/site/trunk/doxygen/html/classSafeQueue-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classSafeQueue-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classSafeQueue-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classSafeQueue-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,84 @@ +<!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: Member List</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="headertitle"> +<div class="title">SafeQueue< T, Container > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classSafeQueue.html#a344920696b4628f864fd73f8e6a17dc6">Pop</a>(T &e)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classSafeQueue.html#afe217ddc60f494d096028ba640e737f9">Pop</a>(T &item, std::uint64_t timeout)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classSafeQueue.html#a52d13d8fe67de0c3f63641baf0697de8">Push</a>(const T &e)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>SafeQueue</b>()=default (defined in <a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a>)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classSafeQueue.html#ad8c8beb82fe07d1bbb74a78480d02ff2">Size</a>() const</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classSafeQueue.html#aad136ab2d232ff62375d0c347e906bb2">TryPop</a>(T &e)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~SafeQueue</b>() (defined in <a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a>)</td><td class="entry"><a class="el" href="classSafeQueue.html">SafeQueue< T, Container ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classSafeQueue.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classSafeQueue.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classSafeQueue.html (added) +++ incubator/singa/site/trunk/doxygen/html/classSafeQueue.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,276 @@ +<!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: SafeQueue< T, Container > 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-methods">Public Member Functions</a> | +<a href="classSafeQueue-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">SafeQueue< T, Container > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Thread-safe queue. + <a href="classSafeQueue.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="safe__queue_8h_source.html">safe_queue.h</a>></code></p> +<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:a52d13d8fe67de0c3f63641baf0697de8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSafeQueue.html#a52d13d8fe67de0c3f63641baf0697de8">Push</a> (const T &e)</td></tr> +<tr class="memdesc:a52d13d8fe67de0c3f63641baf0697de8"><td class="mdescLeft"> </td><td class="mdescRight">Push an element into the queue. <a href="#a52d13d8fe67de0c3f63641baf0697de8">More...</a><br /></td></tr> +<tr class="separator:a52d13d8fe67de0c3f63641baf0697de8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a344920696b4628f864fd73f8e6a17dc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSafeQueue.html#a344920696b4628f864fd73f8e6a17dc6">Pop</a> (T &e)</td></tr> +<tr class="memdesc:a344920696b4628f864fd73f8e6a17dc6"><td class="mdescLeft"> </td><td class="mdescRight">Pop an element from the queue. <a href="#a344920696b4628f864fd73f8e6a17dc6">More...</a><br /></td></tr> +<tr class="separator:a344920696b4628f864fd73f8e6a17dc6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afe217ddc60f494d096028ba640e737f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSafeQueue.html#afe217ddc60f494d096028ba640e737f9">Pop</a> (T &item, std::uint64_t timeout)</td></tr> +<tr class="memdesc:afe217ddc60f494d096028ba640e737f9"><td class="mdescLeft"> </td><td class="mdescRight">Pop an item from the queue until one element is poped or timout. <a href="#afe217ddc60f494d096028ba640e737f9">More...</a><br /></td></tr> +<tr class="separator:afe217ddc60f494d096028ba640e737f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad136ab2d232ff62375d0c347e906bb2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSafeQueue.html#aad136ab2d232ff62375d0c347e906bb2">TryPop</a> (T &e)</td></tr> +<tr class="memdesc:aad136ab2d232ff62375d0c347e906bb2"><td class="mdescLeft"> </td><td class="mdescRight">Try to pop an element from the queue. <a href="#aad136ab2d232ff62375d0c347e906bb2">More...</a><br /></td></tr> +<tr class="separator:aad136ab2d232ff62375d0c347e906bb2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8c8beb82fe07d1bbb74a78480d02ff2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSafeQueue.html#ad8c8beb82fe07d1bbb74a78480d02ff2">Size</a> () const</td></tr> +<tr class="separator:ad8c8beb82fe07d1bbb74a78480d02ff2"><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, class Container = std::queue<T>><br /> +class SafeQueue< T, Container ></h3> + +<p>Thread-safe queue. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a344920696b4628f864fd73f8e6a17dc6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a344920696b4628f864fd73f8e6a17dc6">◆ </a></span>Pop() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T, class Container = std::queue<T>> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classSafeQueue.html">SafeQueue</a>< T, Container >::Pop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>e</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>Pop an element from the queue. </p> +<p>It will be blocked until one element is poped. </p> + +</div> +</div> +<a id="afe217ddc60f494d096028ba640e737f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afe217ddc60f494d096028ba640e737f9">◆ </a></span>Pop() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T, class Container = std::queue<T>> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classSafeQueue.html">SafeQueue</a>< T, Container >::Pop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>item</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::uint64_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Pop an item from the queue until one element is poped or timout. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout,return</td><td>false after waiting this number of microseconds </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a52d13d8fe67de0c3f63641baf0697de8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a52d13d8fe67de0c3f63641baf0697de8">◆ </a></span>Push()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T, class Container = std::queue<T>> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classSafeQueue.html">SafeQueue</a>< T, Container >::Push </td> + <td>(</td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>e</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>Push an element into the queue. </p> +<p>Blocking operation. </p><dl class="section return"><dt>Returns</dt><dd>true if success; </dd></dl> + +</div> +</div> +<a id="ad8c8beb82fe07d1bbb74a78480d02ff2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad8c8beb82fe07d1bbb74a78480d02ff2">◆ </a></span>Size()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T, class Container = std::queue<T>> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">unsigned int <a class="el" href="classSafeQueue.html">SafeQueue</a>< T, Container >::Size </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of elements in the queue. </dd></dl> + +</div> +</div> +<a id="aad136ab2d232ff62375d0c347e906bb2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aad136ab2d232ff62375d0c347e906bb2">◆ </a></span>TryPop()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T, class Container = std::queue<T>> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classSafeQueue.html">SafeQueue</a>< T, Container >::TryPop </td> + <td>(</td> + <td class="paramtype">T & </td> + <td class="paramname"><em>e</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>Try to pop an element from the queue. </p> +<dl class="section return"><dt>Returns</dt><dd>false the queue is empty now. </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="safe__queue_8h_source.html">safe_queue.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> Added: incubator/singa/site/trunk/doxygen/html/classSingleton-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classSingleton-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classSingleton-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classSingleton-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,78 @@ +<!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: Member List</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="headertitle"> +<div class="title">Singleton< T > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classSingleton.html">Singleton< T ></a>, including all inherited members.</p> +<table class="directory"> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Instance</b>() (defined in <a class="el" href="classSingleton.html">Singleton< T ></a>)</td><td class="entry"><a class="el" href="classSingleton.html">Singleton< T ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> +</table></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> Added: incubator/singa/site/trunk/doxygen/html/classSingleton.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classSingleton.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classSingleton.html (added) +++ incubator/singa/site/trunk/doxygen/html/classSingleton.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,97 @@ +<!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: Singleton< T > 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="classSingleton-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Singleton< T > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Thread-safe implementation for C++11 according to. + <a href="classSingleton.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="singleton_8h_source.html">singleton.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:a9619dd8c048bc1cee850febffd7c5d8e"><td class="memItemLeft" align="right" valign="top"><a id="a9619dd8c048bc1cee850febffd7c5d8e"></a> +static T * </td><td class="memItemRight" valign="bottom"><b>Instance</b> ()</td></tr> +<tr class="separator:a9619dd8c048bc1cee850febffd7c5d8e"><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><br /> +class Singleton< T ></h3> + +<p>Thread-safe implementation for C++11 according to. </p> +</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="singleton_8h_source.html">singleton.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>
