You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@singa.apache.org by mo...@apache.org on 2019/04/22 10:37:24 UTC
svn commit: r1857944 [35/35] - in /incubator/singa/site/trunk/doxygen: ./
html/ html/search/
Added: incubator/singa/site/trunk/doxygen/html/transformer_8h_source.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/transformer_8h_source.html?rev=1857944&view=auto
==============================================================================
--- incubator/singa/site/trunk/doxygen/html/transformer_8h_source.html (added)
+++ incubator/singa/site/trunk/doxygen/html/transformer_8h_source.html Mon Apr 22 10:37:18 2019
@@ -0,0 +1,83 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Singa: /home/moaz/incubator-singa/include/singa/io/transformer.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_953eafc3caccd34fc2601f376f19d1ef.html">io</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">transformer.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_IO_TRANSFORMER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_IO_TRANSFORMER_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 <vector></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</sp
an> <span class="preprocessor">#include "singa/proto/io.pb.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "singa/proto/model.pb.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classsinga_1_1Transformer.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Transformer.html">Transformer</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_1Transformer.html">Transformer</a>() {}</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Transformer.html">Transformer</a>() {}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Setup(<span class="keyword">const</span> TransformerConf& conf) {}</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> Apply(<span class="keywordtype">int</span> flag, <a class="code" href="classsinga_1_1Tensor.html
">Tensor</a>& input) = 0;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classsinga_1_1ImageTransformer.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1ImageTransformer.html">ImageTransformer</a>: <span class="keyword">public</span> <a class="code" href="classsinga_1_1Transformer.html">Transformer</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classsinga_1_1ImageTransformer.html#a96dbd65ebac2c4df2d5e07b1e7a0ae9a"> 43</a></span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1ImageTransformer.html#a96dbd65ebac2c4df2d5e07b1e7a
0ae9a">Setup</a>(<span class="keyword">const</span> TransformerConf& conf)<span class="keyword"> override </span>{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  featurewise_center_ = conf.featurewise_center();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  featurewise_std_norm_ = conf.featurewise_std_norm();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  resize_height_ = conf.resize_height();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  resize_width_ = conf.resize_width();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  rescale_ = conf.rescale();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  horizontal_mirror_ = conf.horizontal_mirror();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  image_dim_order_
= conf.image_dim_order();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (conf.crop_shape_size() == 2)</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  crop_shape_ = {conf.crop_shape(0), conf.crop_shape(1)}; </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="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> Apply(<span class="keywordtype">int</span> flag, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& input) <span class="keyword">override</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="li
ne"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> featurewise_center()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> featurewise_center_; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> featurewise_std_norm()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> featurewise_std_norm_; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> horizontal_mirror()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> horizontal_mirror_; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> resize_height()<span
class="keyword"> const </span>{ <span class="keywordflow">return</span> resize_height_; }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> <span class="keywordtype">int</span> resize_width()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> resize_width_; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> rescale()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> rescale_; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> Shape crop_shape()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> crop_shape_; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> <span class="keywordtype">strin
g</span> image_dim_order()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> image_dim_order_; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> featurewise_center_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> featurewise_std_norm_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> horizontal_mirror_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">int</span> r
esize_height_ = 0;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">int</span> resize_width_ = 0;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">float</span> rescale_ = 0.f;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  Shape crop_shape_ = {};</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::string image_dim_order_ = <span class="stringliteral">"CHW"</span>;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> };</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> <span class="preprocessor">#ifdef USE_OPENCV</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <a class="code" href="classsinga
_1_1Tensor.html">Tensor</a> resize(<a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& input, <span class="keyword">const</span> <span class="keywordtype">size_t</span> resize_height, </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> resize_width, <span class="keyword">const</span> <span class="keywordtype">string</span>& image_dim_order);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> crop(<a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& input, <span class="keyword">const</span> <span class="keywordtype">size_t</span> crop_height, </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> 
<span class="keyword">const</span> <span class="keywordtype">size_t</span> crop_width, <span class="keyword">const</span> <span class="keywordtype">size_t</span> crop_h_offset, </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> crop_w_offset, <span class="keyword">const</span> <span class="keywordtype">string</span>& image_dim_order);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a> mirror(<a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& input, <span class="keyword">const</span> <span class="keywordtype">bool</span> horizontal_mirror, </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> vertical_mirror, <span class="keyword">con
st</span> <span class="keywordtype">string</span>& image_dim_order);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif // SINGA_IO_TRANSFORMER_H_</span></div><div class="ttc" id="classsinga_1_1ImageTransformer_html"><div class="ttname"><a href="classsinga_1_1ImageTransformer.html">singa::ImageTransformer</a></div><div class="ttdef"><b>Definition:</b> transformer.h:41</div></div>
+<div class="ttc" id="classsinga_1_1ImageTransformer_html_a96dbd65ebac2c4df2d5e07b1e7a0ae9a"><div class="ttname"><a href="classsinga_1_1ImageTransformer.html#a96dbd65ebac2c4df2d5e07b1e7a0ae9a">singa::ImageTransformer::Setup</a></div><div class="ttdeci">void Setup(const TransformerConf &conf) override</div><div class="ttdef"><b>Definition:</b> transformer.h:43</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_1Transformer_html"><div class="ttname"><a href="classsinga_1_1Transformer.html">singa::Transformer</a></div><div class="ttdoc">Base apply class that does data transformations in pre-processing stage. </div><div class="ttdef"><b>Definition:</b> transformer.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><!-- 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/updater_8h_source.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/updater_8h_source.html?rev=1857944&view=auto
==============================================================================
--- incubator/singa/site/trunk/doxygen/html/updater_8h_source.html (added)
+++ incubator/singa/site/trunk/doxygen/html/updater_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/model/updater.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">updater.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_UPDATER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_MODEL_UPDATER_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 "singa/model/optimizer.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "singa/core/device.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "singa/core/tensor.h"</span></div><div class="line"><a name="l00025
"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "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 class="preprocessor">#include <memory></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</spa
n> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <atomic></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classsinga_1_1Updater.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1Updater.html">Updater</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line">
<a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>(<a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* opt) : opt_{opt} {}</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Updater.html">Updater</a>() {}</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">Setup</a>(<span class="keyword">const</span> OptimizerConf& conf);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221"
>Register</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& name, <span class="keyword">const</span> ParamSpec& specs);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">Apply</a>(<span class="keywordtype">int</span> step, <span class="keyword">const</span> <span class="keywordtype">string</span>& name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& grad, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& value);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* GetOptimizer() { <span class="keywordflow">return</span> opt_; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div c
lass="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// No copy allowed.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classsinga_1_1Updater.html">Updater</a>(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a>&) = <span class="keyword">delete</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">protected</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" h
ref="classsinga_1_1Optimizer.html">Optimizer</a>* opt_;</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="l00061"></a><span class="lineno"><a class="line" href="classsinga_1_1LocalUpdater.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Updater.html">Updater</a> {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a>(<span class="keywordtype">int</span> total_num, <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>* opt,</div><div class="line"
><a name="l00064"></a><span class="lineno"> 64</span>  std::shared_ptr<Device> dev = <a class="code" href="namespacesinga.html#af5fd1cb4e1a4b5ae9bba1377b034eb8d">defaultDevice</a>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  : <a class="code" href="classsinga_1_1Updater.html">Updater</a>(opt), total_num_{total_num}, dev_(dev) {}</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1LocalUpdater.html">LocalUpdater</a>()<span class="keyword"> override </span>{}</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">Register</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>& name, <span class="
keyword">const</span> ParamSpec& specs) <span class="keyword">override</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">Apply</a>(<span class="keywordtype">int</span> step, <span class="keyword">const</span> <span class="keywordtype">string</span>& name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& grad,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>& value) <span class="keyword">override</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">template</span>
<<span class="keyword">typename</span> T1, <span class="keyword">typename</span> T2></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">struct </span>key_hasher {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">size_t</span> operator() (<span class="keyword">const</span> std::pair<T1, T2>& p)<span class="keyword"> const </span>{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">auto</span> h1 = std::hash<T1>{}(p.first);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">auto</span> h2 = std::hash<T2>{}(p.second);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> h1 ^ h2;</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>  };</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="keywordtype">int</span> total_num_;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::shared_ptr<Device> dev_;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::unordered_map<std::string, std::atomic<int>> dev_index_;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::unordered_map<std::string, int> to_updater_finished_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::unordered_map<std::pair<int, std::string>, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>,</div><div class="line"><a name="l00089"
></a><span class="lineno"> 89</span>  key_hasher<int, std::string>> grad_buffer_;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::unordered_map<std::string, Tensor> sum_, param_buffer_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  std::unordered_map<std::string, std::mutex> mtx_;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::unordered_map<std::string, std::condition_variable></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  to_updater_all_finished_;</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="comment">// namespace singa</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l0009
7"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif // SINGA_MODEL_UPDATER_H_</span></div><div class="ttc" id="classsinga_1_1Updater_html_ac07c0e7cd69b631244b7c2c4bb90c0ec"><div class="ttname"><a href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">singa::Updater::Apply</a></div><div class="ttdeci">virtual void Apply(int step, const string &name, Tensor &grad, Tensor &value)</div><div class="ttdoc">Forward Apply() to Optimizer. </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_1Updater_html"><div class="ttname"><a href="classsinga_1_1Updater.html">singa::Updater</a></div><div class="ttdoc">Basic Updater class just forward all the method function call to the wrapped Optimizer. </div><div class="ttdef"><b>Definition:</b> updater.h:39</div></div>
+<div class="ttc" id="namespacesinga_html_af5fd1cb4e1a4b5ae9bba1377b034eb8d"><div class="ttname"><a href="namespacesinga.html#af5fd1cb4e1a4b5ae9bba1377b034eb8d">singa::defaultDevice</a></div><div class="ttdeci">std::shared_ptr< Device > defaultDevice</div><div class="ttdoc">a singleton CppDevice as the host for all devices. </div></div>
+<div class="ttc" id="classsinga_1_1Updater_html_a6cc4fdac0b011f0500c0d7bf9ad78e1a"><div class="ttname"><a href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">singa::Updater::Setup</a></div><div class="ttdeci">virtual void Setup(const OptimizerConf &conf)</div><div class="ttdoc">Forward Setup() to Optimizer. </div></div>
+<div class="ttc" id="classsinga_1_1Updater_html_a279ada6bda1f42a420245f5258bba221"><div class="ttname"><a href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">singa::Updater::Register</a></div><div class="ttdeci">virtual void Register(const string &name, const ParamSpec &specs)</div><div class="ttdoc">Forward Register() to Optimizer. </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_1Optimizer_html"><div class="ttname"><a href="classsinga_1_1Optimizer.html">singa::Optimizer</a></div><div class="ttdoc">The base class for gradient descent algorithms used to update the model parameters in order to optimi...</div><div class="ttdef"><b>Definition:</b> optimizer.h:41</div></div>
+<div class="ttc" id="classsinga_1_1LocalUpdater_html"><div class="ttname"><a href="classsinga_1_1LocalUpdater.html">singa::LocalUpdater</a></div><div class="ttdoc">LocalUpdater do gradient aggregation and update gradient calling the wrapped Optimizer on a specific ...</div><div class="ttdef"><b>Definition:</b> updater.h:61</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/utils_2integer_8h_source.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/utils_2integer_8h_source.html?rev=1857944&view=auto
==============================================================================
--- incubator/singa/site/trunk/doxygen/html/utils_2integer_8h_source.html (added)
+++ incubator/singa/site/trunk/doxygen/html/utils_2integer_8h_source.html Mon Apr 22 10:37:18 2019
@@ -0,0 +1,79 @@
+<!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/integer.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">integer.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span
></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> 
;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</
span> <span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> *************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef INTEGER_H_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define INTEGER_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cstdint></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="keyword">namespa
ce </span><a class="code" href="namespacesinga.html">singa</a>{</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> isNetworkOrder() {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">int</span> test = 1;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> (1 != *(uint8_t*)&test);</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> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">static</span> <span clas
s="keyword">inline</span> T byteSwap(<span class="keyword">const</span> T& v) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">int</span> size = <span class="keyword">sizeof</span>(v);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  T ret;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint8_t *dest = <span class="keyword">reinterpret_cast<</span>uint8_t *<span class="keyword">></span>(&ret);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  uint8_t *src = <span class="keyword">const_cast<</span>uint8_t*<span class="keyword">></span>(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span>uint8_t*<span class="keyword">></span>(&v));</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">for</s
pan> (<span class="keywordtype">int</span> i = 0; i < size; ++i) {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  dest[i] = src[size - i - 1];</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <span class="keyword">inline</span> T hton(<span class="keyword">const</span> T& v)</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="keywordflow">return</span> isNetworkOrder() ? v : byteSwap(v);</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> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static</span> <span class="keyword">inline</span> T ntoh(<span class="keyword">const</span> T& v) </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="keywordflow">return</span> hton(v);</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="l00057"></a><span class="lineno"> 57</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> appendInteger(<span class="keywordtype">char</span>* buf) {<span class="keywordflow">return</span> 0;}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> readInteger(<span class="keywordtype">char</span>* buf) {<span class="keywordflow">return</span> 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> <span class="keyword">template</span><<span class="keyword">typename</span> Type, <span class
="keyword">typename</span>... Types></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">static</span> <span class="keywordtype">int</span> appendInteger(<span class="keywordtype">char</span>* buf, Type value, Types... values) {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  *(Type*)buf = hton(value);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(Type) + appendInteger(buf + <span class="keyword">sizeof</span>(Type), values...);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</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="keyword">template</span><<span class="keyword">typename</span> Type, <span class="ke
yword">typename</span>... Types></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">static</span> <span class="keywordtype">int</span> readInteger(<span class="keywordtype">char</span>* buf, Type& value, Types&... values) {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  value = ntoh(*(Type*)buf);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(Type) + readInteger(buf + <span class="keyword">sizeof</span>(Type), values...);</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> }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="
preprocessor">#endif</span></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><!-- 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/writer_8h_source.html
URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/writer_8h_source.html?rev=1857944&view=auto
==============================================================================
--- incubator/singa/site/trunk/doxygen/html/writer_8h_source.html (added)
+++ incubator/singa/site/trunk/doxygen/html/writer_8h_source.html Mon Apr 22 10:37:18 2019
@@ -0,0 +1,89 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Apache Singa: /home/moaz/incubator-singa/include/singa/io/writer.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_953eafc3caccd34fc2601f376f19d1ef.html">io</a></li> </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">writer.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_IO_WRITER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define SINGA_IO_WRITER_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 <cstring></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <fstream></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="pre
processor">#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_LMDB</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <lmdb.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <sys/stat.h></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif // USE_LMDB</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</
span> <span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">enum</span> Mode { kCreate, kAppend };</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1Writer.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1Writer.html">Writer</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>
  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1"> 46</a></span>  <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1">~Writer</a>() {}</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">Open</a>(<span class="keyword">const</span> std::string &path, Mode mode) = 0;</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> <span clas
s="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>() = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#afa52a9053af2363cb4680217a10c038a">Write</a>(<span class="keyword">const</span> std::string &key, <span class="keyword">const</span> std::string &value) = 0;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">Flush</a>() = 0;</div><div class="line"><a name="l00066"></a><span
class="lineno"> 66</span> };</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1BinFileWriter.html"> 77</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1BinFileWriter.html">BinFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1_1Writer.html">Writer</a> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  ~<a class="code" href="classsinga_1_1io_1_1BinFileWriter.html">BinFileWriter</a>() { <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>(); }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">
bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">Open</a>(<span class="keyword">const</span> std::string &path, Mode mode) <span class="keyword">override</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">Open</a>(<span class="keyword">const</span> std::string &path, Mode mode, <span class="keywordtype">int</span> capacity);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a
fa52a9053af2363cb4680217a10c038a">Write</a>(<span class="keyword">const</span> std::string &key, <span class="keyword">const</span> std::string &value) <span class="keyword">override</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">Flush</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12"> 91</a></span>  <span class="keyword">inline</span> std::string <a class="code" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">path</a>() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lin
eno"> 93</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">bool</span> OpenFile();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::string path_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  Mode mode_;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::ofstream fdat_;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">char</span> *buf_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00106"></a><span class="lineno">
106</span>  <span class="keywordtype">int</span> capacity_ = 10485760;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">int</span> bufsize_ = 0;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> kMagicWord[2] = {<span class="charliteral">'s'</span>, <span class="charliteral">'g'</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> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1TextFileWriter.html"> 114</a></span> <span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1TextFileWriter.html">TextFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1
_1Writer.html">Writer</a> {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  ~<a class="code" href="classsinga_1_1io_1_1TextFileWriter.html">TextFileWriter</a>() { <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>(); }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">Open</a>(<span class="keyword">const</span> std::string &path, Mode mode) <span class="keyword">override</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>() <span class="keywor
d">override</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#afa52a9053af2363cb4680217a10c038a">Write</a>(<span class="keyword">const</span> std::string &key, <span class="keyword">const</span> std::string &value) <span class="keyword">override</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">Flush</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1TextFileWriter.html#aa68b02d34ab60ee7e8b350370a18c0a4"> 126</a></span>  <span class="keyword">inline</span> std::string <a class="code" href="classsinga_1_1io_1_1TextFileWriter.html#aa68b02d34ab60ee7e8b350370a18c0a4">path</
a>() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  std::string path_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  Mode mode_;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  std::ofstream fdat_;</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> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#ifdef USE_LMDB</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</spa
n> <span class="keyword">class </span>LMDBWriter : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1_1Writer.html">Writer</a> {</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  ~LMDBWriter() { <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">Close</a>(); }</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">Open</a>(<span class="keyword">const</span> std::string &path, Mode mode) <span class="keyword">override</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#add7c
77805b900595c2da748a4df8c448">Close</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#afa52a9053af2363cb4680217a10c038a">Write</a>(<span class="keyword">const</span> std::string &key, <span class="keyword">const</span> std::string &value) <span class="keyword">override</span>;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">Flush</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">inline</span> std::string path() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </
div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">void</span> DoubleMapSize();</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> MDB_CHECK(<span class="keywordtype">int</span> mdb_status);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  std::string path_ = <span class="stringliteral">""</span>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  Mode mode_;</div><div class="line"><a name="l00162"></a><span class="l
ineno"> 162</span>  MDB_env *mdb_env_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  std::vector<string> keys, values;</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 // USE_LMDB</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> } <span class="comment">// namespace singa</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#endif // SINGA_IO_W
RITER_H_</span></div><div class="ttc" id="classsinga_1_1io_1_1Writer_html"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html">singa::io::Writer</a></div><div class="ttdoc">General Writer that provides functions for writing tuples. </div><div class="ttdef"><b>Definition:</b> writer.h:42</div></div>
+<div class="ttc" id="classsinga_1_1io_1_1Writer_html_add7c77805b900595c2da748a4df8c448"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">singa::io::Writer::Close</a></div><div class="ttdeci">virtual void Close()=0</div><div class="ttdoc">Release resources. </div></div>
+<div class="ttc" id="classsinga_1_1io_1_1Writer_html_a2427e9a325544ca985b5b6729227f3ef"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">singa::io::Writer::Open</a></div><div class="ttdeci">virtual bool Open(const std::string &path, Mode mode)=0</div><div class="ttdoc">Open a file. </div></div>
+<div class="ttc" id="classsinga_1_1io_1_1BinFileWriter_html"><div class="ttname"><a href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></div><div class="ttdoc">BinFile stores training/validation/test tuples. </div><div class="ttdef"><b>Definition:</b> writer.h:77</div></div>
+<div class="ttc" id="classsinga_1_1io_1_1BinFileWriter_html_ab3a9f9671370e94505aa41132a4d5e12"><div class="ttname"><a href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">singa::io::BinFileWriter::path</a></div><div class="ttdeci">std::string path()</div><div class="ttdoc">return path to binary file </div><div class="ttdef"><b>Definition:</b> writer.h:91</div></div>
+<div class="ttc" id="classsinga_1_1io_1_1TextFileWriter_html"><div class="ttname"><a href="classsinga_1_1io_1_1TextFileWriter.html">singa::io::TextFileWriter</a></div><div class="ttdoc">TextFileWriter write training/validation/test tuples in CSV file. </div><div class="ttdef"><b>Definition:</b> writer.h:114</div></div>
+<div class="ttc" id="classsinga_1_1io_1_1Writer_html_aa5a4ed9aae85f2f879563d094a6cc4f1"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1">singa::io::Writer::~Writer</a></div><div class="ttdeci">virtual ~Writer()</div><div class="ttdoc">In case that users forget to call Close() to release resources, e.g., memory, you can release them he...</div><div class="ttdef"><b>Definition:</b> writer.h:46</div></div>
+<div class="ttc" id="classsinga_1_1io_1_1Writer_html_afa52a9053af2363cb4680217a10c038a"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html#afa52a9053af2363cb4680217a10c038a">singa::io::Writer::Write</a></div><div class="ttdeci">virtual bool Write(const std::string &key, const std::string &value)=0</div><div class="ttdoc">Write a key-value tuple. </div></div>
+<div class="ttc" id="classsinga_1_1io_1_1Writer_html_a6dd928130b77f215b90e87b42137da48"><div class="ttname"><a href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">singa::io::Writer::Flush</a></div><div class="ttdeci">virtual void Flush()=0</div><div class="ttdoc">Flush writing buffer if it has. </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_1io_1_1TextFileWriter_html_aa68b02d34ab60ee7e8b350370a18c0a4"><div class="ttname"><a href="classsinga_1_1io_1_1TextFileWriter.html#aa68b02d34ab60ee7e8b350370a18c0a4">singa::io::TextFileWriter::path</a></div><div class="ttdeci">std::string path()</div><div class="ttdoc">return path to text file </div><div class="ttdef"><b>Definition:</b> writer.h:126</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>