| <!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::serializer::Handler< T > Struct Template 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="namespacedmlc_1_1serializer.html">serializer</a></li><li class="navelem"><a class="el" href="structdmlc_1_1serializer_1_1Handler.html">Handler</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="structdmlc_1_1serializer_1_1Handler-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::serializer::Handler< T > Struct Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>generic serialization handler |
| <a href="structdmlc_1_1serializer_1_1Handler.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="serializer_8h_source.html">serializer.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::serializer::Handler< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="structdmlc_1_1serializer_1_1Handler__coll__graph.png" border="0" usemap="#dmlc_1_1serializer_1_1Handler_3_01T_01_4_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <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:a57ace2d259a78520ebdc38b9fb588420"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1serializer_1_1Handler.html#a57ace2d259a78520ebdc38b9fb588420">Write</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *strm, const T &data)</td></tr> |
| <tr class="memdesc:a57ace2d259a78520ebdc38b9fb588420"><td class="mdescLeft"> </td><td class="mdescRight">write data to stream <a href="structdmlc_1_1serializer_1_1Handler.html#a57ace2d259a78520ebdc38b9fb588420">More...</a><br /></td></tr> |
| <tr class="separator:a57ace2d259a78520ebdc38b9fb588420"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9568ef43a657578f7b4017e6b33f3e6c"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1serializer_1_1Handler.html#a9568ef43a657578f7b4017e6b33f3e6c">Read</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *strm, T *data)</td></tr> |
| <tr class="memdesc:a9568ef43a657578f7b4017e6b33f3e6c"><td class="mdescLeft"> </td><td class="mdescRight">read data to stream <a href="structdmlc_1_1serializer_1_1Handler.html#a9568ef43a657578f7b4017e6b33f3e6c">More...</a><br /></td></tr> |
| <tr class="separator:a9568ef43a657578f7b4017e6b33f3e6c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T><br /> |
| struct dmlc::serializer::Handler< T ></h3> |
| |
| <p>generic serialization handler </p> |
| <p>generic serialization handler for type T</p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type to be serialized </td></tr> |
| <tr><td class="paramname">need_endian_swap</td><td>Whether use little endian</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>User can define specialization of this class to support composite serialization of their own class.</p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the type to be serialized </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9568ef43a657578f7b4017e6b33f3e6c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9568ef43a657578f7b4017e6b33f3e6c">◆ </a></span>Read()</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">static bool <a class="el" href="structdmlc_1_1serializer_1_1Handler.html">dmlc::serializer::Handler</a>< T >::Read </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td> |
| <td class="paramname"><em>strm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>data</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>read data to stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">strm</td><td>the stream to read the data. </td></tr> |
| <tr><td class="paramname">data</td><td>the pointer to the data obeject to read </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>whether the read is successful </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a57ace2d259a78520ebdc38b9fb588420"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57ace2d259a78520ebdc38b9fb588420">◆ </a></span>Write()</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">static void <a class="el" href="structdmlc_1_1serializer_1_1Handler.html">dmlc::serializer::Handler</a>< T >::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td> |
| <td class="paramname"><em>strm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>data</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>write data to stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">strm</td><td>the stream we write the data. </td></tr> |
| <tr><td class="paramname">data</td><td>the data obeject to be serialized </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="serializer_8h_source.html">serializer.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Nov 5 2022 01:16:58 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> |