| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.6" name="generator"/> |
| <title>mxnet: include/mxnet/storage.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/search.js" type="text/javascript"></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 cellpadding="0" cellspacing="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 class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main 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 class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <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> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MXNET_STORAGE_H_</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_STORAGE_H_</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="base_8h.html">./base.h</a>"</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>mxnet {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1Storage.html">Storage</a> {</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595"> 44</a></span> <span class="keywordtype">void</span>* <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">dptr</a>{<span class="keyword">nullptr</span>};</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0"> 48</a></span> <span class="keywordtype">size_t</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">size</a>{0};</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8"> 52</a></span> <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="l00053"></a><span class="lineno"> 53</span> };</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <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="l00065"></a><span class="lineno"> 65</span> <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="l00075"></a><span class="lineno"> 75</span> <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="l00079"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a"> 79</a></span> <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">~Storage</a>() {}</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <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="l00092"></a><span class="lineno"> 92</span> <span class="keyword">static</span> std::shared_ptr<Storage> <a class="code" href="classmxnet_1_1Storage.html#a4c5e9c239447ee223ab912716d53d7c7">_GetSharedRef</a>();</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> }; <span class="comment">// class Storage</span></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } <span class="comment">// namespace mxnet</span></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <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< Storage > _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:35</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:79</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:44</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:52</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:40</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:48</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:141</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Oct 28 2017 08:21:17 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |
