Added: incubator/singa/site/trunk/doxygen/html/logging_8h_source.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/logging_8h_source.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/logging_8h_source.html (added) +++ incubator/singa/site/trunk/doxygen/html/logging_8h_source.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: /home/moaz/incubator-singa/include/singa/utils/logging.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">logging.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="comment">// adapted from google::tensorflow::logging</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef SINGA_UTILS_LOGGING_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define SINGA_UTILS_LOGGING_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 clas s="preprocessor">#include <stdlib.h></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <sstream></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef USE_GLOG</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <glog/logging.h></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> <a class="code" href="namespacesinga.html#aa1c53496f790ff43b264f4cd84b723ea">InitLogging</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *argv);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">void</span> <a class="code" href="namespacesinga.html#ad5e79d66673cb3bd4e824d3a14979244">LogToStderr</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> <a class="code" href="namespacesinga.html#af45997ae6f3babb10023156d4c0993fc">SetStderrLogging</a>(<span class="keywordtype">int</span> severity);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> <a class=" code" href="namespacesinga.html#a23f5f64072659d14ef6251faaead345a">SetLogDestination</a>(<span class="keywordtype">int</span> severity, <span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> <span class="keywordtype">int</span> INFO = 0; <span class="comment">// base_logging::INFO;</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">const</span> <span class="keywordtype">int</span> WARNING = 1; <span class="comment">// base_logging::WARNING;</span></div><div class="line" ><a name="l00050"></a><span class="lineno"> 50</span> <span >class="keyword">const</span> <span class="keywordtype">int</span> ERROR = 2; > <span class="comment">// base_logging::ERROR;</span></div><div >class="line"><a name="l00051"></a><span class="lineno"> >51</span> <span class="keyword">const</span> <span >class="keywordtype">int</span> FATAL = 3; <span class="comment">// >base_logging::FATAL;</span></div><div class="line"><a name="l00052"></a><span >class="lineno"> 52</span> <span class="keyword">const</span> <span >class="keywordtype">int</span> NUM_SEVERITIES = 4; <span class="comment">// >base_logging::NUM_SEVERITIES;</span></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="preprocessor">#ifndef USE_GLOG</span></div><div >class="line"><a name="l00055"></a><span class="lineno"> >55</span> <span class="keyword"> namespace </span>logging {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classsinga_1_1logging_1_1LogMessage.html"> 57</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1logging_1_1LogMessage.html">LogMessage</a> : <span class="keyword">public</span> std::basic_ostringstream<char> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classsinga_1_1logging_1_1LogMessage.html">LogMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname, <span class="keywordtype">int</span> line, <span class="keywordtype">int</span> severity);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  ~< a class="code" href="classsinga_1_1logging_1_1LogMessage.html">LogMessage</a>();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> GenerateLogMessage();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> DoLogging(FILE* file, <span class="keyword">const</span> <span class="keyword">struct</span> tm& tm_time);</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="keyword">private</span>:</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <sp an class="keywordtype">char</span>* fname_;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> line_;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">int</span> severity_;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// LogMessageFatal ensures the process will exit in failure after</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// logging this message.</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classsinga_1_1logging_1_1LogMessageFatal.html"> 74</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1logging_1_1LogMessageFatal.html">LogMessageFatal</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1logging_1_1LogMessage.html">LogMessage</a> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classsinga_1_1logging_1_1LogMessageFatal.html">LogMessageFatal</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  ~<a class="code" href="classsinga_1_1logging_1_1LogMessageFatal.html">LogMessageFatal</a>();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l0008 0"></a><span class="lineno"> 80</span> <span class="preprocessor">#define _SINGA_LOG_INFO \</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> ::singa::logging::LogMessage(__FILE__, __LINE__, singa::INFO)</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#define _SINGA_LOG_WARNING \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> ::singa::logging::LogMessage(__FILE__, __LINE__, singa::WARNING)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#define _SINGA_LOG_ERROR \</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"> ::singa::logging::LogMessage(__FILE__, __LINE__, singa::ERROR)</span></div><div class="line"><a name="l00086"></a><span clas s="lineno"> 86</span> <span class="preprocessor">#define _SINGA_LOG_FATAL \</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"> ::singa::logging::LogMessageFatal(__FILE__, __LINE__)</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> <span class="preprocessor">#define LOG(severity) _SINGA_LOG_##severity</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define CHECK(condition) \</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"> if (!(condition)) \</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor" > LOG(FATAL) << "Check failed: " #condition " > "</span></div><div class="line"><a name="l00098"></a><span > class="lineno"> 98</span> </div><div class="line"><a > name="l00099"></a><span class="lineno"> 99</span> <span > class="comment">// Function is overloaded for integral types to allow static > const</span></div><div class="line"><a name="l00100"></a><span > class="lineno"> 100</span> <span class="comment">// integrals declared > in classes and not defined to be used as arguments to</span></div><div > class="line"><a name="l00101"></a><span class="lineno"> > 101</span> <span class="comment">// CHECK* macros. It's not > encouraged though.</span></div><div class="line"><a name="l00102"></a><span > class="lineno"> 102</span> <span class="keyword">template</span> > <<span class="keyword">typename</span> T></div><div class="line"><a > name="l00103"></a><span class="lineno"> 103</span>  <span > class="keyword">inline</span> <span class= "keyword">const</span> T& GetReferenceableValue(<span class="keyword">const</span> T& t) {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">return</span> t;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">inline</span> <span class="keywordtype">char</span> GetReferenceableValue(<span class="keywordtype">char</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> GetReferenceableValue(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00108"></a><span class="lineno "> 108</span> <span class="keyword">inline</span> <span class="keywordtype">signed</span> <span class="keywordtype">char</span> GetReferenceableValue(<span class="keywordtype">signed</span> <span class="keywordtype">char</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword">inline</span> <span class="keywordtype">short</span> GetReferenceableValue(<span class="keywordtype">short</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> GetReferenceableValue(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span cl ass="keyword">inline</span> <span class="keywordtype">int</span> GetReferenceableValue(<span class="keywordtype">int</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetReferenceableValue(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">inline</span> <span class="keywordtype">long</span> GetReferenceableValue(<span class="keywordtype">long</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> GetRefer enceableValue(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">inline</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> GetReferenceableValue(<span class="keywordtype">long</span> <span class="keywordtype">long</span> t) { <span class="keywordflow">return</span> t; }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> GetReferenceableValue(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> t) {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> t;< /div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">// This formats a value for a failing CHECK_XX statement. Ordinarily,</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// it uses the definition for operator<<, with a few special cases below.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> MakeCheckOpValueString(std::ostream* os, <span class="keyword">const</span> T& v) {</div><div class="line"><a name="l00124" ></a><span class="lineno"> 124</span>  (*os) << v;</div><div >class="line"><a name="l00125"></a><span class="lineno"> >125</span> }</div><div class="line"><a name="l00126"></a><span >class="lineno"> 126</span> </div><div class="line"><a >name="l00127"></a><span class="lineno"> 127</span> <span >class="comment">// Overrides for char types provide readable values for >unprintable</span></div><div class="line"><a name="l00128"></a><span >class="lineno"> 128</span> <span class="comment">// >characters.</span></div><div class="line"><a name="l00129"></a><span >class="lineno"> 129</span> <span class="keyword">template</span> ><></div><div class="line"><a name="l00130"></a><span class="lineno"> >130</span> <span class="keywordtype">void</span> >MakeCheckOpValueString(std::ostream* os, <span class="keyword">const</span> ><span class="keywordtype">char</span>& v);</div><div class="line"><a >name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">template</span> <></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">void</span> MakeCheckOpValueString(std::ostream* os, <span class="keyword">const</span> <span class="keywordtype">signed</span> <span class="keywordtype">char</span>& v);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">template</span> <></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">void</span> MakeCheckOpValueString(std::ostream* os, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>& v);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">// We need an explicit specialization for std::nullptr_t.</sp an></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">template</span> <></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">void</span> MakeCheckOpValueString(std::ostream* os, <span class="keyword">const</span> std::nullptr_t& p);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">// A container for a string pointer which can be evaluated to a bool -</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// true iff the pointer is non-NULL.</span></div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="structsinga_1_1logging_1_1CheckOpString.html"> 142</a></span> <span class="keyword">struct </span><a class="code" href="structsinga_1 _1logging_1_1CheckOpString.html">CheckOpString</a> {</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="structsinga_1_1logging_1_1CheckOpString.html">CheckOpString</a>(<span class="keywordtype">string</span>* str) : str_(str) {}</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// No destructor: if str_ is non-NULL, we're about to LOG(FATAL),</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">// so there's no point in cleaning up str_.</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> str_ != NULL; }</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">string</span>* str_;</div><div c lass="line"><a name="l00148"></a><span class="lineno"> 148</span> };</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">// Build the error message string. Specify no inlining for code size.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T1, <span class="keyword">typename</span> T2></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="keywordtype">string</span>* MakeCheckOpString(<span class="keyword">const</span> T1& v1, <span class="keyword">const</span> T2& v2,</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* exprtext);</div><div class="line"><a name="l001 54"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">// A helper class for formatting "expr (V1 vs. V2)" in a CHECK_XX</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">// statement. See MakeCheckOpString for sample usage. Other</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">// approaches were considered: use of a template method (e.g.,</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">// base::BuildCheckOpString(exprtext, base::Print<T1>, &v1,</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">// base::Print<T2>, &v2), however this approach has complications</span></div><div class="line"><a name="l00160"></ a><span class="lineno"> 160</span> <span class="comment">// related to volatile arguments and function-pointer arguments).</span></div><div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html"> 161</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html">CheckOpMessageBuilder</a> {</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// Inserts "exprtext" and " (" to the stream.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html">CheckOpMessageBuilder</a>(<span class="keyword">const</span> < span class="keywordtype">char</span>* exprtext);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="comment">// Deletes "stream_".</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  ~<a class="code" href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html">CheckOpMessageBuilder</a>();</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// For inserting the first variable.</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  std::ostream* ForVar1() { <span class="keywordflow">return</span> stream_; }</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">// For inserting the second variable (adds an intermediate " vs. ").</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  std::ostream* ForVar2 ();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="comment">// Get the result (inserts the closing ")").</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">string</span>* NewString();</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  std::ostringstream* stream_;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> };</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T1, <span class="keyword">typena me</span> T2></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="keywordtype">string</span>* MakeCheckOpString(<span class="keyword">const</span> T1& v1, <span class="keyword">const</span> T2& v2, <span class="keyword">const</span> <span class="keywordtype">char</span>* exprtext) {</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <a class="code" href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html">CheckOpMessageBuilder</a> comb(exprtext);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  MakeCheckOpValueString(comb.ForVar1(), v1);</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  MakeCheckOpValueString(comb.ForVar2(), v2);</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordflow">return</span> comb.NewString();</div><div class="line"><a name="l00184"></a><span class ="lineno"> 184</span> }</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment">// Helper functions for CHECK_OP macro.</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">// The (int, int) specialization works around the issue that the compiler</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// will not instantiate the template version of the function on values of</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">// unnamed enum type - see comment below.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="preprocessor">#define SINGA_DEFINE_CHECK_OP_IMPL(name, op) \</span></div><div class=" line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor"> template <typename T1, typename T2> \</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor"> inline string* name##Impl(const T1& v1, const T2& v2, \</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor"> const char* exprtext) { \</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor"> if (v1 op v2) \</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="preprocessor"> return NULL; \</span></div><div class="line"><a name="l00196"></a><span class="lin eno"> 196</span> <span class="preprocessor"> else \</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="preprocessor"> return ::singa::logging::MakeCheckOpString(v1, v2, exprtext); \</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="preprocessor"> } \</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor"> inline string* name##Impl(int v1, int v2, const char* exprtext) { \</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="preprocessor"> return name##Impl<int, int>(v1, v2, exprtext); \</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">// We use the full name Check_EQ, Check_NE, etc. in case the file including</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">// base/logging.h provides its own #defines for the simpler names EQ, NE, etc.</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">// This happens if, for example, those are used as token names in a</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">// yacc grammar.</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_EQ,</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  == ) <span class="comment">// Compilation error with CHECK_EQ(NULL, x)?</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_NE, != ) <span class="comment">// Use CHECK(x == NULL) instead.</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_LE, <= )</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_LT, < )</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_GE, >= )</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> SINGA_DEFINE_CHECK_OP_IMPL(Check_GT, > )</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor">#undef SINGA_DEFINE_CHECK_OP_IMPL</span></div><div class="line"><a name="l00215"></a><span clas s="lineno"> 215</span> </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">// In optimized mode, use CheckOpString to hint to compiler that</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment">// the while condition is unlikely.</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor">#define CHECK_OP_LOG(name, op, val1, val2) \</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor"> while (::singa::logging::CheckOpString _result = \</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor"> ::singa::logging::name##Impl( \</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span clas s="preprocessor"> ::singa::logging::GetReferenceableValue(val1), \</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor"> ::singa::logging::GetReferenceableValue(val2), \</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor"> #val1 " " #op " " #val2)) \</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="preprocessor"> ::singa::logging::LogMessageFatal(__FILE__, __LINE__) << *(_result.str_)</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor">#define CHECK_OP(name, op, val1, val2) CHECK_OP_LOG(name, op, val1, val2)</span></div><div class="line"><a name="l00227"></a><spa n class="lineno"> 227</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment">// CHECK_EQ/NE/...</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor">#define CHECK_EQ(val1, val2) CHECK_OP(Check_EQ, ==, val1, val2)</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="preprocessor">#define CHECK_NE(val1, val2) CHECK_OP(Check_NE, !=, val1, val2)</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor">#define CHECK_LE(val1, val2) CHECK_OP(Check_LE, <=, val1, val2)</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="preprocessor">#define CHECK_LT(val1, val2) CHECK_OP(Check_LT, <, val1, val2)</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="prepr ocessor">#define CHECK_GE(val1, val2) CHECK_OP(Check_GE, >=, val1, val2)</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#define CHECK_GT(val1, val2) CHECK_OP(Check_GT, >, val1, val2)</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor">#define CHECK_NOTNULL(val) \</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor"> ::singa::logging::CheckNotNull(__FILE__, __LINE__, \</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor"> "'" #val "' Must be non NULL", (val))</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <s pan class="preprocessor">#ifndef NDEBUG</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment">// DCHECK_EQ/NE/...</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#define DCHECK(condition) CHECK(condition)</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="preprocessor">#define DCHECK_EQ(val1, val2) CHECK_EQ(val1, val2)</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#define DCHECK_NE(val1, val2) CHECK_NE(val1, val2)</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor">#define DCHECK_LE(val1, val2) CHECK_LE(val1, val2)</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor">#define DCHECK_LT(val1, val2) CHECK_LT(val1, val2)</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="preprocessor">#define DCHECK_GE(val1, val2) CHECK_GE(val1, val2)</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor">#define DCHECK_GT(val1, val2) CHECK_GT(val1, val2)</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor">#define DCHECK(condition) \</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor"> while (false && (condition)) LOG(FATAL)</span></div><div class="line"><a name="l00253"></a> <span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment">// NDEBUG is defined, so DCHECK_EQ(x, y) and so on do nothing.</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment">// However, we still want the compiler to parse x and y, because</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">// we don't want to lose potentially useful errors and warnings.</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">// _DCHECK_NOP is a helper, and should not be used outside of this file.</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="preprocessor">#define _SINGA_DCHECK_NOP(x, y) \</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor"> while (false && ((void)(x), (void)(y), 0)) LOG(FATAL)</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor">#define DCHECK_EQ(x, y) _SINGA_DCHECK_NOP(x, y)</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="preprocessor">#define DCHECK_NE(x, y) _SINGA_DCHECK_NOP(x, y)</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="preprocessor">#define DCHECK_LE(x, y) _SINGA_DCHECK_NOP(x, y)</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="preprocessor">#define DCHECK_LT(x, y) _SINGA_DCHECK_NOP(x, y)</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="preprocessor">#define DCHECK_GE(x, y) _SINGA_DCHECK_NOP(x, y)</s pan></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="preprocessor">#define DCHECK_GT(x, y) _SINGA_DCHECK_NOP(x, y)</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">// These are for when you don't want a CHECK failure to print a verbose</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment">// stack trace. The implementation of CHECK* in this file already doesn't.</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor">#define QCHECK(condition) CHECK(condition)</s pan></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor">#define QCHECK_EQ(x, y) CHECK_EQ(x, y)</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="preprocessor">#define QCHECK_NE(x, y) CHECK_NE(x, y)</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="preprocessor">#define QCHECK_LE(x, y) CHECK_LE(x, y)</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="preprocessor">#define QCHECK_LT(x, y) CHECK_LT(x, y)</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="preprocessor">#define QCHECK_GE(x, y) CHECK_GE(x, y)</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="preprocessor">#define QCHECK_GT(x, y) CHECK_GT(x, y)</span></div><div class="line"><a name="l00279"></a><span class= "lineno"> 279</span> </div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> T&& CheckNotNull(<span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span>* exprtext, T&& t) {</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordflow">if</span> (t == <span class="keyword">nullptr</span>) {</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <a class="code" href="classsinga_1_1logging_1_1LogMessageFatal.html">LogMessageFatal</a>(file, line) << string(exprtext);</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  } </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordflow">return</span> std::forward<T>(t);</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> }</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> } <span class="comment">// namespace logging</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor">#end if // SINGA_UTILS_LOGGING_H_</span></div><div class="ttc" id="namespacesinga_html_ad5e79d66673cb3bd4e824d3a14979244"><div class="ttname"><a href="namespacesinga.html#ad5e79d66673cb3bd4e824d3a14979244">singa::LogToStderr</a></div><div class="ttdeci">void LogToStderr()</div><div class="ttdoc">Make it so that all log messages go only to stderr. </div></div> +<div class="ttc" id="classsinga_1_1logging_1_1LogMessage_html"><div class="ttname"><a href="classsinga_1_1logging_1_1LogMessage.html">singa::logging::LogMessage</a></div><div class="ttdef"><b>Definition:</b> logging.h:57</div></div> +<div class="ttc" id="classsinga_1_1logging_1_1LogMessageFatal_html"><div class="ttname"><a href="classsinga_1_1logging_1_1LogMessageFatal.html">singa::logging::LogMessageFatal</a></div><div class="ttdef"><b>Definition:</b> logging.h:74</div></div> +<div class="ttc" id="namespacesinga_html_aa1c53496f790ff43b264f4cd84b723ea"><div class="ttname"><a href="namespacesinga.html#aa1c53496f790ff43b264f4cd84b723ea">singa::InitLogging</a></div><div class="ttdeci">void InitLogging(const char *argv)</div><div class="ttdoc">Global functions for both glog and built-in log. </div></div> +<div class="ttc" id="classsinga_1_1logging_1_1CheckOpMessageBuilder_html"><div class="ttname"><a href="classsinga_1_1logging_1_1CheckOpMessageBuilder.html">singa::logging::CheckOpMessageBuilder</a></div><div class="ttdef"><b>Definition:</b> logging.h:161</div></div> +<div class="ttc" id="structsinga_1_1logging_1_1CheckOpString_html"><div class="ttname"><a href="structsinga_1_1logging_1_1CheckOpString.html">singa::logging::CheckOpString</a></div><div class="ttdef"><b>Definition:</b> logging.h:142</div></div> +<div class="ttc" id="namespacesinga_html_af45997ae6f3babb10023156d4c0993fc"><div class="ttname"><a href="namespacesinga.html#af45997ae6f3babb10023156d4c0993fc">singa::SetStderrLogging</a></div><div class="ttdeci">void SetStderrLogging(int severity)</div><div class="ttdoc">Make it so that all log messages of at least a particular severity are logged to stderr (in addtion t...</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_a23f5f64072659d14ef6251faaead345a"><div class="ttname"><a href="namespacesinga.html#a23f5f64072659d14ef6251faaead345a">singa::SetLogDestination</a></div><div class="ttdeci">void SetLogDestination(int severity, const char *path)</div><div class="ttdoc">Set the file name for logging (and disable logging to stderr) </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/loss_8h_source.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/loss_8h_source.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/loss_8h_source.html (added) +++ incubator/singa/site/trunk/doxygen/html/loss_8h_source.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,88 @@ +<!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/model/loss.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_1ed15e94f94d348ba7de93ac6315cc91.html">model</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">loss.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef SINGA_MODEL_LOSS_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_MODEL_LOSS_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <stack></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "singa/proto/model.pb.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="nam espacesinga.html">singa</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// template <typename T = Tensor></span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classsinga_1_1Loss.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Loss.html">Loss</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classsinga_1_1Loss.html">Loss</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> Setup(<span class="keyword">const</span> <span class="keywordtype">string< /span> &conf) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  LossConf loss;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  loss.ParseFromString(conf);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  Setup(loss);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Loss.html">Loss</a>() {};</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ToDevice(std::shared_ptr<Device> device) {}</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525"> 42</a></span>  <span cl ass="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">Setup</a>(<span class="keyword">const</span> LossConf &conf) {}</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> &prediction,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> &target) = 0;</div><div class="line"><a name="l00048"></a><s pan class="lineno"> 48</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce"> 52</a></span>  <span class="keywordtype">float</span> <a class="code" href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">Evaluate</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> &prediction, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> &target) {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> loss = <a class="code" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a>(flag, prediction, target);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">retu rn</span> Sum<float>(loss) / (1.0f * loss.<a class="code" href="classsinga_1_1Tensor.html#a1c38d62986020862905d1307c09972e0">Size</a>());</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">Backward</a>() = 0;</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"> 61</span> <span class="comment">// ============= Mean Squared Error ===========================================</span></div><div class="line"><a name="l0006 3"></a><span class="lineno"><a class="line" href="classsinga_1_1MSE.html"> 63</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classsinga_1_1MSE.html">MSE</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Loss.html">Loss</a> {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html"> Tensor</a>& target) <span class="keyword">override</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">Backward</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// to buffer intermediate data, i.e., prediction-target</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::stack<Tensor> buf_;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>& #160;};</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> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// ===============Softamx Cross Entropy =======================================</span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classsinga_1_1SoftmaxCrossEntropy.html"> 84</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classsinga_1_1SoftmaxCrossEntropy.html">SoftmaxCrossEntropy</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Loss.html">Loss</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classs inga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">Forward</a>(<span class="keywordtype">int</span> flag, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& prediction,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& target) <span class="keyword">override</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> <a class="code" href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">Backward</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l 00106"></a><span class="lineno"> 106</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// to buffer intermediate data, i.e., probability for each category and</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// the target (ground truth)</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  std::stack<Tensor> buf_;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> };</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</spa n> <span class="preprocessor">#endif // SINGA_MODEL_LOSS_H_</span></div><div class="ttc" id="classsinga_1_1Loss_html_ad8ce9cac8b07719a2dcf2e5a50585f80"><div class="ttname"><a href="classsinga_1_1Loss.html#ad8ce9cac8b07719a2dcf2e5a50585f80">singa::Loss::Forward</a></div><div class="ttdeci">virtual Tensor Forward(int flag, const Tensor &prediction, const Tensor &target)=0</div><div class="ttdoc">Compute the loss values for each sample/instance given the prediction and the target. </div></div> +<div class="ttc" id="classsinga_1_1SoftmaxCrossEntropy_html"><div class="ttname"><a href="classsinga_1_1SoftmaxCrossEntropy.html">singa::SoftmaxCrossEntropy</a></div><div class="ttdoc">Softmax + cross entropy for multi-category classification. </div><div class="ttdef"><b>Definition:</b> loss.h:84</div></div> +<div class="ttc" id="classsinga_1_1Loss_html_a82a5257979b7111e283b2da846124a08"><div class="ttname"><a href="classsinga_1_1Loss.html#a82a5257979b7111e283b2da846124a08">singa::Loss::Backward</a></div><div class="ttdeci">virtual Tensor Backward()=0</div><div class="ttdoc">Compute the gradients of the loss values w.r.t. the prediction. </div></div> +<div class="ttc" id="classsinga_1_1Tensor_html"><div class="ttname"><a href="classsinga_1_1Tensor.html">singa::Tensor</a></div><div class="ttdoc">A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...</div><div class="ttdef"><b>Definition:</b> tensor.h:56</div></div> +<div class="ttc" id="classsinga_1_1Loss_html"><div class="ttname"><a href="classsinga_1_1Loss.html">singa::Loss</a></div><div class="ttdoc">The base loss class, which declares the APIs for computing the objective score (loss) for a pair of p...</div><div class="ttdef"><b>Definition:</b> loss.h:31</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="classsinga_1_1Tensor_html_a1c38d62986020862905d1307c09972e0"><div class="ttname"><a href="classsinga_1_1Tensor.html#a1c38d62986020862905d1307c09972e0">singa::Tensor::Size</a></div><div class="ttdeci">size_t Size() const</div><div class="ttdoc">Return number of total elements. </div><div class="ttdef"><b>Definition:</b> tensor.h:128</div></div> +<div class="ttc" id="classsinga_1_1MSE_html"><div class="ttname"><a href="classsinga_1_1MSE.html">singa::MSE</a></div><div class="ttdoc">MSE is for mean squared error or squared euclidean distance. </div><div class="ttdef"><b>Definition:</b> loss.h:63</div></div> +<div class="ttc" id="classsinga_1_1Loss_html_a7dfd3be50e9f20430604d4adab1664ce"><div class="ttname"><a href="classsinga_1_1Loss.html#a7dfd3be50e9f20430604d4adab1664ce">singa::Loss::Evaluate</a></div><div class="ttdeci">float Evaluate(int flag, const Tensor &prediction, const Tensor &target)</div><div class="ttdoc">Average loss values for all samples in the mini-batch It calls Forward() internally. </div><div class="ttdef"><b>Definition:</b> loss.h:52</div></div> +<div class="ttc" id="classsinga_1_1Loss_html_a5be3a26d72200fb17ce1b2fa8c866525"><div class="ttname"><a href="classsinga_1_1Loss.html#a5be3a26d72200fb17ce1b2fa8c866525">singa::Loss::Setup</a></div><div class="ttdeci">virtual void Setup(const LossConf &conf)</div><div class="ttdoc">Set meta fields from user configurations. </div><div class="ttdef"><b>Definition:</b> loss.h:42</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/memory_8h_source.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/memory_8h_source.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/memory_8h_source.html (added) +++ incubator/singa/site/trunk/doxygen/html/memory_8h_source.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,82 @@ +<!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/core/memory.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_0c57f5a0b2589d9cd025f1d3faf7a1ee.html">core</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">memory.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef SINGA_CORE_MEMORY_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_CORE_MEMORY_H_</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">#include <mutex></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "singa/proto/core.pb.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&# 160;<span class="preprocessor">#include "singa/singa_config.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">#ifdef USE_CUDA</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "cnmem.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</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_1VirtualMemory.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1VirtualMemory.html">VirtualMemory</a> {};</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classsinga_1_1DeviceMemPool.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</sp an> size) = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr) = 0;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0"> 43</a></span>  <span class="keyword">virtual</span> std::pair<size_t, size_t> <a class="code" href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0">GetMemUsage</a>() {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">return</span> std::make_pair(0u, 0u);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  < span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a>(){};</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">size_t</span> usage_;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// size_t init_size_ = 0, max_size_ = 0;</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> };</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#ifdef USE_CUDA</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">class </span>CnMemPool : <span class="keyword">public</span> <a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Create the mem pool by setting the devices [0, numDevices), and</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// initial pool size (MB), and max pool size (no effect currently).</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  CnMemPool(<span class="keywordtype">int</span> numDevices = 1, <span class="keywordtype">size_t</span> init_size = 256, <span class="keywordtype">size_t</span> max_size = 0);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  CnMemPool (<span class="keyword">const</span> MemPoolConf& conf);</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>  <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::pair<size_t, size_t> GetMemUsage() <span class="keyword">override</span>;</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="comment">// release all memory and set cnmem manager to unintialized</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  ~CnMemPool();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> Init();</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </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>  <span class="keyword">private</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  MemPoolConf conf_;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// whether the (global) memory pool has been initialized</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> initialized_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// lock on the initialized variable</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::mutex mtx_;</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">static</span> std::atomic<int> pool_count;</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> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">class </span>CudaMemPool : <span class="keyword">public</span> <a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr) <span class="keyword">override</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> <span >class="preprocessor">#endif</span></div><div class="line"><a >name="l00090"></a><span class="lineno"> 90</span> } <span >class="comment">// namespace singa</span></div><div class="line"><a >name="l00091"></a><span class="lineno"> 91</span> <span >class="preprocessor">#endif // SINGA_CORE_MEMORY_H_</span></div><div >class="ttc" id="classsinga_1_1VirtualMemory_html"><div class="ttname"><a >href="classsinga_1_1VirtualMemory.html">singa::VirtualMemory</a></div><div >class="ttdoc">Manage device memory pool including garbage collection, memory >opt. </div><div class="ttdef"><b>Definition:</b> memory.h:35</div></div> +<div class="ttc" id="classsinga_1_1DeviceMemPool_html_a24963bb78608bd2d69df9d247f26ced0"><div class="ttname"><a href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0">singa::DeviceMemPool::GetMemUsage</a></div><div class="ttdeci">virtual std::pair< size_t, size_t > GetMemUsage()</div><div class="ttdoc">Return a pair for free and total memory managed by this pool. </div><div class="ttdef"><b>Definition:</b> memory.h:43</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="classsinga_1_1DeviceMemPool_html"><div class="ttname"><a href="classsinga_1_1DeviceMemPool.html">singa::DeviceMemPool</a></div><div class="ttdef"><b>Definition:</b> memory.h:37</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/menu.js URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/menu.js?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/menu.js (added) +++ incubator/singa/site/trunk/doxygen/html/menu.js Mon Apr 22 10:37:18 2019 @@ -0,0 +1,26 @@ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+='<ul>'; + for (var i in data.children) { + result+='<li><a href="'+relPath+data.children[i].url+'">'+ + data.children[i].text+'</a>'+ + makeTree(data.children[i],relPath)+'</li>'; + } + result+='</ul>'; + } + return result; + } + + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchEnabled) { + if (serverSide) { + $('#main-menu').append('<li style="float:right"><div id="MSearchBox" class="MSearchBoxInactive"><div class="left"><form id="FSearchBox" action="'+searchPage+'" method="get"><img id="MSearchSelect" src="'+relPath+'search/mag.png" alt=""/><input type="text" id="MSearchField" name="query" value="'+search+'" size="20" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)"></form></div><div class="right"></div></div></li>'); + } else { + $('#main-menu').append('<li style="float:right"><div id="MSearchBox" class="MSearchBoxInactive"><span class="left"><img id="MSearchSelect" src="'+relPath+'search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/><input type="text" id="MSearchField" value="'+search+'" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/></span><span class="right"><a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="'+relPath+'search/close.png" alt=""/></a></span></div></li>'); + } + } + $('#main-menu').smartmenus(); +}
