blob: 18c8b83a7eb0a008a7c97c59e9ca96d57f97fb71 [file] [log] [blame]
<!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/reader.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">reader.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef SINGA_IO_READER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SINGA_IO_READER_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;fstream&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;singa/singa_config.h&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifdef USE_LMDB</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;lmdb.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;sys/stat.h&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#endif // USE_LMDB</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<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>&#160;<span class="keyword">namespace </span>io {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1Reader.html"> 41</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1Reader.html">Reader</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3"> 45</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">~Reader</a>() {}</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(<span class="keyword">const</span> std::string&amp; path) = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>() = 0;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a>(std::string* key, std::string* value) = 0;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a>() = 0;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a>() = 0;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;};</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1BinFileReader.html"> 70</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1BinFileReader.html">BinFileReader</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1_1Reader.html">Reader</a> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; ~<a class="code" href="classsinga_1_1io_1_1BinFileReader.html">BinFileReader</a>() { <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>(); }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(<span class="keyword">const</span> std::string&amp; path) <span class="keyword">override</span>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(<span class="keyword">const</span> std::string&amp; path, <span class="keywordtype">int</span> capacity);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a>(std::string* key, std::string* value) <span class="keyword">override</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca"> 86</a></span>&#160; <span class="keyword">inline</span> std::string <a class="code" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">path</a>() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">bool</span> OpenFile();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">bool</span> ReadField(std::string* content);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">bool</span> PrepareNextField(<span class="keywordtype">int</span> size);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; std::string path_ = <span class="stringliteral">&quot;&quot;</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; std::ifstream fdat_;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">char</span>* buf_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">int</span> offset_ = 0;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordtype">int</span> capacity_ = 10485760;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">int</span> bufsize_ = 0;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> kMagicWord[2] = {<span class="charliteral">&#39;s&#39;</span>, <span class="charliteral">&#39;g&#39;</span>};</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;};</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1TextFileReader.html"> 116</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1io_1_1TextFileReader.html">TextFileReader</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1_1Reader.html">Reader</a> {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; ~<a class="code" href="classsinga_1_1io_1_1TextFileReader.html">TextFileReader</a>() { <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>(); }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(<span class="keyword">const</span> std::string&amp; path) <span class="keyword">override</span>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a>(std::string* key, std::string* value) <span class="keyword">override</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classsinga_1_1io_1_1TextFileReader.html#afcd2ac030ea35029696de960bc9f88ac"> 130</a></span>&#160; <span class="keyword">inline</span> std::string <a class="code" href="classsinga_1_1io_1_1TextFileReader.html#afcd2ac030ea35029696de960bc9f88ac">path</a>() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; std::string path_ = <span class="stringliteral">&quot;&quot;</span>;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; std::ifstream fdat_;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">int</span> lineNo_ = 0;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;};</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#ifdef USE_LMDB</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="keyword">class </span>LMDBReader : <span class="keyword">public</span> <a class="code" href="classsinga_1_1io_1_1Reader.html">Reader</a> {</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; ~LMDBReader() { <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>(); }</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(<span class="keyword">const</span> std::string&amp; path) <span class="keyword">override</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a>(std::string* key, std::string* value) <span class="keyword">override</span>;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keyword">inline</span> std::string path() { <span class="keywordflow">return</span> path_; }</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> valid() { <span class="keywordflow">return</span> valid_; }</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordtype">void</span> Seek(MDB_cursor_op op);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <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="l00165"></a><span class="lineno"> 165</span>&#160;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; std::string path_ = <span class="stringliteral">&quot;&quot;</span>;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; MDB_env* mdb_env_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; MDB_dbi mdb_dbi_;</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; MDB_txn* mdb_txn_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; MDB_cursor* mdb_cursor_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; MDB_val mdb_key_, mdb_value_;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordtype">bool</span> valid_;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordtype">bool</span> first_;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;};</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="preprocessor">#endif // USE_LMDB</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;} <span class="comment">// namespace io</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;} <span class="comment">// namespace singa</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="preprocessor">#endif // SINGA_IO_READER_H_</span></div><div class="ttc" id="classsinga_1_1io_1_1Reader_html_a82bb5bcb71d5abc58ffad4b698eb4965"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">singa::io::Reader::SeekToFirst</a></div><div class="ttdeci">virtual void SeekToFirst()=0</div><div class="ttdoc">Seek to the first tuple when the cursor arrives to the end of the file. </div></div>
<div class="ttc" id="classsinga_1_1io_1_1BinFileReader_html_a85039856483c4e16b9ca12cdec7d8bca"><div class="ttname"><a href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">singa::io::BinFileReader::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> reader.h:86</div></div>
<div class="ttc" id="classsinga_1_1io_1_1TextFileReader_html_afcd2ac030ea35029696de960bc9f88ac"><div class="ttname"><a href="classsinga_1_1io_1_1TextFileReader.html#afcd2ac030ea35029696de960bc9f88ac">singa::io::TextFileReader::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> reader.h:130</div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></div><div class="ttdoc">General Reader that provides functions for reading tuples. </div><div class="ttdef"><b>Definition:</b> reader.h:41</div></div>
<div class="ttc" id="classsinga_1_1io_1_1BinFileReader_html"><div class="ttname"><a href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></div><div class="ttdoc">Binfilereader reads tuples from binary file with key-value pairs. </div><div class="ttdef"><b>Definition:</b> reader.h:70</div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html_a151239317e76d0db47e5e6d01ed5fca3"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">singa::io::Reader::~Reader</a></div><div class="ttdeci">virtual ~Reader()</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> reader.h:45</div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html_a6894610ce2560dbe7641fdf5a3abf909"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">singa::io::Reader::Open</a></div><div class="ttdeci">virtual bool Open(const std::string &amp;path)=0</div><div class="ttdoc">path is the path to the storage, could be a file path, database connection, or hdfs path...</div></div>
<div class="ttc" id="classsinga_1_1io_1_1TextFileReader_html"><div class="ttname"><a href="classsinga_1_1io_1_1TextFileReader.html">singa::io::TextFileReader</a></div><div class="ttdoc">TextFileReader reads tuples from CSV file. </div><div class="ttdef"><b>Definition:</b> reader.h:116</div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html_a860fade6259818e89887aac059bb6277"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">singa::io::Reader::Count</a></div><div class="ttdeci">virtual int Count()=0</div><div class="ttdoc">Iterate through all tuples to get the num of all tuples. </div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html_a8d45ee8b877e4344d776265af16e0c4b"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">singa::io::Reader::Read</a></div><div class="ttdeci">virtual bool Read(std::string *key, std::string *value)=0</div><div class="ttdoc">Read a tuple. </div></div>
<div class="ttc" id="classsinga_1_1io_1_1Reader_html_ae9a44a2b4ae832493c04d9b540ef29e1"><div class="ttname"><a href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">singa::io::Reader::Close</a></div><div class="ttdeci">virtual void Close()=0</div><div class="ttdoc">Release resources. </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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>