Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +0ac71c70ae5b762a5dd936a6616f9107 \ No newline at end of file
Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::init::Uniform" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::init::Uniform",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Initializer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Initializer.html"]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Uniform__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +23c0cf15d6684bca59c982e4b341c07a \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,85 @@ +<!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: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/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>init</b></li><li class="navelem"><a class="el" href="classsinga_1_1init_1_1Xavier.html">Xavier</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::init::Xavier Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1init_1_1Xavier.html">singa::init::Xavier</a>, including all inherited members.</p> +<table class="directory"> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Fill</b>(Tensor &t) override (defined in <a class="el" href="classsinga_1_1init_1_1Xavier.html">singa::init::Xavier</a>)</td><td class="entry"><a class="el" href="classsinga_1_1init_1_1Xavier.html">singa::init::Xavier</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Initializer</b>()=default (defined in <a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Setup</b>(const std::string &str) (defined in <a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Initializer.html#a7ffa4b002b680d125f2725f39f658a72">Setup</a>(const InitializerConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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/classsinga_1_1init_1_1Xavier.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,118 @@ +<!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::init::Xavier 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>init</b></li><li class="navelem"><a class="el" href="classsinga_1_1init_1_1Xavier.html">Xavier</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1init_1_1Xavier-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::init::Xavier Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Ref: [Bengio and Glorot 2010] Understanding the difficulty of training deep feedforward neural networks. + <a href="classsinga_1_1init_1_1Xavier.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="initializer_8h_source.html">initializer.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::init::Xavier:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1init_1_1Xavier__inherit__graph.png" border="0" usemap="#singa_1_1init_1_1Xavier_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::init::Xavier:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1init_1_1Xavier__coll__graph.png" border="0" usemap="#singa_1_1init_1_1Xavier_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:a010be798590b179b093c06cb25b861aa"><td class="memItemLeft" align="right" valign="top"><a id="a010be798590b179b093c06cb25b861aa"></a> +void </td><td class="memItemRight" valign="bottom"><b>Fill</b> (<a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &t) override</td></tr> +<tr class="separator:a010be798590b179b093c06cb25b861aa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classsinga_1_1Initializer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Initializer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Initializer.html">singa::Initializer</a></td></tr> +<tr class="memitem:a1392dc98130f6ec3d0a94ac6005f1fb9 inherit pub_methods_classsinga_1_1Initializer"><td class="memItemLeft" align="right" valign="top"><a id="a1392dc98130f6ec3d0a94ac6005f1fb9"></a> +void </td><td class="memItemRight" valign="bottom"><b>Setup</b> (const std::string &str)</td></tr> +<tr class="separator:a1392dc98130f6ec3d0a94ac6005f1fb9 inherit pub_methods_classsinga_1_1Initializer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7ffa4b002b680d125f2725f39f658a72 inherit pub_methods_classsinga_1_1Initializer"><td class="memItemLeft" align="right" valign="top"><a id="a7ffa4b002b680d125f2725f39f658a72"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Initializer.html#a7ffa4b002b680d125f2725f39f658a72">Setup</a> (const <a class="el" href="namespacesinga.html#ac7e303fc44cfdbf2611a6e69affa42e9">InitializerConf</a> &conf)</td></tr> +<tr class="memdesc:a7ffa4b002b680d125f2725f39f658a72 inherit pub_methods_classsinga_1_1Initializer"><td class="mdescLeft"> </td><td class="mdescRight">Set meta fields from user configurations. <br /></td></tr> +<tr class="separator:a7ffa4b002b680d125f2725f39f658a72 inherit pub_methods_classsinga_1_1Initializer"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Ref: [Bengio and Glorot 2010] Understanding the difficulty of training deep feedforward neural networks. </p> +</div><hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/moaz/incubator-singa/include/singa/model/<a class="el" href="initializer_8h_source.html">initializer.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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::init::Xavier" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::init::Xavier",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::Initializer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Initializer.html"]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +3512166d8edaa692ebbec77c1bd18efe \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::init::Xavier" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::init::Xavier",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Initializer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Initializer.html"]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1init_1_1Xavier__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +7f02b7522931b5792496a3d432e2e2b3 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,93 @@ +<!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: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/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_1BinFileReader.html">BinFileReader</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::io::BinFileReader Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ad975e2276d82173a59021f353dbadf68">Close</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a5cd9ba4198573517cdddf1670b28f1f6">Count</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a34cc1d57cb53922dd954f2380ff2e137">Open</a>(const std::string &path) override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a691d7057b51baf2ed369bd76828770b1">Open</a>(const std::string &path, int capacity)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a55f03ebea25867f36b8e6a61597246eb">OpenFile</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">path</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ac08f91372fb5ede0837fe59925f531d1">PrepareNextField</a>(int size)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a956414a417964de2a8f8248ea8ba1e0c">Read</a>(std::string *key, std::string *value) override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#afb5a302a0633012c0e7a52514e8cfff0">ReadField</a>(std::string *content)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ae73a7c0aed3d2667ff83176c7dc3539c">SeekToFirst</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~BinFileReader</b>() (defined in <a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a>)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html">singa::io::BinFileReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">~Reader</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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/classsinga_1_1io_1_1BinFileReader.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,388 @@ +<!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::BinFileReader 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_1BinFileReader.html">BinFileReader</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_1BinFileReader-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::io::BinFileReader Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Binfilereader reads tuples from binary file with key-value pairs. + <a href="classsinga_1_1io_1_1BinFileReader.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::BinFileReader:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1io_1_1BinFileReader__inherit__graph.png" border="0" usemap="#singa_1_1io_1_1BinFileReader_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::BinFileReader:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1io_1_1BinFileReader__coll__graph.png" border="0" usemap="#singa_1_1io_1_1BinFileReader_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:a34cc1d57cb53922dd954f2380ff2e137"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a34cc1d57cb53922dd954f2380ff2e137">Open</a> (const std::string &<a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">path</a>) override</td></tr> +<tr class="separator:a34cc1d57cb53922dd954f2380ff2e137"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a691d7057b51baf2ed369bd76828770b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a691d7057b51baf2ed369bd76828770b1">Open</a> (const std::string &<a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">path</a>, int capacity)</td></tr> +<tr class="memdesc:a691d7057b51baf2ed369bd76828770b1"><td class="mdescLeft"> </td><td class="mdescRight">user defines capacity <a href="#a691d7057b51baf2ed369bd76828770b1">More...</a><br /></td></tr> +<tr class="separator:a691d7057b51baf2ed369bd76828770b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad975e2276d82173a59021f353dbadf68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ad975e2276d82173a59021f353dbadf68">Close</a> () override</td></tr> +<tr class="separator:ad975e2276d82173a59021f353dbadf68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a956414a417964de2a8f8248ea8ba1e0c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a956414a417964de2a8f8248ea8ba1e0c">Read</a> (std::string *key, std::string *value) override</td></tr> +<tr class="separator:a956414a417964de2a8f8248ea8ba1e0c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5cd9ba4198573517cdddf1670b28f1f6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a5cd9ba4198573517cdddf1670b28f1f6">Count</a> () override</td></tr> +<tr class="separator:a5cd9ba4198573517cdddf1670b28f1f6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae73a7c0aed3d2667ff83176c7dc3539c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ae73a7c0aed3d2667ff83176c7dc3539c">SeekToFirst</a> () override</td></tr> +<tr class="separator:ae73a7c0aed3d2667ff83176c7dc3539c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a85039856483c4e16b9ca12cdec7d8bca"><td class="memItemLeft" align="right" valign="top"><a id="a85039856483c4e16b9ca12cdec7d8bca"></a> +std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a85039856483c4e16b9ca12cdec7d8bca">path</a> ()</td></tr> +<tr class="memdesc:a85039856483c4e16b9ca12cdec7d8bca"><td class="mdescLeft"> </td><td class="mdescRight">return path to binary file <br /></td></tr> +<tr class="separator:a85039856483c4e16b9ca12cdec7d8bca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classsinga_1_1io_1_1Reader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1io_1_1Reader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td></tr> +<tr class="memitem:a151239317e76d0db47e5e6d01ed5fca3 inherit pub_methods_classsinga_1_1io_1_1Reader"><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 inherit pub_methods_classsinga_1_1io_1_1Reader"><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="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">More...</a><br /></td></tr> +<tr class="separator:a151239317e76d0db47e5e6d01ed5fca3 inherit pub_methods_classsinga_1_1io_1_1Reader"><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:a55f03ebea25867f36b8e6a61597246eb"><td class="memItemLeft" align="right" valign="top"><a id="a55f03ebea25867f36b8e6a61597246eb"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#a55f03ebea25867f36b8e6a61597246eb">OpenFile</a> ()</td></tr> +<tr class="memdesc:a55f03ebea25867f36b8e6a61597246eb"><td class="mdescLeft"> </td><td class="mdescRight">Open a file with path_ and initialize buf_. <br /></td></tr> +<tr class="separator:a55f03ebea25867f36b8e6a61597246eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afb5a302a0633012c0e7a52514e8cfff0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#afb5a302a0633012c0e7a52514e8cfff0">ReadField</a> (std::string *content)</td></tr> +<tr class="memdesc:afb5a302a0633012c0e7a52514e8cfff0"><td class="mdescLeft"> </td><td class="mdescRight">Read the next filed, including content_len and content; return true if succeed. <a href="#afb5a302a0633012c0e7a52514e8cfff0">More...</a><br /></td></tr> +<tr class="separator:afb5a302a0633012c0e7a52514e8cfff0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac08f91372fb5ede0837fe59925f531d1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1io_1_1BinFileReader.html#ac08f91372fb5ede0837fe59925f531d1">PrepareNextField</a> (int size)</td></tr> +<tr class="memdesc:ac08f91372fb5ede0837fe59925f531d1"><td class="mdescLeft"> </td><td class="mdescRight">Read data from disk if the current data in the buffer is not a full field. <a href="#ac08f91372fb5ede0837fe59925f531d1">More...</a><br /></td></tr> +<tr class="separator:ac08f91372fb5ede0837fe59925f531d1"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Binfilereader reads tuples from binary file with key-value pairs. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="ad975e2276d82173a59021f353dbadf68"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad975e2276d82173a59021f353dbadf68">◆ </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::BinFileReader::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_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">singa::io::Reader</a>.</p> + +</div> +</div> +<a id="a5cd9ba4198573517cdddf1670b28f1f6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5cd9ba4198573517cdddf1670b28f1f6">◆ </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">int singa::io::BinFileReader::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">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_1Reader.html#a860fade6259818e89887aac059bb6277">singa::io::Reader</a>.</p> + +</div> +</div> +<a id="a34cc1d57cb53922dd954f2380ff2e137"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a34cc1d57cb53922dd954f2380ff2e137">◆ </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::BinFileReader::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">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_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">singa::io::Reader</a>.</p> + +</div> +</div> +<a id="a691d7057b51baf2ed369bd76828770b1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a691d7057b51baf2ed369bd76828770b1">◆ </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::BinFileReader::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">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="ac08f91372fb5ede0837fe59925f531d1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac08f91372fb5ede0837fe59925f531d1">◆ </a></span>PrepareNextField()</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::BinFileReader::PrepareNextField </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Read data from disk if the current data in the buffer is not a full field. </p> +<p>size is the size of the next field. </p> + +</div> +</div> +<a id="a956414a417964de2a8f8248ea8ba1e0c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a956414a417964de2a8f8248ea8ba1e0c">◆ </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">bool singa::io::BinFileReader::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">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_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">singa::io::Reader</a>.</p> + +</div> +</div> +<a id="afb5a302a0633012c0e7a52514e8cfff0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afb5a302a0633012c0e7a52514e8cfff0">◆ </a></span>ReadField()</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::BinFileReader::ReadField </td> + <td>(</td> + <td class="paramtype">std::string * </td> + <td class="paramname"><em>content</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Read the next filed, including content_len and content; return true if succeed. </p> + +</div> +</div> +<a id="ae73a7c0aed3d2667ff83176c7dc3539c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae73a7c0aed3d2667ff83176c7dc3539c">◆ </a></span>SeekToFirst()</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::BinFileReader::SeekToFirst </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_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">singa::io::Reader</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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::io::BinFileReader" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::io::BinFileReader",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::io::Reader",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1io_1_1Reader.html",tooltip="General Reader that provides functions for reading tuples. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +8aaa087a2b23f21379334e6ddfc052e4 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::io::BinFileReader" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::io::BinFileReader",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::io::Reader",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1io_1_1Reader.html",tooltip="General Reader that provides functions for reading tuples. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileReader__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +8ff860f2613d7a81630e3c3666ac76b5 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,90 @@ +<!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: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/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="headertitle"> +<div class="title">singa::io::BinFileWriter Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ae59938d01be24bbee59b984d84f5da34">Close</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a8aa72d95e120fa05be7839f77d4a897b">Flush</a>() override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ad1c03151f8b23e5457448ab9adb66c9f">Open</a>(const std::string &path, Mode mode) override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a56d4be309b08d8417c5d24e8aead8c28">Open</a>(const std::string &path, Mode mode, int capacity)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#a43f2df3567cbace6ce2476a3f2d0557c">OpenFile</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#ab3a9f9671370e94505aa41132a4d5e12">path</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html#adfea9905cf6eec1bf81b05c4c33c67f3">Write</a>(const std::string &key, const std::string &value) override</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~BinFileWriter</b>() (defined in <a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a>)</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1BinFileWriter.html">singa::io::BinFileWriter</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1Writer.html#aa5a4ed9aae85f2f879563d094a6cc4f1">~Writer</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Writer.html">singa::io::Writer</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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/classsinga_1_1io_1_1BinFileWriter.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,317 @@ +<!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> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::io::BinFileWriter" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::io::BinFileWriter",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::io::Writer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1io_1_1Writer.html",tooltip="General Writer that provides functions for writing tuples. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +87d2d5646297253a8c460e6a426b7f33 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::io::BinFileWriter" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::io::BinFileWriter",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::io::Writer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1io_1_1Writer.html",tooltip="General Writer that provides functions for writing tuples. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1BinFileWriter__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +07807aa4deb11e5f6bf784a74f600c04 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1Reader-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1Reader-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1Reader-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1io_1_1Reader-members.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: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/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="headertitle"> +<div class="title">singa::io::Reader Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#ae9a44a2b4ae832493c04d9b540ef29e1">Close</a>()=0</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a860fade6259818e89887aac059bb6277">Count</a>()=0</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a6894610ce2560dbe7641fdf5a3abf909">Open</a>(const std::string &path)=0</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a8d45ee8b877e4344d776265af16e0c4b">Read</a>(std::string *key, std::string *value)=0</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a82bb5bcb71d5abc58ffad4b698eb4965">SeekToFirst</a>()=0</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html#a151239317e76d0db47e5e6d01ed5fca3">~Reader</a>()</td><td class="entry"><a class="el" href="classsinga_1_1io_1_1Reader.html">singa::io::Reader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr> +</table></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>
