blob: 3883451461f5f4d0d4b322ba6d7e446d58f92772 [file] [log] [blame]
<!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::Serializable 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_1Serializable.html">Serializable</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdmlc_1_1Serializable-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::Serializable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>interface for serializable objects
<a href="classdmlc_1_1Serializable.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::Serializable:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1Serializable__coll__graph.png" border="0" usemap="#dmlc_1_1Serializable_coll__map" alt="Collaboration graph"/></div>
<map name="dmlc_1_1Serializable_coll__map" id="dmlc_1_1Serializable_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:ae3440f6a437ebc80bce41759eeec5719"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Serializable.html#ae3440f6a437ebc80bce41759eeec5719">~Serializable</a> ()</td></tr>
<tr class="memdesc:ae3440f6a437ebc80bce41759eeec5719"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual destructor <a href="#ae3440f6a437ebc80bce41759eeec5719">More...</a><br /></td></tr>
<tr class="separator:ae3440f6a437ebc80bce41759eeec5719"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a053466933c5f130d811af938d4e209d0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Serializable.html#a053466933c5f130d811af938d4e209d0">Load</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *fi)=0</td></tr>
<tr class="memdesc:a053466933c5f130d811af938d4e209d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">load the model from a stream <a href="#a053466933c5f130d811af938d4e209d0">More...</a><br /></td></tr>
<tr class="separator:a053466933c5f130d811af938d4e209d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a751aaf917c52a7649132e94442fca2d8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1Serializable.html#a751aaf917c52a7649132e94442fca2d8">Save</a> (<a class="el" href="classdmlc_1_1Stream.html">Stream</a> *fo) const =0</td></tr>
<tr class="memdesc:a751aaf917c52a7649132e94442fca2d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">saves the model to a stream <a href="#a751aaf917c52a7649132e94442fca2d8">More...</a><br /></td></tr>
<tr class="separator:a751aaf917c52a7649132e94442fca2d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>interface for serializable objects </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae3440f6a437ebc80bce41759eeec5719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3440f6a437ebc80bce41759eeec5719">&#9670;&nbsp;</a></span>~Serializable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual dmlc::Serializable::~Serializable </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">
<p>virtual destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a053466933c5f130d811af938d4e209d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a053466933c5f130d811af938d4e209d0">&#9670;&nbsp;</a></span>Load()</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::Serializable::Load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> *&#160;</td>
<td class="paramname"><em>fi</em></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>load the model from a stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fi</td><td>stream where to load the model from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a751aaf917c52a7649132e94442fca2d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a751aaf917c52a7649132e94442fca2d8">&#9670;&nbsp;</a></span>Save()</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::Serializable::Save </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdmlc_1_1Stream.html">Stream</a> *&#160;</td>
<td class="paramname"><em>fo</em></td><td>)</td>
<td> const</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>saves the model to a stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fo</td><td>stream where to save the model to </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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>