| <!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::Stream 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_1Stream.html">Stream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classdmlc_1_1Stream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::Stream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>interface of stream I/O for serialization |
| <a href="classdmlc_1_1Stream.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::Stream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1Stream__inherit__graph.png" border="0" usemap="#dmlc_1_1Stream_inherit__map" alt="Inheritance graph"/></div> |
| <map name="dmlc_1_1Stream_inherit__map" id="dmlc_1_1Stream_inherit__map"> |
| <area shape="rect" id="node2" href="classdmlc_1_1SeekStream.html" title="interface of i/o stream that support seek " alt="" coords="163,233,305,355"/> |
| <area shape="rect" id="node3" href="structdmlc_1_1MemoryFixedSizeStream.html" title="A Stream that operates on fixed region of memory This class allows us to read/write from/to a fixed m..." alt="" coords="5,403,228,539"/> |
| <area shape="rect" id="node4" href="structdmlc_1_1MemoryStringStream.html" title="A in memory stream that is backed by std::string. This class allows us to read/write from/to a std::s..." alt="" coords="251,403,451,539"/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::Stream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1Stream__coll__graph.png" border="0" usemap="#dmlc_1_1Stream_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1Stream_coll__map" id="dmlc_1_1Stream_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:a747da13b990ff68dc9bf9ea5224ad174"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a747da13b990ff68dc9bf9ea5224ad174">Read</a> (void *ptr, size_t size)=0</td></tr> |
| <tr class="memdesc:a747da13b990ff68dc9bf9ea5224ad174"><td class="mdescLeft"> </td><td class="mdescRight">reads data from a stream <a href="#a747da13b990ff68dc9bf9ea5224ad174">More...</a><br /></td></tr> |
| <tr class="separator:a747da13b990ff68dc9bf9ea5224ad174"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a622f1377a64e841ca80c2dd8e1fa5ffd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a622f1377a64e841ca80c2dd8e1fa5ffd">Write</a> (const void *ptr, size_t size)=0</td></tr> |
| <tr class="memdesc:a622f1377a64e841ca80c2dd8e1fa5ffd"><td class="mdescLeft"> </td><td class="mdescRight">writes data to a stream <a href="#a622f1377a64e841ca80c2dd8e1fa5ffd">More...</a><br /></td></tr> |
| <tr class="separator:a622f1377a64e841ca80c2dd8e1fa5ffd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b1cb597f6f53d10b2e72b49bd695a20"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a4b1cb597f6f53d10b2e72b49bd695a20">~Stream</a> (void)</td></tr> |
| <tr class="memdesc:a4b1cb597f6f53d10b2e72b49bd695a20"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <a href="#a4b1cb597f6f53d10b2e72b49bd695a20">More...</a><br /></td></tr> |
| <tr class="separator:a4b1cb597f6f53d10b2e72b49bd695a20"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3600b93771ffdb0c3181bd477e045ce7"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:a3600b93771ffdb0c3181bd477e045ce7"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a3600b93771ffdb0c3181bd477e045ce7">Write</a> (const T &data)</td></tr> |
| <tr class="memdesc:a3600b93771ffdb0c3181bd477e045ce7"><td class="mdescLeft"> </td><td class="mdescRight">writes a data to stream. <a href="#a3600b93771ffdb0c3181bd477e045ce7">More...</a><br /></td></tr> |
| <tr class="separator:a3600b93771ffdb0c3181bd477e045ce7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae71c1aa5dfabaa2eb542fd51d824f503"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:ae71c1aa5dfabaa2eb542fd51d824f503"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#ae71c1aa5dfabaa2eb542fd51d824f503">Read</a> (T *out_data)</td></tr> |
| <tr class="memdesc:ae71c1aa5dfabaa2eb542fd51d824f503"><td class="mdescLeft"> </td><td class="mdescRight">loads a data from stream. <a href="#ae71c1aa5dfabaa2eb542fd51d824f503">More...</a><br /></td></tr> |
| <tr class="separator:ae71c1aa5dfabaa2eb542fd51d824f503"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e9f1aae4606bb2dff4e1be8ff5ec079"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:a3e9f1aae4606bb2dff4e1be8ff5ec079"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a3e9f1aae4606bb2dff4e1be8ff5ec079">WriteArray</a> (const T *data, size_t num_elems)</td></tr> |
| <tr class="memdesc:a3e9f1aae4606bb2dff4e1be8ff5ec079"><td class="mdescLeft"> </td><td class="mdescRight">Endian aware write array of data. <a href="#a3e9f1aae4606bb2dff4e1be8ff5ec079">More...</a><br /></td></tr> |
| <tr class="separator:a3e9f1aae4606bb2dff4e1be8ff5ec079"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aae7f6937435169a27dbb0050d9bbbd69"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:aae7f6937435169a27dbb0050d9bbbd69"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#aae7f6937435169a27dbb0050d9bbbd69">ReadArray</a> (T *data, size_t num_elems)</td></tr> |
| <tr class="memdesc:aae7f6937435169a27dbb0050d9bbbd69"><td class="mdescLeft"> </td><td class="mdescRight">Endian aware read array of data. <a href="#aae7f6937435169a27dbb0050d9bbbd69">More...</a><br /></td></tr> |
| <tr class="separator:aae7f6937435169a27dbb0050d9bbbd69"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a243906329f0cea487b35841c9880c028"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Stream.html#a243906329f0cea487b35841c9880c028">Create</a> (const char *uri, const char *const flag, bool allow_null=false)</td></tr> |
| <tr class="memdesc:a243906329f0cea487b35841c9880c028"><td class="mdescLeft"> </td><td class="mdescRight">generic factory function create an stream, the stream will close the underlying files upon deletion <a href="#a243906329f0cea487b35841c9880c028">More...</a><br /></td></tr> |
| <tr class="separator:a243906329f0cea487b35841c9880c028"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>interface of stream I/O for serialization </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4b1cb597f6f53d10b2e72b49bd695a20"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b1cb597f6f53d10b2e72b49bd695a20">◆ </a></span>~Stream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual dmlc::Stream::~Stream </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>virtual destructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a243906329f0cea487b35841c9880c028"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a243906329f0cea487b35841c9880c028">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdmlc_1_1Stream.html">Stream</a>* dmlc::Stream::Create </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>uri</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char *const </td> |
| <td class="paramname"><em>flag</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>allow_null</em> = <code>false</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">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>generic factory function create an stream, the stream will close the underlying files upon deletion </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">uri</td><td>the uri of the input currently we support hdfs://, s3://, and <a href="file://">file://</a> by default <a href="file://">file://</a> will be used </td></tr> |
| <tr><td class="paramname">flag</td><td>can be "w", "r", "a" </td></tr> |
| <tr><td class="paramname">allow_null</td><td>whether NULL can be returned, or directly report error </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the created stream, can be NULL when allow_null == true and file do not exist </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a747da13b990ff68dc9bf9ea5224ad174"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a747da13b990ff68dc9bf9ea5224ad174">◆ </a></span>Read() <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">virtual size_t dmlc::Stream::Read </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>ptr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>reads data from a stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to a memory buffer </td></tr> |
| <tr><td class="paramname">size</td><td>block size </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the size of data read </dd></dl> |
| |
| <p>Implemented in <a class="el" href="structdmlc_1_1MemoryStringStream.html#a3f297018b59227d2a318c88f1a8d1170">dmlc::MemoryStringStream</a>, and <a class="el" href="structdmlc_1_1MemoryFixedSizeStream.html#a04c94431b14d9476f960acc4e29a4fbc">dmlc::MemoryFixedSizeStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae71c1aa5dfabaa2eb542fd51d824f503"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae71c1aa5dfabaa2eb542fd51d824f503">◆ </a></span>Read() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool dmlc::Stream::Read </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>out_data</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>loads a data from stream. </p> |
| <p><a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">dmlc::Stream</a> support Write/Read of most STL composites and base types. If the data type is not supported, a compile time error will be issued.</p> |
| <p>This function is endian-aware, the input endian defined by DMLC_IO_USE_LITTLE_ENDIAN</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">out_data</td><td>place holder of data to be deserialized </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>whether the load was successful </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aae7f6937435169a27dbb0050d9bbbd69"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aae7f6937435169a27dbb0050d9bbbd69">◆ </a></span>ReadArray()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool dmlc::Stream::ReadArray </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>num_elems</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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Endian aware read array of data. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>The data pointer </td></tr> |
| <tr><td class="paramname">num_elems</td><td>Number of elements </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the data type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>whether the load was successful </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a622f1377a64e841ca80c2dd8e1fa5ffd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a622f1377a64e841ca80c2dd8e1fa5ffd">◆ </a></span>Write() <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">virtual void dmlc::Stream::Write </td> |
| <td>(</td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>ptr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>writes data to a stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to a memory buffer </td></tr> |
| <tr><td class="paramname">size</td><td>block size </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="structdmlc_1_1MemoryStringStream.html#a4044c0c29db112f5b8ae79c6e7d2367e">dmlc::MemoryStringStream</a>, and <a class="el" href="structdmlc_1_1MemoryFixedSizeStream.html#ad654c8490301d8f00a24c5ba95891644">dmlc::MemoryFixedSizeStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a3600b93771ffdb0c3181bd477e045ce7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3600b93771ffdb0c3181bd477e045ce7">◆ </a></span>Write() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::Stream::Write </td> |
| <td>(</td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>data</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>writes a data to stream. </p> |
| <p><a class="el" href="classdmlc_1_1Stream.html" title="interface of stream I/O for serialization ">dmlc::Stream</a> support Write/Read of most STL composites and base types. If the data type is not supported, a compile time error will be issued.</p> |
| <p>This function is endian-aware, the output endian defined by DMLC_IO_USE_LITTLE_ENDIAN</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>data to be written </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the data type to be written </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3e9f1aae4606bb2dff4e1be8ff5ec079"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e9f1aae4606bb2dff4e1be8ff5ec079">◆ </a></span>WriteArray()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::Stream::WriteArray </td> |
| <td>(</td> |
| <td class="paramtype">const T * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>num_elems</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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Endian aware write array of data. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>The data pointer </td></tr> |
| <tr><td class="paramname">num_elems</td><td>Number of elements </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the data type. </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> |