| <!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: mshadow::utils::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.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="namespacemshadow.html">mshadow</a></li><li class="navelem"><a class="el" href="namespacemshadow_1_1utils.html">utils</a></li><li class="navelem"><a class="el" href="classmshadow_1_1utils_1_1IStream.html">IStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classmshadow_1_1utils_1_1IStream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mshadow::utils::IStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>interface of stream I/O, used to serialize data, mshadow does not restricted to only this interface in SaveBinary/LoadBinary mshadow accept all class that implements Read and Write |
| <a href="classmshadow_1_1utils_1_1IStream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2mshadow_2mshadow_2io_8h_source.html">io.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mshadow::utils::IStream:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmshadow_1_1utils_1_1IStream__coll__graph.png" border="0" usemap="#mshadow_1_1utils_1_1IStream_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </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:a2559de01e6e0e6a885c305147006de08"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1utils_1_1IStream.html#a2559de01e6e0e6a885c305147006de08">Read</a> (void *ptr, size_t size)=0</td></tr> |
| <tr class="memdesc:a2559de01e6e0e6a885c305147006de08"><td class="mdescLeft"> </td><td class="mdescRight">read data from stream <a href="classmshadow_1_1utils_1_1IStream.html#a2559de01e6e0e6a885c305147006de08">More...</a><br /></td></tr> |
| <tr class="separator:a2559de01e6e0e6a885c305147006de08"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2d9ef01d47584fe24aeb85fe896867b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1utils_1_1IStream.html#ac2d9ef01d47584fe24aeb85fe896867b">Write</a> (const void *ptr, size_t size)=0</td></tr> |
| <tr class="memdesc:ac2d9ef01d47584fe24aeb85fe896867b"><td class="mdescLeft"> </td><td class="mdescRight">write data to stream <a href="classmshadow_1_1utils_1_1IStream.html#ac2d9ef01d47584fe24aeb85fe896867b">More...</a><br /></td></tr> |
| <tr class="separator:ac2d9ef01d47584fe24aeb85fe896867b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fd2a7483255a8ba3348a4a88117e2c3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmshadow_1_1utils_1_1IStream.html#a3fd2a7483255a8ba3348a4a88117e2c3">~IStream</a> (void)</td></tr> |
| <tr class="memdesc:a3fd2a7483255a8ba3348a4a88117e2c3"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <a href="classmshadow_1_1utils_1_1IStream.html#a3fd2a7483255a8ba3348a4a88117e2c3">More...</a><br /></td></tr> |
| <tr class="separator:a3fd2a7483255a8ba3348a4a88117e2c3"><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, used to serialize data, mshadow does not restricted to only this interface in SaveBinary/LoadBinary mshadow accept all class that implements Read and Write </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a3fd2a7483255a8ba3348a4a88117e2c3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3fd2a7483255a8ba3348a4a88117e2c3">◆ </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 mshadow::utils::IStream::~IStream </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="a2559de01e6e0e6a885c305147006de08"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2559de01e6e0e6a885c305147006de08">◆ </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">virtual size_t mshadow::utils::IStream::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>read data from stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to memory buffer </td></tr> |
| <tr><td class="paramname">size</td><td>size of block </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>usually is the size of data readed </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac2d9ef01d47584fe24aeb85fe896867b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac2d9ef01d47584fe24aeb85fe896867b">◆ </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">virtual void mshadow::utils::IStream::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>write data to stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ptr</td><td>pointer to memory buffer </td></tr> |
| <tr><td class="paramname">size</td><td>size of block </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/mshadow/mshadow/<a class="el" href="3rdparty_2mshadow_2mshadow_2io_8h_source.html">io.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sun Aug 1 2021 20:32:50 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> |