| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: dmlc::ostream 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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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_1ostream.html">ostream</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_1ostream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::ostream Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>a std::ostream 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 ostream 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_1ostream.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::ostream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ostream__inherit__graph.png" border="0" usemap="#dmlc_1_1ostream_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::ostream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1ostream__coll__graph.png" border="0" usemap="#dmlc_1_1ostream_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| </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:aafe415657c7e44e2167a77b9a442bafe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ostream.html#aafe415657c7e44e2167a77b9a442bafe">ostream</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *stream, size_t buffer_size=(1<< 10))</td></tr> |
| <tr class="memdesc:aafe415657c7e44e2167a77b9a442bafe"><td class="mdescLeft"> </td><td class="mdescRight">construct std::ostream type <a href="classdmlc_1_1ostream.html#aafe415657c7e44e2167a77b9a442bafe">More...</a><br /></td></tr> |
| <tr class="separator:aafe415657c7e44e2167a77b9a442bafe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af0f8b262f987bbb01c43a188717cabdd"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ostream.html#af0f8b262f987bbb01c43a188717cabdd">~ostream</a> () <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#aef922e69a4efaccd25161afa4cfb2811">DMLC_NO_EXCEPTION</a></td></tr> |
| <tr class="separator:af0f8b262f987bbb01c43a188717cabdd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7cd937753b09a5ea66fb5ab20aa0a315"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ostream.html#a7cd937753b09a5ea66fb5ab20aa0a315">set_stream</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *stream)</td></tr> |
| <tr class="memdesc:a7cd937753b09a5ea66fb5ab20aa0a315"><td class="mdescLeft"> </td><td class="mdescRight">set internal stream to be stream, reset states <a href="classdmlc_1_1ostream.html#a7cd937753b09a5ea66fb5ab20aa0a315">More...</a><br /></td></tr> |
| <tr class="separator:a7cd937753b09a5ea66fb5ab20aa0a315"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adda195431c39a9afddea3151758e3c05"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ostream.html#adda195431c39a9afddea3151758e3c05">bytes_written</a> (void) const</td></tr> |
| <tr class="separator:adda195431c39a9afddea3151758e3c05"><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::ostream 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 ostream 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">"w"</span>);</div> |
| <div class="line"><a class="code" href="classdmlc_1_1ostream.html">dmlc::ostream</a> os(fs);</div> |
| <div class="line">os << <span class="stringliteral">"hello world"</span> << std::endl;</div> |
| <div class="line"><span class="keyword">delete</span> fs;</div> |
| </div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aafe415657c7e44e2167a77b9a442bafe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aafe415657c7e44e2167a77b9a442bafe">◆ </a></span>ostream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::ostream::ostream </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 streambuf size </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af0f8b262f987bbb01c43a188717cabdd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af0f8b262f987bbb01c43a188717cabdd">◆ </a></span>~ostream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual dmlc::ostream::~ostream </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="adda195431c39a9afddea3151758e3c05"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adda195431c39a9afddea3151758e3c05">◆ </a></span>bytes_written()</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::ostream::bytes_written </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 written so far </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7cd937753b09a5ea66fb5ab20aa0a315"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7cd937753b09a5ea66fb5ab20aa0a315">◆ </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::ostream::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 --> |
| <div class="ttc" id="aclassdmlc_1_1ostream_html"><div class="ttname"><a href="classdmlc_1_1ostream.html">dmlc::ostream</a></div><div class="ttdoc">a std::ostream class that can can wrap Stream objects, can use ostream with that output to underlying...</div><div class="ttdef"><b>Definition:</b> io.h:318</div></div> |
| <div class="ttc" id="aclassdmlc_1_1Stream_html_a243906329f0cea487b35841c9880c028"><div class="ttname"><a href="classdmlc_1_1Stream.html#a243906329f0cea487b35841c9880c028">dmlc::Stream::Create</a></div><div class="ttdeci">static Stream * Create(const char *uri, const char *const flag, bool allow_null=false)</div><div class="ttdoc">generic factory function create an stream, the stream will close the underlying files upon deletion</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
