| <!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::RecordIOWriter 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_1RecordIOWriter.html">RecordIOWriter</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="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="classdmlc_1_1RecordIOWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::RecordIOWriter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>writer of binary recordio binary format for recordio recordio format: magic lrecord data pad |
| <a href="classdmlc_1_1RecordIOWriter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="recordio_8h_source.html">recordio.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::RecordIOWriter:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1RecordIOWriter__coll__graph.png" border="0" usemap="#dmlc_1_1RecordIOWriter_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1RecordIOWriter_coll__map" id="dmlc_1_1RecordIOWriter_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:acbf967c55f0fb545c3282598f4f0a865"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#acbf967c55f0fb545c3282598f4f0a865">RecordIOWriter</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *stream)</td></tr> |
| <tr class="memdesc:acbf967c55f0fb545c3282598f4f0a865"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#acbf967c55f0fb545c3282598f4f0a865">More...</a><br /></td></tr> |
| <tr class="separator:acbf967c55f0fb545c3282598f4f0a865"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add95d4877af1acffbe09fbb9006ccebd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#add95d4877af1acffbe09fbb9006ccebd">WriteRecord</a> (const void *buf, size_t size)</td></tr> |
| <tr class="memdesc:add95d4877af1acffbe09fbb9006ccebd"><td class="mdescLeft"> </td><td class="mdescRight">write record to the stream <a href="#add95d4877af1acffbe09fbb9006ccebd">More...</a><br /></td></tr> |
| <tr class="separator:add95d4877af1acffbe09fbb9006ccebd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa05016e780b29a0e63f89d8bd249867e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#aa05016e780b29a0e63f89d8bd249867e">WriteRecord</a> (const std::string &data)</td></tr> |
| <tr class="memdesc:aa05016e780b29a0e63f89d8bd249867e"><td class="mdescLeft"> </td><td class="mdescRight">write record to the stream <a href="#aa05016e780b29a0e63f89d8bd249867e">More...</a><br /></td></tr> |
| <tr class="separator:aa05016e780b29a0e63f89d8bd249867e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95c362e13bded045e73c6be1d5167c1d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#a95c362e13bded045e73c6be1d5167c1d">except_counter</a> (void) const</td></tr> |
| <tr class="separator:a95c362e13bded045e73c6be1d5167c1d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa45b6b75db56d6c49e86bfbca39eb198"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#aa45b6b75db56d6c49e86bfbca39eb198">Tell</a> (void)</td></tr> |
| <tr class="memdesc:aa45b6b75db56d6c49e86bfbca39eb198"><td class="mdescLeft"> </td><td class="mdescRight">tell the current position of the input stream <a href="#aa45b6b75db56d6c49e86bfbca39eb198">More...</a><br /></td></tr> |
| <tr class="separator:aa45b6b75db56d6c49e86bfbca39eb198"><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:ac99d55e4608f9d4cffcd9deec0d89eea"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#ac99d55e4608f9d4cffcd9deec0d89eea">EncodeLRec</a> (uint32_t cflag, uint32_t length)</td></tr> |
| <tr class="memdesc:ac99d55e4608f9d4cffcd9deec0d89eea"><td class="mdescLeft"> </td><td class="mdescRight">encode the lrecord <a href="#ac99d55e4608f9d4cffcd9deec0d89eea">More...</a><br /></td></tr> |
| <tr class="separator:ac99d55e4608f9d4cffcd9deec0d89eea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6119f6220061c9019cae2216f6a6fba4"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#a6119f6220061c9019cae2216f6a6fba4">DecodeFlag</a> (uint32_t rec)</td></tr> |
| <tr class="memdesc:a6119f6220061c9019cae2216f6a6fba4"><td class="mdescLeft"> </td><td class="mdescRight">decode the flag part of lrecord <a href="#a6119f6220061c9019cae2216f6a6fba4">More...</a><br /></td></tr> |
| <tr class="separator:a6119f6220061c9019cae2216f6a6fba4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9abff1255e20e266e65e091ddcec6422"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#a9abff1255e20e266e65e091ddcec6422">DecodeLength</a> (uint32_t rec)</td></tr> |
| <tr class="memdesc:a9abff1255e20e266e65e091ddcec6422"><td class="mdescLeft"> </td><td class="mdescRight">decode the length part of lrecord <a href="#a9abff1255e20e266e65e091ddcec6422">More...</a><br /></td></tr> |
| <tr class="separator:a9abff1255e20e266e65e091ddcec6422"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a26b8004576cd8d663f4b7b11e3287533"><td class="memItemLeft" align="right" valign="top">static const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1RecordIOWriter.html#a26b8004576cd8d663f4b7b11e3287533">kMagic</a> = 0xced7230a</td></tr> |
| <tr class="memdesc:a26b8004576cd8d663f4b7b11e3287533"><td class="mdescLeft"> </td><td class="mdescRight">magic number of recordio note: (kMagic >> 29U) & 7 > 3 this ensures lrec will not be kMagic <a href="#a26b8004576cd8d663f4b7b11e3287533">More...</a><br /></td></tr> |
| <tr class="separator:a26b8004576cd8d663f4b7b11e3287533"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>writer of binary recordio binary format for recordio recordio format: magic lrecord data pad </p> |
| <ul> |
| <li>magic is magic number</li> |
| <li>pad is simply a padding space to make record align to 4 bytes</li> |
| <li>lrecord encodes length and continue bit<ul> |
| <li>data.length() = (lrecord & (1U<<29U - 1));</li> |
| <li>cflag == (lrecord >> 29U) & 7;</li> |
| </ul> |
| </li> |
| </ul> |
| <p>cflag was used to handle (rare) special case when magic number occured in the data sequence.</p> |
| <p>In such case, the data is splitted into multiple records by the cells of magic number</p> |
| <p>(1) cflag == 0: this is a complete record; (2) cflag == 1: start of a multiple-rec; cflag == 2: middle of multiple-rec; cflag == 3: end of multiple-rec </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="acbf967c55f0fb545c3282598f4f0a865"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acbf967c55f0fb545c3282598f4f0a865">◆ </a></span>RecordIOWriter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::RecordIOWriter::RecordIOWriter </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 class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>constructor </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>the stream to be constructed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6119f6220061c9019cae2216f6a6fba4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6119f6220061c9019cae2216f6a6fba4">◆ </a></span>DecodeFlag()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static uint32_t dmlc::RecordIOWriter::DecodeFlag </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>rec</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>decode the flag part of lrecord </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">rec</td><td>the lrecord </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the flag </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9abff1255e20e266e65e091ddcec6422"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9abff1255e20e266e65e091ddcec6422">◆ </a></span>DecodeLength()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static uint32_t dmlc::RecordIOWriter::DecodeLength </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>rec</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>decode the length part of lrecord </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">rec</td><td>the lrecord </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the length </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac99d55e4608f9d4cffcd9deec0d89eea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac99d55e4608f9d4cffcd9deec0d89eea">◆ </a></span>EncodeLRec()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static uint32_t dmlc::RecordIOWriter::EncodeLRec </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>cflag</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>length</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 class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>encode the lrecord </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cflag</td><td>cflag part of the lrecord </td></tr> |
| <tr><td class="paramname">length</td><td>length part of lrecord </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the encoded data </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a95c362e13bded045e73c6be1d5167c1d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a95c362e13bded045e73c6be1d5167c1d">◆ </a></span>except_counter()</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::RecordIOWriter::except_counter </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>number of exceptions(occurance of magic number) during the writing process </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa45b6b75db56d6c49e86bfbca39eb198"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa45b6b75db56d6c49e86bfbca39eb198">◆ </a></span>Tell()</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::RecordIOWriter::Tell </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>tell the current position of the input stream </p> |
| |
| </div> |
| </div> |
| <a id="add95d4877af1acffbe09fbb9006ccebd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#add95d4877af1acffbe09fbb9006ccebd">◆ </a></span>WriteRecord() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::RecordIOWriter::WriteRecord </td> |
| <td>(</td> |
| <td class="paramtype">const void * </td> |
| <td class="paramname"><em>buf</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> |
| </div><div class="memdoc"> |
| |
| <p>write record to the stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buf</td><td>the buffer of memory region </td></tr> |
| <tr><td class="paramname">size</td><td>the size of record to write out </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aa05016e780b29a0e63f89d8bd249867e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa05016e780b29a0e63f89d8bd249867e">◆ </a></span>WriteRecord() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::RecordIOWriter::WriteRecord </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </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>write record to the stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>the data to write out </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a26b8004576cd8d663f4b7b11e3287533"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a26b8004576cd8d663f4b7b11e3287533">◆ </a></span>kMagic</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const uint32_t dmlc::RecordIOWriter::kMagic = 0xced7230a</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>magic number of recordio note: (kMagic >> 29U) & 7 > 3 this ensures lrec will not be kMagic </p> |
| |
| </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="recordio_8h_source.html">recordio.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> |
