http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/bdwn.png ---------------------------------------------------------------------- diff --git a/api/bdwn.png b/api/bdwn.png new file mode 100644 index 0000000..940a0b9 Binary files /dev/null and b/api/bdwn.png differ
http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/blob_8h_source.html ---------------------------------------------------------------------- diff --git a/api/blob_8h_source.html b/api/blob_8h_source.html new file mode 100644 index 0000000..78f425c --- /dev/null +++ b/api/blob_8h_source.html @@ -0,0 +1,198 @@ +<!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.6"/> +<title>Apache SINGA: /home/wangwei/program/asf/incubator-singa/include/utils/blob.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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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_6c391fc7db700cf41983872f39408b84.html">asf</a></li><li class="navelem"><a class="el" href="dir_13981ebe1996195cf5339def4a394399.html">incubator-singa</a></li><li class="navelem"><a class="el" href="dir_a20507fa2f2ddc21c47fdd32cfd67062.html">include</a></li><li class="navelem"><a class="el" href="dir_b3c0b766b89f59af8c2c245fcdc54977.html">utils</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">blob.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="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifndef INCLUDE_UTILS_BLOB_</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDE_UTILS_BLOB_</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor">#include <memory></span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include <vector></span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <glog/logging.h></span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "proto/model.pb.h"</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">using</span> std::shared_ptr;</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">using</span> std::vector;</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define NOT_IMPLEMENTED LOG(FATAL) << "Not implemented function"</span></div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="keyword">inline</span> <span class="keywordtype">void</span> MallocHost(<span class="keywordtype">void</span>** ptr, <span class="keywordtype">size_t</span> size) {</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  *ptr = malloc(size);</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> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> FreeHost(<span class="keywordtype">void</span>* ptr) {</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  free(ptr);</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classSyncedMemory.html"> 65</a></span> <span class="keyword">class </span><a class="code" href="classSyncedMemory.html">SyncedMemory</a> {</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span>:</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classSyncedMemory.html">SyncedMemory</a>()</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  : cpu_ptr_(NULL), gpu_ptr_(NULL), size_(0), head_(UNINITIALIZED),</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  own_cpu_data_(<span class="keyword">false</span>) {}</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">explicit</span> <a class="code" href="classSyncedMemory.html">SyncedMemory</a>(<span class="keywordtype">size_t</span> size)</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  : cpu_ptr_(NULL), gpu_ptr_(NULL), size_(size), head_(UNINITIALIZED),</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  own_cpu_data_(<span class="keyword">false</span>) {}</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  ~<a class="code" href="classSyncedMemory.html">SyncedMemory</a>();</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* cpu_data();</div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> set_cpu_data(<span class="keywordtype">void</span>* data);</div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* gpu_data();</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span>* mutable_cpu_data();</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span>* mutable_gpu_data();</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">enum</span> SyncedHead { UNINITIALIZED, HEAD_AT_CPU, HEAD_AT_GPU, SYNCED };</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  SyncedHead head() { <span class="keywordflow">return</span> head_; }</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">size_t</span> size() { <span class="keywordflow">return</span> size_; }</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="keyword">private</span>:</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> to_cpu();</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> to_gpu();</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span>* cpu_ptr_;</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span>* gpu_ptr_;</div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">size_t</span> size_;</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  SyncedHead head_;</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">bool</span> own_cpu_data_;</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }; <span class="comment">// class SyncedMemory</span></div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Dtype></div> +<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classBlob.html"> 96</a></span> <span class="keyword">class </span><a class="code" href="classBlob.html">Blob</a> {</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">public</span>:</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classBlob.html">Blob</a>(): count_(0), capacity_(0) {}</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classBlob.html">Blob</a>(<span class="keyword">const</span> vector<int>&shape);</div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">void</span> <a class="code" href="classBlob.html#a7161872dea41d5b062269fec75fe9838">Reshape</a>(<span class="keyword">const</span> vector<int>& shape);</div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> ReshapeLike(<span class="keyword">const</span> <a class="code" href="classBlob.html">Blob</a>& other);</div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> vector<int>& shape()<span class="keyword"> const</span>{</div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> shape_;</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>  <span class="keyword">inline</span> <span class="keywordtype">int</span> count()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> count_; }</div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> <a class="code" href="classBlob.html#a283b080c7a275e679bb6d94c1a400591">CopyFrom</a>(<span class="keyword">const</span> <a class="code" href="classBlob.html">Blob<Dtype></a>& source, <span class="keywordtype">bool</span> <a class="code" href="namespacemshadow_1_1expr.html#a5a65c95414492a64bb51dbd0710fd9c7">reshape</a> = <span class="keyword">false</span>);</div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">inline</span> <span class="keyword">const</span> shared_ptr<SyncedMemory>& data()<span class="keyword"> const </span>{</div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  CHECK(data_);</div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> data_;</div> +<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">const</span> Dtype* cpu_data() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">void</span> set_cpu_data(Dtype* data);</div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">const</span> Dtype* gpu_data() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  Dtype* mutable_cpu_data();</div> +<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  Dtype* mutable_gpu_data();</div> +<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">/*</span></div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> void FromProto(const BlobProto& proto);</span></div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> */</span></div> +<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">void</span> ToProto(singa::BlobProto* proto) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div> +<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  Dtype <a class="code" href="classBlob.html#a2418f1337d7d20cf5503111ce362f52d">asum_data</a>() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  Dtype sum_data() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">void</span> <a class="code" href="classBlob.html#ae1617a8210879355ea6d58e0677ec17a">ShareData</a>(<span class="keyword">const</span> <a class="code" href="classBlob.html">Blob</a>& other);</div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">void</span> Swap(<a class="code" href="classBlob.html">Blob</a>& other);</div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  shared_ptr<SyncedMemory> data_;</div> +<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  vector<int> shape_;</div> +<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">int</span> count_;</div> +<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">int</span> capacity_;</div> +<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> }; <span class="comment">// class Blob</span></div> +<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div> +<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="preprocessor">#endif // INCLUDE_UTILS_BLOB_</span></div> +<div class="ttc" id="classBlob_html"><div class="ttname"><a href="classBlob.html">Blob</a></div><div class="ttdef"><b>Definition:</b> blob.h:96</div></div> +<div class="ttc" id="classSyncedMemory_html"><div class="ttname"><a href="classSyncedMemory.html">SyncedMemory</a></div><div class="ttdoc">Manages memory allocation and synchronization between the host (CPU) and device (GPU). </div><div class="ttdef"><b>Definition:</b> blob.h:65</div></div> +<div class="ttc" id="classBlob_html_ae1617a8210879355ea6d58e0677ec17a"><div class="ttname"><a href="classBlob.html#ae1617a8210879355ea6d58e0677ec17a">Blob::ShareData</a></div><div class="ttdeci">void ShareData(const Blob &other)</div><div class="ttdoc">Set the data_ shared_ptr to point to the SyncedMemory holding the data_ of Blob other â useful in Lay...</div></div> +<div class="ttc" id="classBlob_html_a2418f1337d7d20cf5503111ce362f52d"><div class="ttname"><a href="classBlob.html#a2418f1337d7d20cf5503111ce362f52d">Blob::asum_data</a></div><div class="ttdeci">Dtype asum_data() const </div><div class="ttdoc">Compute the sum of absolute values (L1 norm) of the data. </div></div> +<div class="ttc" id="classBlob_html_a7161872dea41d5b062269fec75fe9838"><div class="ttname"><a href="classBlob.html#a7161872dea41d5b062269fec75fe9838">Blob::Reshape</a></div><div class="ttdeci">void Reshape(const vector< int > &shape)</div><div class="ttdoc">Change the dimensions of the blob, allocating new memory if necessary. </div></div> +<div class="ttc" id="classBlob_html_a283b080c7a275e679bb6d94c1a400591"><div class="ttname"><a href="classBlob.html#a283b080c7a275e679bb6d94c1a400591">Blob::CopyFrom</a></div><div class="ttdeci">void CopyFrom(const Blob< Dtype > &source, bool reshape=false)</div><div class="ttdoc">Copy from a source Blob. </div></div> +<div class="ttc" id="namespacemshadow_1_1expr_html_a5a65c95414492a64bb51dbd0710fd9c7"><div class="ttname"><a href="namespacemshadow_1_1expr.html#a5a65c95414492a64bb51dbd0710fd9c7">mshadow::expr::reshape</a></div><div class="ttdeci">ReshapeExp< SrcExp, dimdst, ExpInfo< SrcExp >::kDim > reshape(const Exp< SrcExp, etype > &src, Shape< dimdst > oshape)</div><div class="ttdoc">a expression that reshapes a tensor to another shape </div><div class="ttdef"><b>Definition:</b> tensor_expr_ext.h:406</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classASingleton-members.html ---------------------------------------------------------------------- diff --git a/api/classASingleton-members.html b/api/classASingleton-members.html new file mode 100644 index 0000000..2c695b0 --- /dev/null +++ b/api/classASingleton-members.html @@ -0,0 +1,104 @@ +<!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.6"/> +<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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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">ASingleton< T, X > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classASingleton.html">ASingleton< T, X ></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="classASingleton.html">ASingleton< T, X ></a>)</td><td class="entry"><a class="el" href="classASingleton.html">ASingleton< T, X ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Instance</b>(X x) (defined in <a class="el" href="classASingleton.html">ASingleton< T, X ></a>)</td><td class="entry"><a class="el" href="classASingleton.html">ASingleton< T, X ></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 Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classASingleton.html ---------------------------------------------------------------------- diff --git a/api/classASingleton.html b/api/classASingleton.html new file mode 100644 index 0000000..967db6a --- /dev/null +++ b/api/classASingleton.html @@ -0,0 +1,125 @@ +<!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.6"/> +<title>Apache SINGA: ASingleton< T, X > 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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="classASingleton-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ASingleton< T, X > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="classSingleton.html">Singleton</a> initiated with argument. + <a href="classASingleton.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:ac2fe7edb6b16a6154bd81a5f8d61cce9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2fe7edb6b16a6154bd81a5f8d61cce9"></a> +static T * </td><td class="memItemRight" valign="bottom"><b>Instance</b> ()</td></tr> +<tr class="separator:ac2fe7edb6b16a6154bd81a5f8d61cce9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24394eac155ed8cac64bf9b880855762"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24394eac155ed8cac64bf9b880855762"></a> +static T * </td><td class="memItemRight" valign="bottom"><b>Instance</b> (X x)</td></tr> +<tr class="separator:a24394eac155ed8cac64bf9b880855762"><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 X = int><br/> +class ASingleton< T, X ></h3> + +<p><a class="el" href="classSingleton.html">Singleton</a> initiated with argument. </p> +</div><hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wangwei/program/asf/incubator-singa/include/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 Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classBlob-members.html ---------------------------------------------------------------------- diff --git a/api/classBlob-members.html b/api/classBlob-members.html new file mode 100644 index 0000000..350d746 --- /dev/null +++ b/api/classBlob-members.html @@ -0,0 +1,124 @@ +<!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.6"/> +<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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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">Blob< Dtype > Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classBlob.html">Blob< Dtype ></a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classBlob.html#a2418f1337d7d20cf5503111ce362f52d">asum_data</a>() const </td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Blob</b>() (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Blob</b>(const vector< int > &shape) (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>capacity_</b> (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classBlob.html#a283b080c7a275e679bb6d94c1a400591">CopyFrom</a>(const Blob< Dtype > &source, bool reshape=false)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>count</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>count_</b> (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>cpu_data</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>data</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>data_</b> (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>gpu_data</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>mutable_cpu_data</b>() (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>mutable_gpu_data</b>() (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classBlob.html#a7161872dea41d5b062269fec75fe9838">Reshape</a>(const vector< int > &shape)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ReshapeLike</b>(const Blob &other) (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>set_cpu_data</b>(Dtype *data) (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>shape</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>shape_</b> (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classBlob.html#ae1617a8210879355ea6d58e0677ec17a">ShareData</a>(const Blob &other)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>sum_data</b>() const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Swap</b>(Blob &other) (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>ToProto</b>(singa::BlobProto *proto) const (defined in <a class="el" href="classBlob.html">Blob< Dtype ></a>)</td><td class="entry"><a class="el" href="classBlob.html">Blob< Dtype ></a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classBlob.html ---------------------------------------------------------------------- diff --git a/api/classBlob.html b/api/classBlob.html new file mode 100644 index 0000000..6f53b2f --- /dev/null +++ b/api/classBlob.html @@ -0,0 +1,262 @@ +<!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.6"/> +<title>Apache SINGA: Blob< Dtype > 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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="#pub-attribs">Public Attributes</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classBlob-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Blob< Dtype > 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:afa6f8b83284665011b323cbc224e8997"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa6f8b83284665011b323cbc224e8997"></a> + </td><td class="memItemRight" valign="bottom"><b>Blob</b> (const vector< int > &shape)</td></tr> +<tr class="separator:afa6f8b83284665011b323cbc224e8997"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7161872dea41d5b062269fec75fe9838"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlob.html#a7161872dea41d5b062269fec75fe9838">Reshape</a> (const vector< int > &shape)</td></tr> +<tr class="memdesc:a7161872dea41d5b062269fec75fe9838"><td class="mdescLeft"> </td><td class="mdescRight">Change the dimensions of the blob, allocating new memory if necessary. <a href="#a7161872dea41d5b062269fec75fe9838">More...</a><br/></td></tr> +<tr class="separator:a7161872dea41d5b062269fec75fe9838"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16c0fb27b89e2368f93f7511884471b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16c0fb27b89e2368f93f7511884471b0"></a> +void </td><td class="memItemRight" valign="bottom"><b>ReshapeLike</b> (const <a class="el" href="classBlob.html">Blob</a> &other)</td></tr> +<tr class="separator:a16c0fb27b89e2368f93f7511884471b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30b80b373bbbcb008dc7dc8fc7fba18c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30b80b373bbbcb008dc7dc8fc7fba18c"></a> +const vector< int > & </td><td class="memItemRight" valign="bottom"><b>shape</b> () const </td></tr> +<tr class="separator:a30b80b373bbbcb008dc7dc8fc7fba18c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a42e1ed7459f88986893bea35b493269d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e1ed7459f88986893bea35b493269d"></a> +int </td><td class="memItemRight" valign="bottom"><b>count</b> () const </td></tr> +<tr class="separator:a42e1ed7459f88986893bea35b493269d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a283b080c7a275e679bb6d94c1a400591"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlob.html#a283b080c7a275e679bb6d94c1a400591">CopyFrom</a> (const <a class="el" href="classBlob.html">Blob</a>< Dtype > &source, bool reshape=false)</td></tr> +<tr class="memdesc:a283b080c7a275e679bb6d94c1a400591"><td class="mdescLeft"> </td><td class="mdescRight">Copy from a source <a class="el" href="classBlob.html">Blob</a>. <a href="#a283b080c7a275e679bb6d94c1a400591">More...</a><br/></td></tr> +<tr class="separator:a283b080c7a275e679bb6d94c1a400591"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0598550dcb7a4624b17618bbbce0dd9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0598550dcb7a4624b17618bbbce0dd9e"></a> +const shared_ptr< <a class="el" href="classSyncedMemory.html">SyncedMemory</a> > & </td><td class="memItemRight" valign="bottom"><b>data</b> () const </td></tr> +<tr class="separator:a0598550dcb7a4624b17618bbbce0dd9e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab9d1752994ca91b0e57e863914ad914d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9d1752994ca91b0e57e863914ad914d"></a> +const Dtype * </td><td class="memItemRight" valign="bottom"><b>cpu_data</b> () const </td></tr> +<tr class="separator:ab9d1752994ca91b0e57e863914ad914d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1b4ae7aecb3772d3538dd6d3dc02936e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b4ae7aecb3772d3538dd6d3dc02936e"></a> +void </td><td class="memItemRight" valign="bottom"><b>set_cpu_data</b> (Dtype *data)</td></tr> +<tr class="separator:a1b4ae7aecb3772d3538dd6d3dc02936e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a122850d3d43c234893cd25cea881d900"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a122850d3d43c234893cd25cea881d900"></a> +const Dtype * </td><td class="memItemRight" valign="bottom"><b>gpu_data</b> () const </td></tr> +<tr class="separator:a122850d3d43c234893cd25cea881d900"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aae4df49d1604c7cb0b3a1df7dc82940a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae4df49d1604c7cb0b3a1df7dc82940a"></a> +Dtype * </td><td class="memItemRight" valign="bottom"><b>mutable_cpu_data</b> ()</td></tr> +<tr class="separator:aae4df49d1604c7cb0b3a1df7dc82940a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ad82113ee31d9a6546f6a71f9283f22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ad82113ee31d9a6546f6a71f9283f22"></a> +Dtype * </td><td class="memItemRight" valign="bottom"><b>mutable_gpu_data</b> ()</td></tr> +<tr class="separator:a9ad82113ee31d9a6546f6a71f9283f22"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0a7378f1ef221245a4695d88b2d3b087"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a7378f1ef221245a4695d88b2d3b087"></a> +void </td><td class="memItemRight" valign="bottom"><b>ToProto</b> (singa::BlobProto *proto) const </td></tr> +<tr class="separator:a0a7378f1ef221245a4695d88b2d3b087"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2418f1337d7d20cf5503111ce362f52d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2418f1337d7d20cf5503111ce362f52d"></a> +Dtype </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlob.html#a2418f1337d7d20cf5503111ce362f52d">asum_data</a> () const </td></tr> +<tr class="memdesc:a2418f1337d7d20cf5503111ce362f52d"><td class="mdescLeft"> </td><td class="mdescRight">Compute the sum of absolute values (L1 norm) of the data. <br/></td></tr> +<tr class="separator:a2418f1337d7d20cf5503111ce362f52d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a04c2910de12ab10dd5040ccfe8da4dfb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04c2910de12ab10dd5040ccfe8da4dfb"></a> +Dtype </td><td class="memItemRight" valign="bottom"><b>sum_data</b> () const </td></tr> +<tr class="separator:a04c2910de12ab10dd5040ccfe8da4dfb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae1617a8210879355ea6d58e0677ec17a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBlob.html#ae1617a8210879355ea6d58e0677ec17a">ShareData</a> (const <a class="el" href="classBlob.html">Blob</a> &other)</td></tr> +<tr class="memdesc:ae1617a8210879355ea6d58e0677ec17a"><td class="mdescLeft"> </td><td class="mdescRight">Set the data_ shared_ptr to point to the <a class="el" href="classSyncedMemory.html" title="Manages memory allocation and synchronization between the host (CPU) and device (GPU). ">SyncedMemory</a> holding the data_ of <a class="el" href="classBlob.html">Blob</a> other – useful in Layer&s which simply perform a copy in their Forward pass. <a href="#ae1617a8210879355ea6d58e0677ec17a">More...</a><br/></td></tr> +<tr class="separator:ae1617a8210879355ea6d58e0677ec17a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac3d96c2279d884e9c8cecdfb56586ab9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3d96c2279d884e9c8cecdfb56586ab9"></a> +void </td><td class="memItemRight" valign="bottom"><b>Swap</b> (<a class="el" href="classBlob.html">Blob</a> &other)</td></tr> +<tr class="separator:ac3d96c2279d884e9c8cecdfb56586ab9"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a0468f6023394938200b5f9c1bfcfe7bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0468f6023394938200b5f9c1bfcfe7bd"></a> +shared_ptr< <a class="el" href="classSyncedMemory.html">SyncedMemory</a> > </td><td class="memItemRight" valign="bottom"><b>data_</b></td></tr> +<tr class="separator:a0468f6023394938200b5f9c1bfcfe7bd"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a6b1407167297538ebd64433348ce42bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b1407167297538ebd64433348ce42bc"></a> +vector< int > </td><td class="memItemRight" valign="bottom"><b>shape_</b></td></tr> +<tr class="separator:a6b1407167297538ebd64433348ce42bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3d9b7fb9e861e128ccab75272f8aa91d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d9b7fb9e861e128ccab75272f8aa91d"></a> +int </td><td class="memItemRight" valign="bottom"><b>count_</b></td></tr> +<tr class="separator:a3d9b7fb9e861e128ccab75272f8aa91d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a344c9f8aee75b77210c548468c776cfb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a344c9f8aee75b77210c548468c776cfb"></a> +int </td><td class="memItemRight" valign="bottom"><b>capacity_</b></td></tr> +<tr class="separator:a344c9f8aee75b77210c548468c776cfb"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a283b080c7a275e679bb6d94c1a400591"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Dtype> </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classBlob.html">Blob</a>< Dtype >::CopyFrom </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classBlob.html">Blob</a>< Dtype > & </td> + <td class="paramname"><em>source</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>reshape</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copy from a source <a class="el" href="classBlob.html">Blob</a>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">source</td><td>the <a class="el" href="classBlob.html">Blob</a> to copy from </td></tr> + <tr><td class="paramname">reshape</td><td>if false, require this <a class="el" href="classBlob.html">Blob</a> to be pre-shaped to the shape of other (and die otherwise); if true, Reshape this <a class="el" href="classBlob.html">Blob</a> to other's shape if necessary </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a7161872dea41d5b062269fec75fe9838"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Dtype> </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classBlob.html">Blob</a>< Dtype >::Reshape </td> + <td>(</td> + <td class="paramtype">const vector< int > & </td> + <td class="paramname"><em>shape</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Change the dimensions of the blob, allocating new memory if necessary. </p> +<p>This function can be called both to create an initial allocation of memory, and to adjust the dimensions of a top blob during Layer::Reshape or Layer::Forward. When changing the size of blob, memory will only be reallocated if sufficient memory does not already exist, and excess memory will never be freed.</p> +<p>Note that reshaping an input blob and immediately calling Net::Backward is an error; either Net::Forward or Net::Reshape need to be called to propagate the new input shape to higher layers. </p> + +</div> +</div> +<a class="anchor" id="ae1617a8210879355ea6d58e0677ec17a"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Dtype> </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classBlob.html">Blob</a>< Dtype >::ShareData </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classBlob.html">Blob</a>< Dtype > & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the data_ shared_ptr to point to the <a class="el" href="classSyncedMemory.html" title="Manages memory allocation and synchronization between the host (CPU) and device (GPU). ">SyncedMemory</a> holding the data_ of <a class="el" href="classBlob.html">Blob</a> other – useful in Layer&s which simply perform a copy in their Forward pass. </p> +<p>This deallocates the <a class="el" href="classSyncedMemory.html" title="Manages memory allocation and synchronization between the host (CPU) and device (GPU). ">SyncedMemory</a> holding this <a class="el" href="classBlob.html">Blob</a>'s data_, as shared_ptr calls its destructor when reset with the "=" operator. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/wangwei/program/asf/incubator-singa/include/utils/<a class="el" href="blob_8h_source.html">blob.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classFactory-members.html ---------------------------------------------------------------------- diff --git a/api/classFactory-members.html b/api/classFactory-members.html new file mode 100644 index 0000000..fe30d19 --- /dev/null +++ b/api/classFactory-members.html @@ -0,0 +1,104 @@ +<!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.6"/> +<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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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 > 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 ></a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classFactory.html#a189b3b0277863783851b65fd7a00df59">Create</a>(const std::string id)</td><td class="entry"><a class="el" href="classFactory.html">Factory< T ></a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classFactory.html#adaddfc20babbc0454e409933ecf5803b">Register</a>(const std::string id, std::function< T *(void)> func)</td><td class="entry"><a class="el" href="classFactory.html">Factory< T ></a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/666a841d/api/classFactory.html ---------------------------------------------------------------------- diff --git a/api/classFactory.html b/api/classFactory.html new file mode 100644 index 0000000..e6e1c9f --- /dev/null +++ b/api/classFactory.html @@ -0,0 +1,194 @@ +<!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.6"/> +<title>Apache SINGA: Factory< 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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="projectlogo"><img alt="Logo" src="singa-logo-small.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">Apache SINGA + </div> + <div id="projectbrief">A distributed deep learning platform .</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="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="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void (0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a></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="classFactory-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Factory< T > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>factory 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-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:adaddfc20babbc0454e409933ecf5803b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFactory.html#adaddfc20babbc0454e409933ecf5803b">Register</a> (const std::string id, std::function< T *(void)> func)</td></tr> +<tr class="memdesc:adaddfc20babbc0454e409933ecf5803b"><td class="mdescLeft"> </td><td class="mdescRight">Register functions to create user defined classes. <a href="#adaddfc20babbc0454e409933ecf5803b">More...</a><br/></td></tr> +<tr class="separator:adaddfc20babbc0454e409933ecf5803b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a189b3b0277863783851b65fd7a00df59"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFactory.html#a189b3b0277863783851b65fd7a00df59">Create</a> (const std::string id)</td></tr> +<tr class="memdesc:a189b3b0277863783851b65fd7a00df59"><td class="mdescLeft"> </td><td class="mdescRight">create a layer instance by providing its type <a href="#a189b3b0277863783851b65fd7a00df59">More...</a><br/></td></tr> +<tr class="separator:a189b3b0277863783851b65fd7a00df59"><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 Factory< T ></h3> + +<p>factory 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#a189b3b0277863783851b65fd7a00df59" title="create a layer instance by providing its type ">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 class="anchor" id="a189b3b0277863783851b65fd7a00df59"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> + <table class="memname"> + <tr> + <td class="memname">T * <a class="el" href="classFactory.html">Factory</a>< T >::Create </td> + <td>(</td> + <td class="paramtype">const std::string </td> + <td class="paramname"><em>id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>create a layer instance by providing its type </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type</td><td>the identifier of the layer to be created </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="adaddfc20babbc0454e409933ecf5803b"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename T > </div> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classFactory.html">Factory</a>< T >::Register </td> + <td>(</td> + <td class="paramtype">const std::string </td> + <td class="paramname"><em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::function< T *(void)> </td> + <td class="paramname"><em>func</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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">create_function</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/wangwei/program/asf/incubator-singa/include/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 Thu May 7 2015 17:15:37 for Apache SINGA by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html>
