Google Git
Sign in
apache / mxnet-test / refs/heads/asf-site / . / versions / master / doxygen / classmxnet_1_1Storage.html
blob: ad67e4dbb03edb0de055339060c49d8b8e00717b [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.6"/>
<title>mxnet: mxnet::Storage 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classmxnet_1_1Storage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Storage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> manager across multiple devices.
<a href="classmxnet_1_1Storage.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:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1Storage__coll__graph.png" border="0" usemap="#mxnet_1_1Storage_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1Storage_coll__map" id="mxnet_1_1Storage_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aaa387e9ae8d66a63438543d640f6cfff"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#aaa387e9ae8d66a63438543d640f6cfff">Alloc</a> (size_t size, <a class="el" href="structmxnet_1_1Context.html">Context</a> ctx)=0</td></tr>
<tr class="memdesc:aaa387e9ae8d66a63438543d640f6cfff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a new contiguous memory for a given size. <a href="#aaa387e9ae8d66a63438543d640f6cfff">More...</a><br/></td></tr>
<tr class="separator:aaa387e9ae8d66a63438543d640f6cfff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">Free</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle)=0</td></tr>
<tr class="memdesc:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free storage. <a href="#a5bdbd7b3ab712cd9e087ab007bdc64dd">More...</a><br/></td></tr>
<tr class="separator:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a098f8ebacd25f5203b2dc4c1796aec64"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">DirectFree</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle)=0</td></tr>
<tr class="memdesc:a098f8ebacd25f5203b2dc4c1796aec64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free storage directly, without putting it into memory pool. This can synchronization of all previous runned device functions. <a href="#a098f8ebacd25f5203b2dc4c1796aec64">More...</a><br/></td></tr>
<tr class="separator:a098f8ebacd25f5203b2dc4c1796aec64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1e1bfea9236ccfba64344226416b04a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">~Storage</a> ()</td></tr>
<tr class="memdesc:af1e1bfea9236ccfba64344226416b04a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#af1e1bfea9236ccfba64344226416b04a">More...</a><br/></td></tr>
<tr class="separator:af1e1bfea9236ccfba64344226416b04a"><td class="memSeparator" colspan="2">&#160;</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:a96abc072908d72d3271360a7e3e4bbc2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Storage.html">Storage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">Get</a> ()</td></tr>
<tr class="separator:a96abc072908d72d3271360a7e3e4bbc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c5e9c239447ee223ab912716d53d7c7"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="classmxnet_1_1Storage.html">Storage</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a4c5e9c239447ee223ab912716d53d7c7">_GetSharedRef</a> ()</td></tr>
<tr class="memdesc:a4c5e9c239447ee223ab912716d53d7c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get shared pointer reference to storage singleton. Most user should not call this function. This function is called by another singleton X who requires <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> to be destructed after X. <a href="#a4c5e9c239447ee223ab912716d53d7c7">More...</a><br/></td></tr>
<tr class="separator:a4c5e9c239447ee223ab912716d53d7c7"><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> manager across multiple devices. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af1e1bfea9236ccfba64344226416b04a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual mxnet::Storage::~Storage </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>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4c5e9c239447ee223ab912716d53d7c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::shared_ptr&lt;<a class="el" href="classmxnet_1_1Storage.html">Storage</a>&gt; mxnet::Storage::_GetSharedRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Get shared pointer reference to storage singleton. Most user should not call this function. This function is called by another singleton X who requires <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> to be destructed after X. </p>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> singleton. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa387e9ae8d66a63438543d640f6cfff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> mxnet::Storage::Alloc </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Context.html">Context</a>&#160;</td>
<td class="paramname"><em>ctx</em>&#160;</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>Allocate a new contiguous memory for a given size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Total size of memory in bytes. </td></tr>
<tr><td class="paramname">ctx</td><td><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> information about the device and ID. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle. ">Handle</a> struct. </dd></dl>
</div>
</div>
<a class="anchor" id="a098f8ebacd25f5203b2dc4c1796aec64"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::Storage::DirectFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a>&#160;</td>
<td class="paramname"><em>handle</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>Free storage directly, without putting it into memory pool. This can synchronization of all previous runned device functions. </p>
<p>This function is suitable for conatiner structure with requirement on upsizing in the beginning phase of the iteration.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle. ">Handle</a> struct. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5bdbd7b3ab712cd9e087ab007bdc64dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void mxnet::Storage::Free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a>&#160;</td>
<td class="paramname"><em>handle</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>Free storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle. ">Handle</a> struect. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a96abc072908d72d3271360a7e3e4bbc2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classmxnet_1_1Storage.html">Storage</a>* mxnet::Storage::Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices. ">Storage</a> singleton. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>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 Sun Aug 6 2017 07:14:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>