| <!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: singa::io::Reader Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Singa |
| </div> |
| <div id="projectbrief">A General Distributed Deep Learning Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><b>io</b></li><li class="navelem"><a class="el" href="classsinga_1_1io_1_1Reader.html">Reader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classsinga_1_1io_1_1Reader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::io::Reader Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>General <a class="el" href="classsinga_1_1io_1_1Reader.html" title="General Reader that provides functions for reading tuples. ">Reader</a> that provides functions for reading tuples. |
| <a href="classsinga_1_1io_1_1Reader.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for singa::io::Reader:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1io_1_1Reader__inherit__graph.png" border="0" usemap="#singa_1_1io_1_1Reader_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a151239317e76d0db47e5e6d01ed5fca3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">~Reader</a> ()</td></tr> |
| <tr class="memdesc:a151239317e76d0db47e5e6d01ed5fca3"><td class="mdescLeft"> </td><td class="mdescRight">In case that users forget to call <a class="el" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1" title="Release resources. ">Close()</a> to release resources, e.g., memory, you can release them here. <a href="#a151239317e76d0db47e5e6d01ed5fca3">More...</a><br /></td></tr> |
| <tr class="separator:a151239317e76d0db47e5e6d01ed5fca3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6894610ce2560dbe7641fdf5a3abf909"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a> (const std::string &path)=0</td></tr> |
| <tr class="memdesc:a6894610ce2560dbe7641fdf5a3abf909"><td class="mdescLeft"> </td><td class="mdescRight">path is the path to the storage, could be a file path, database connection, or hdfs path. <a href="#a6894610ce2560dbe7641fdf5a3abf909">More...</a><br /></td></tr> |
| <tr class="separator:a6894610ce2560dbe7641fdf5a3abf909"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9a44a2b4ae832493c04d9b540ef29e1"><td class="memItemLeft" align="right" valign="top"><a id="ae9a44a2b4ae832493c04d9b540ef29e1"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a> ()=0</td></tr> |
| <tr class="memdesc:ae9a44a2b4ae832493c04d9b540ef29e1"><td class="mdescLeft"> </td><td class="mdescRight">Release resources. <br /></td></tr> |
| <tr class="separator:ae9a44a2b4ae832493c04d9b540ef29e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d45ee8b877e4344d776265af16e0c4b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a> (std::string *key, std::string *value)=0</td></tr> |
| <tr class="memdesc:a8d45ee8b877e4344d776265af16e0c4b"><td class="mdescLeft"> </td><td class="mdescRight">Read a tuple. <a href="#a8d45ee8b877e4344d776265af16e0c4b">More...</a><br /></td></tr> |
| <tr class="separator:a8d45ee8b877e4344d776265af16e0c4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a860fade6259818e89887aac059bb6277"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a> ()=0</td></tr> |
| <tr class="memdesc:a860fade6259818e89887aac059bb6277"><td class="mdescLeft"> </td><td class="mdescRight">Iterate through all tuples to get the num of all tuples. <a href="#a860fade6259818e89887aac059bb6277">More...</a><br /></td></tr> |
| <tr class="separator:a860fade6259818e89887aac059bb6277"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a82bb5bcb71d5abc58ffad4b698eb4965"><td class="memItemLeft" align="right" valign="top"><a id="a82bb5bcb71d5abc58ffad4b698eb4965"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a> ()=0</td></tr> |
| <tr class="memdesc:a82bb5bcb71d5abc58ffad4b698eb4965"><td class="mdescLeft"> </td><td class="mdescRight">Seek to the first tuple when the cursor arrives to the end of the file. <br /></td></tr> |
| <tr class="separator:a82bb5bcb71d5abc58ffad4b698eb4965"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>General <a class="el" href="classsinga_1_1io_1_1Reader.html" title="General Reader that provides functions for reading tuples. ">Reader</a> that provides functions for reading tuples. </p> |
| <p>Subclasses implement the functions for a specific data storage, e.g., CSV file, HDFS, kvfile, leveldb, lmdb, etc. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a151239317e76d0db47e5e6d01ed5fca3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a151239317e76d0db47e5e6d01ed5fca3">◆ </a></span>~Reader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual singa::io::Reader::~Reader </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>In case that users forget to call <a class="el" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1" title="Release resources. ">Close()</a> to release resources, e.g., memory, you can release them here. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a860fade6259818e89887aac059bb6277"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a860fade6259818e89887aac059bb6277">◆ </a></span>Count()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int singa::io::Reader::Count </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Iterate through all tuples to get the num of all tuples. </p> |
| <p>return num of tuples </p> |
| |
| <p>Implemented in <a class="el" href="classsinga_1_1io_1_1TextFileReader.html#a7416ef93c5b098a7053527a3e99eb9d6">singa::io::TextFileReader</a>, and <a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a5cd9ba4198573517cdddf1670b28f1f6">singa::io::BinFileReader</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6894610ce2560dbe7641fdf5a3abf909"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6894610ce2560dbe7641fdf5a3abf909">◆ </a></span>Open()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool singa::io::Reader::Open </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>path is the path to the storage, could be a file path, database connection, or hdfs path. </p> |
| <p>return true if open successfully, otherwise false. </p> |
| |
| <p>Implemented in <a class="el" href="classsinga_1_1io_1_1TextFileReader.html#a0534a05f524378799982c33e49baf1f3">singa::io::TextFileReader</a>, and <a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a34cc1d57cb53922dd954f2380ff2e137">singa::io::BinFileReader</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8d45ee8b877e4344d776265af16e0c4b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8d45ee8b877e4344d776265af16e0c4b">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool singa::io::Reader::Read </td> |
| <td>(</td> |
| <td class="paramtype">std::string * </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string * </td> |
| <td class="paramname"><em>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read a tuple. </p> |
| <p>return true if read successfully; return flase if coming to the end of the file; LOG(FATAL) if error happens. </p> |
| |
| <p>Implemented in <a class="el" href="classsinga_1_1io_1_1TextFileReader.html#af073eb6bb148be54145d0c38347556e9">singa::io::TextFileReader</a>, and <a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a956414a417964de2a8f8248ea8ba1e0c">singa::io::BinFileReader</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/moaz/incubator-singa/include/singa/io/<a class="el" href="reader_8h_source.html">reader.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
