Google Git
Sign in
apache / mxnet-test / refs/heads/asf-site / . / versions / master / doxygen / storage_8h_source.html
blob: 796439c434a40eacabab8768265ad89d81f5c967 [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: include/mxnet/storage.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">storage.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="storage_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef MXNET_STORAGE_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define MXNET_STORAGE_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="base_8h.html">./base.h</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span>mxnet {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1Storage.html">Storage</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html"> 22</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595"> 26</a></span>&#160; <span class="keywordtype">void</span>* <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">dptr</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0"> 30</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">size</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8"> 34</a></span>&#160; <a class="code" href="structmxnet_1_1Context.html">Context</a> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">ctx</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; };</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">virtual</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> <a class="code" href="classmxnet_1_1Storage.html#aaa387e9ae8d66a63438543d640f6cfff">Alloc</a>(<span class="keywordtype">size_t</span> size, <a class="code" href="structmxnet_1_1Context.html">Context</a> ctx) = 0;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">Free</a>(<a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle) = 0;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">DirectFree</a>(<a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle) = 0;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a"> 61</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">~Storage</a>() {}</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Storage.html">Storage</a>* <a class="code" href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">Get</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">static</span> std::shared_ptr&lt;Storage&gt; <a class="code" href="classmxnet_1_1Storage.html#a4c5e9c239447ee223ab912716d53d7c7">_GetSharedRef</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}; <span class="comment">// class Storage</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;} <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="preprocessor">#endif // MXNET_STORAGE_H_</span></div>
<div class="ttc" id="classmxnet_1_1Storage_html_a098f8ebacd25f5203b2dc4c1796aec64"><div class="ttname"><a href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">mxnet::Storage::DirectFree</a></div><div class="ttdeci">virtual void DirectFree(Handle handle)=0</div><div class="ttdoc">Free storage directly, without putting it into memory pool. This can synchronization of all previous ...</div></div>
<div class="ttc" id="classmxnet_1_1Storage_html_a4c5e9c239447ee223ab912716d53d7c7"><div class="ttname"><a href="classmxnet_1_1Storage.html#a4c5e9c239447ee223ab912716d53d7c7">mxnet::Storage::_GetSharedRef</a></div><div class="ttdeci">static std::shared_ptr&lt; Storage &gt; _GetSharedRef()</div><div class="ttdoc">Get shared pointer reference to storage singleton. Most user should not call this function...</div></div>
<div class="ttc" id="classmxnet_1_1Storage_html"><div class="ttname"><a href="classmxnet_1_1Storage.html">mxnet::Storage</a></div><div class="ttdoc">Storage manager across multiple devices. </div><div class="ttdef"><b>Definition:</b> storage.h:17</div></div>
<div class="ttc" id="classmxnet_1_1Storage_html_af1e1bfea9236ccfba64344226416b04a"><div class="ttname"><a href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">mxnet::Storage::~Storage</a></div><div class="ttdeci">virtual ~Storage()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> storage.h:61</div></div>
<div class="ttc" id="classmxnet_1_1Storage_html_a5bdbd7b3ab712cd9e087ab007bdc64dd"><div class="ttname"><a href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">mxnet::Storage::Free</a></div><div class="ttdeci">virtual void Free(Handle handle)=0</div><div class="ttdoc">Free storage. </div></div>
<div class="ttc" id="structmxnet_1_1Storage_1_1Handle_html_a428e25a6317e50c8b55307c96f8ec595"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">mxnet::Storage::Handle::dptr</a></div><div class="ttdeci">void * dptr</div><div class="ttdoc">Pointer to the data. </div><div class="ttdef"><b>Definition:</b> storage.h:26</div></div>
<div class="ttc" id="structmxnet_1_1Storage_1_1Handle_html_ae0a4202582aa12a598f5c55ef51ad4c8"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">mxnet::Storage::Handle::ctx</a></div><div class="ttdeci">Context ctx</div><div class="ttdoc">Context information about device and ID. </div><div class="ttdef"><b>Definition:</b> storage.h:34</div></div>
<div class="ttc" id="classmxnet_1_1Storage_html_aaa387e9ae8d66a63438543d640f6cfff"><div class="ttname"><a href="classmxnet_1_1Storage.html#aaa387e9ae8d66a63438543d640f6cfff">mxnet::Storage::Alloc</a></div><div class="ttdeci">virtual Handle Alloc(size_t size, Context ctx)=0</div><div class="ttdoc">Allocate a new contiguous memory for a given size. </div></div>
<div class="ttc" id="classmxnet_1_1Storage_html_a96abc072908d72d3271360a7e3e4bbc2"><div class="ttname"><a href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">mxnet::Storage::Get</a></div><div class="ttdeci">static Storage * Get()</div></div>
<div class="ttc" id="structmxnet_1_1Storage_1_1Handle_html"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html">mxnet::Storage::Handle</a></div><div class="ttdoc">Storage handle. </div><div class="ttdef"><b>Definition:</b> storage.h:22</div></div>
<div class="ttc" id="base_8h_html"><div class="ttname"><a href="base_8h.html">base.h</a></div><div class="ttdoc">configuation of mxnet as well as basic data structure. </div></div>
<div class="ttc" id="structmxnet_1_1Storage_1_1Handle_html_ab93b9db0c83e4ef3803fb587377a74a0"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">mxnet::Storage::Handle::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Size of the storage. </div><div class="ttdef"><b>Definition:</b> storage.h:30</div></div>
<div class="ttc" id="structmxnet_1_1Context_html"><div class="ttname"><a href="structmxnet_1_1Context.html">mxnet::Context</a></div><div class="ttdoc">Context information about the execution environment. </div><div class="ttdef"><b>Definition:</b> base.h:116</div></div>
</div><!-- fragment --></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>