| <!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::BinFileWriter 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_1BinFileWriter.html">BinFileWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classsinga_1_1io_1_1BinFileWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::io::BinFileWriter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>BinFile stores training/validation/test tuples. |
| <a href="classsinga_1_1io_1_1BinFileWriter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="writer_8h_source.html">writer.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for singa::io::BinFileWriter:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1io_1_1BinFileWriter__inherit__graph.png" border="0" usemap="#singa_1_1io_1_1BinFileWriter_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| <div class="dynheader"> |
| Collaboration diagram for singa::io::BinFileWriter:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1io_1_1BinFileWriter__coll__graph.png" border="0" usemap="#singa_1_1io_1_1BinFileWriter_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| <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:ad1c03151f8b23e5457448ab9adb66c9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ad1c03151f8b23e5457448ab9adb66c9f">Open</a> (const std::string &<a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">path</a>, Mode mode) override</td></tr> |
| <tr class="separator:ad1c03151f8b23e5457448ab9adb66c9f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56d4be309b08d8417c5d24e8aead8c28"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a56d4be309b08d8417c5d24e8aead8c28">Open</a> (const std::string &<a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">path</a>, Mode mode, int capacity)</td></tr> |
| <tr class="memdesc:a56d4be309b08d8417c5d24e8aead8c28"><td class="mdescLeft"> </td><td class="mdescRight">user defines capacity <a href="#a56d4be309b08d8417c5d24e8aead8c28">More...</a><br /></td></tr> |
| <tr class="separator:a56d4be309b08d8417c5d24e8aead8c28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae59938d01be24bbee59b984d84f5da34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ae59938d01be24bbee59b984d84f5da34">Close</a> () override</td></tr> |
| <tr class="separator:ae59938d01be24bbee59b984d84f5da34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adfea9905cf6eec1bf81b05c4c33c67f3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#adfea9905cf6eec1bf81b05c4c33c67f3">Write</a> (const std::string &key, const std::string &value) override</td></tr> |
| <tr class="memdesc:adfea9905cf6eec1bf81b05c4c33c67f3"><td class="mdescLeft"> </td><td class="mdescRight">override; override; <a href="#adfea9905cf6eec1bf81b05c4c33c67f3">More...</a><br /></td></tr> |
| <tr class="separator:adfea9905cf6eec1bf81b05c4c33c67f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8aa72d95e120fa05be7839f77d4a897b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a8aa72d95e120fa05be7839f77d4a897b">Flush</a> () override</td></tr> |
| <tr class="separator:a8aa72d95e120fa05be7839f77d4a897b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab3a9f9671370e94505aa41132a4d5e12"><td class="memItemLeft" align="right" valign="top"><a id="ab3a9f9671370e94505aa41132a4d5e12"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">path</a> ()</td></tr> |
| <tr class="memdesc:ab3a9f9671370e94505aa41132a4d5e12"><td class="mdescLeft"> </td><td class="mdescRight">return path to binary file <br /></td></tr> |
| <tr class="separator:ab3a9f9671370e94505aa41132a4d5e12"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classsinga_1_1io_1_1Writer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1io_1_1Writer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1io_1_1Writer.html">singa::io::Writer</a></td></tr> |
| <tr class="memitem:aa5a4ed9aae85f2f879563d094a6cc4f1 inherit pub_methods_classsinga_1_1io_1_1Writer"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1">~Writer</a> ()</td></tr> |
| <tr class="memdesc:aa5a4ed9aae85f2f879563d094a6cc4f1 inherit pub_methods_classsinga_1_1io_1_1Writer"><td class="mdescLeft"> </td><td class="mdescRight">In case that users forget to call <a class="el" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448" title="Release resources. ">Close()</a> to release resources, e.g., memory, you can release them here. <a href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1">More...</a><br /></td></tr> |
| <tr class="separator:aa5a4ed9aae85f2f879563d094a6cc4f1 inherit pub_methods_classsinga_1_1io_1_1Writer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a43f2df3567cbace6ce2476a3f2d0557c"><td class="memItemLeft" align="right" valign="top"><a id="a43f2df3567cbace6ce2476a3f2d0557c"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a43f2df3567cbace6ce2476a3f2d0557c">OpenFile</a> ()</td></tr> |
| <tr class="memdesc:a43f2df3567cbace6ce2476a3f2d0557c"><td class="mdescLeft"> </td><td class="mdescRight">Open a file with path_ and initialize buf_. <br /></td></tr> |
| <tr class="separator:a43f2df3567cbace6ce2476a3f2d0557c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>BinFile stores training/validation/test tuples. </p> |
| <p>Each tuple is encoded as [magic_word, key_len, key, val_len, val]:</p><ul> |
| <li>magic_word has 4 bytes; the first two are "s" and "g", the third one indicates whether key is null, the last one is reserved for future use.</li> |
| <li>key_len and val_len are of type uint32, which indicate the bytes of key and value respectively;</li> |
| <li>key_len and key are optional.) When BinFile is created, it will remove the last tuple if the value size and key size do not match because the last write crashed. </li> |
| </ul> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae59938d01be24bbee59b984d84f5da34"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae59938d01be24bbee59b984d84f5da34">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void singa::io::BinFileWriter::Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| |
| <p>Implements <a class="el" href="classsinga_1_1io_1_1Writer.html#add7c77805b900595c2da748a4df8c448">singa::io::Writer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8aa72d95e120fa05be7839f77d4a897b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8aa72d95e120fa05be7839f77d4a897b">◆ </a></span>Flush()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void singa::io::BinFileWriter::Flush </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| |
| <p>Implements <a class="el" href="classsinga_1_1io_1_1Writer.html#a6dd928130b77f215b90e87b42137da48">singa::io::Writer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad1c03151f8b23e5457448ab9adb66c9f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1c03151f8b23e5457448ab9adb66c9f">◆ </a></span>Open() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool singa::io::BinFileWriter::Open </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Mode </td> |
| <td class="paramname"><em>mode</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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| |
| <p>Implements <a class="el" href="classsinga_1_1io_1_1Writer.html#a2427e9a325544ca985b5b6729227f3ef">singa::io::Writer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a56d4be309b08d8417c5d24e8aead8c28"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a56d4be309b08d8417c5d24e8aead8c28">◆ </a></span>Open() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool singa::io::BinFileWriter::Open </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Mode </td> |
| <td class="paramname"><em>mode</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>capacity</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>user defines capacity </p> |
| <p>user defines capacity </p> |
| |
| </div> |
| </div> |
| <a id="adfea9905cf6eec1bf81b05c4c33c67f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adfea9905cf6eec1bf81b05c4c33c67f3">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool singa::io::BinFileWriter::Write </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const 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">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>override; override; </p> |
| <p>override; override; </p> |
| |
| <p>Implements <a class="el" href="classsinga_1_1io_1_1Writer.html#afa52a9053af2363cb4680217a10c038a">singa::io::Writer</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="writer_8h_source.html">writer.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> |
