blob: 4e38f64f3be4af5b8f26ac2b7fc4fefbc3396ca5 [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: mxnet::Storage::Handle Struct 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Storage.html">Storage</a></li><li class="navelem"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmxnet_1_1Storage_1_1Handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Storage::Handle Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> handle.
<a href="structmxnet_1_1Storage_1_1Handle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="storage_8h_source.html">storage.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::Storage::Handle:</div>
<div class="dyncontent">
<div class="center"><img src="structmxnet_1_1Storage_1_1Handle__coll__graph.png" border="0" usemap="#mxnet_1_1Storage_1_1Handle_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1Storage_1_1Handle_coll__map" id="mxnet_1_1Storage_1_1Handle_coll__map">
<area shape="rect" id="node2" href="structmxnet_1_1Context.html" title="Context information about the execution environment. " alt="" coords="5,5,232,376"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a428e25a6317e50c8b55307c96f8ec595"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">dptr</a> {nullptr}</td></tr>
<tr class="memdesc:a428e25a6317e50c8b55307c96f8ec595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the data. <a href="#a428e25a6317e50c8b55307c96f8ec595">More...</a><br /></td></tr>
<tr class="separator:a428e25a6317e50c8b55307c96f8ec595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab93b9db0c83e4ef3803fb587377a74a0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">size</a> {0}</td></tr>
<tr class="memdesc:ab93b9db0c83e4ef3803fb587377a74a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the storage. <a href="#ab93b9db0c83e4ef3803fb587377a74a0">More...</a><br /></td></tr>
<tr class="separator:ab93b9db0c83e4ef3803fb587377a74a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0a4202582aa12a598f5c55ef51ad4c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">ctx</a></td></tr>
<tr class="memdesc:ae0a4202582aa12a598f5c55ef51ad4c8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> information about device and ID. <a href="#ae0a4202582aa12a598f5c55ef51ad4c8">More...</a><br /></td></tr>
<tr class="separator:ae0a4202582aa12a598f5c55ef51ad4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac92111bc6d73d7402331615506684b74"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html#ac92111bc6d73d7402331615506684b74">shared_pid</a> {-1}</td></tr>
<tr class="memdesc:ac92111bc6d73d7402331615506684b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Id for IPC shared memory. <a href="#ac92111bc6d73d7402331615506684b74">More...</a><br /></td></tr>
<tr class="separator:ac92111bc6d73d7402331615506684b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad938f8d0ddba567350ee7b3aae14b4c1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html#ad938f8d0ddba567350ee7b3aae14b4c1">shared_id</a> {-1}</td></tr>
<tr class="separator:ad938f8d0ddba567350ee7b3aae14b4c1"><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><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> handle. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0a4202582aa12a598f5c55ef51ad4c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0a4202582aa12a598f5c55ef51ad4c8">&#9670;&nbsp;</a></span>ctx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmxnet_1_1Context.html">Context</a> mxnet::Storage::Handle::ctx</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> information about device and ID. </p>
</div>
</div>
<a id="a428e25a6317e50c8b55307c96f8ec595"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a428e25a6317e50c8b55307c96f8ec595">&#9670;&nbsp;</a></span>dptr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mxnet::Storage::Handle::dptr {nullptr}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the data. </p>
</div>
</div>
<a id="ad938f8d0ddba567350ee7b3aae14b4c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad938f8d0ddba567350ee7b3aae14b4c1">&#9670;&nbsp;</a></span>shared_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::Storage::Handle::shared_id {-1}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac92111bc6d73d7402331615506684b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac92111bc6d73d7402331615506684b74">&#9670;&nbsp;</a></span>shared_pid</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::Storage::Handle::shared_pid {-1}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Id for IPC shared memory. </p>
</div>
</div>
<a id="ab93b9db0c83e4ef3803fb587377a74a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab93b9db0c83e4ef3803fb587377a74a0">&#9670;&nbsp;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mxnet::Storage::Handle::size {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the storage. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="storage_8h_source.html">storage.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:44 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>