| <!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>mxnet: dmlc::istream 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">mxnet |
| </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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1istream.html">istream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1istream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::istream Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>a std::istream class that can can wrap <a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">Stream</a> objects, can use istream with that output to underlying <a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">Stream</a> |
| <a href="classdmlc_1_1istream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for dmlc::istream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1istream__inherit__graph.png" border="0" usemap="#dmlc_1_1istream_inherit__map" alt="Inheritance graph"/></div> |
| <map name="dmlc_1_1istream_inherit__map" id="dmlc_1_1istream_inherit__map"> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::istream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1istream__coll__graph.png" border="0" usemap="#dmlc_1_1istream_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1istream_coll__map" id="dmlc_1_1istream_coll__map"> |
| </map> |
| </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:a777f9d3bb1c338f92258732517626a19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1istream.html#a777f9d3bb1c338f92258732517626a19">istream</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *stream, size_t buffer_size=(1<< 10))</td></tr> |
| <tr class="memdesc:a777f9d3bb1c338f92258732517626a19"><td class="mdescLeft"> </td><td class="mdescRight">construct std::ostream type <a href="#a777f9d3bb1c338f92258732517626a19">More...</a><br /></td></tr> |
| <tr class="separator:a777f9d3bb1c338f92258732517626a19"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abfb8b1af4df69cfb24836d837bd3e316"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1istream.html#abfb8b1af4df69cfb24836d837bd3e316">~istream</a> () <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#aef922e69a4efaccd25161afa4cfb2811">DMLC_NO_EXCEPTION</a></td></tr> |
| <tr class="separator:abfb8b1af4df69cfb24836d837bd3e316"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a595429218782be17f99857b363465a16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1istream.html#a595429218782be17f99857b363465a16">set_stream</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *stream)</td></tr> |
| <tr class="memdesc:a595429218782be17f99857b363465a16"><td class="mdescLeft"> </td><td class="mdescRight">set internal stream to be stream, reset states <a href="#a595429218782be17f99857b363465a16">More...</a><br /></td></tr> |
| <tr class="separator:a595429218782be17f99857b363465a16"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a853b4457f953dec7081834ad962e35"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1istream.html#a4a853b4457f953dec7081834ad962e35">bytes_read</a> (void) const</td></tr> |
| <tr class="separator:a4a853b4457f953dec7081834ad962e35"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>a std::istream class that can can wrap <a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">Stream</a> objects, can use istream with that output to underlying <a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">Stream</a> </p> |
| <p>Usage example: </p><div class="fragment"><div class="line">Stream *fs = <a class="code" href="classdmlc_1_1Stream.html#a243906329f0cea487b35841c9880c028">Stream::Create</a>(<span class="stringliteral">"hdfs:///test.txt"</span>, <span class="stringliteral">"r"</span>);</div><div class="line"><a class="code" href="classdmlc_1_1istream.html">dmlc::istream</a> is(fs);</div><div class="line">is >> mydata;</div><div class="line"><span class="keyword">delete</span> fs;</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a777f9d3bb1c338f92258732517626a19"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a777f9d3bb1c338f92258732517626a19">◆ </a></span>istream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::istream::istream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>buffer_size</em> = <code>(1 << 10)</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>construct std::ostream type </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>the <a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">Stream</a> output to be used </td></tr> |
| <tr><td class="paramname">buffer_size</td><td>internal buffer size </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="abfb8b1af4df69cfb24836d837bd3e316"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abfb8b1af4df69cfb24836d837bd3e316">◆ </a></span>~istream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual dmlc::istream::~istream </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4a853b4457f953dec7081834ad962e35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a853b4457f953dec7081834ad962e35">◆ </a></span>bytes_read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t dmlc::istream::bytes_read </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>how many bytes we read so far </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a595429218782be17f99857b363465a16"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a595429218782be17f99857b363465a16">◆ </a></span>set_stream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::istream::set_stream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td> |
| <td class="paramname"><em>stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set internal stream to be stream, reset states </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>new stream as output </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet 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> |
