blob: 5cee2553aa68263e032569c57a834b4f1219c7be [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: /work/mxnet/include/mxnet/runtime/memory.h File 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li><li class="navelem"><a class="el" href="dir_8e7a93613ef4c7e7d673effa691c1739.html">runtime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">memory.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Runtime memory management.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cstdlib&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &quot;<a class="el" href="object_8h_source.html">object.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for memory.h:</div>
<div class="dyncontent">
<div class="center"><img src="include_2mxnet_2runtime_2memory_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2memory_8h" alt=""/></div>
<map name="_2work_2mxnet_2include_2mxnet_2runtime_2memory_8h" id="_2work_2mxnet_2include_2mxnet_2runtime_2memory_8h">
<area shape="rect" id="node5" href="object_8h.html" title="A managed object in MXNet runtime. " alt="" coords="255,95,330,121"/>
<area shape="rect" id="node8" href="c__runtime__api_8h.html" title="c_runtime_api.h" alt="" coords="229,169,356,196"/>
<area shape="rect" id="node9" href="dlpack_8h.html" title="The common header of DLPack. " alt="" coords="280,244,404,271"/>
<area shape="rect" id="node12" href="include_2mxnet_2c__api_8h.html" title="mxnet/c_api.h" alt="" coords="90,244,205,271"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="include_2mxnet_2runtime_2memory_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2memory_8hdep" alt=""/></div>
<map name="_2work_2mxnet_2include_2mxnet_2runtime_2memory_8hdep" id="_2work_2mxnet_2include_2mxnet_2runtime_2memory_8hdep">
<area shape="rect" id="node2" href="ffi__helper_8h.html" title="/work/mxnet/include\l/mxnet/runtime/ffi_helper.h" alt="" coords="119,273,317,315"/>
<area shape="rect" id="node25" href="include_2mxnet_2node_2node_8h.html" title="/work/mxnet/include\l/mxnet/node/node.h" alt="" coords="314,95,469,136"/>
<area shape="rect" id="node29" href="runtime_2container_8h.html" title="/work/mxnet/include\l/mxnet/runtime/container.h" alt="" coords="5,184,204,225"/>
<area shape="rect" id="node3" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="213,720,388,776"/>
<area shape="rect" id="node6" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="327,363,482,404"/>
<area shape="rect" id="node4" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="207,824,394,865"/>
<area shape="rect" id="node5" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="221,913,380,955"/>
<area shape="rect" id="node7" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="881,452,1035,493"/>
<area shape="rect" id="node8" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="658,541,813,583"/>
<area shape="rect" id="node9" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="601,631,755,672"/>
<area shape="rect" id="node10" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1365,913,1519,955"/>
<area shape="rect" id="node11" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="989,727,1162,769"/>
<area shape="rect" id="node12" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="1365,824,1519,865"/>
<area shape="rect" id="node13" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="1596,913,1763,955"/>
<area shape="rect" id="node18" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="810,727,965,769"/>
<area shape="rect" id="node20" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="1325,631,1479,672"/>
<area shape="rect" id="node21" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="429,541,583,583"/>
<area shape="rect" id="node22" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="1301,541,1503,583"/>
<area shape="rect" id="node23" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="938,541,1093,583"/>
<area shape="rect" id="node24" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="1117,541,1277,583"/>
<area shape="rect" id="node16" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="667,1003,855,1044"/>
<area shape="rect" id="node15" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="798,913,953,955"/>
<area shape="rect" id="node19" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="479,727,634,769"/>
<area shape="rect" id="node14" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="882,824,1077,865"/>
<area shape="rect" id="node17" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="667,1092,855,1133"/>
<area shape="rect" id="node26" href="node_2container_8h.html" title="/work/mxnet/include\l/mxnet/node/container.h" alt="" coords="301,184,481,225"/>
<area shape="rect" id="node27" href="expr_8h.html" title="Base expr nodes in MXNet. " alt="" coords="442,273,597,315"/>
<area shape="rect" id="node28" href="expr__operator_8h.html" title="Common operators defined for Expr. " alt="" coords="557,363,732,404"/>
</map>
</div>
</div>
<p><a href="include_2mxnet_2runtime_2memory_8h_source.html">Go to the source code of this file.</a></p>
<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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">mxnet::runtime::ObjAllocatorBase&lt; Derived &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class of object allocators that implements make. Use curiously recurring template pattern. <a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">mxnet::runtime::SimpleObjAllocator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html">mxnet::runtime::SimpleObjAllocator::Handler&lt; T &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html">mxnet::runtime::SimpleObjAllocator::ArrayHandler&lt; ArrayType, ElemType &gt;</a></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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemxnet"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemxnet_1_1runtime"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1runtime.html">mxnet::runtime</a></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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae494b840652fdcee82babd1e3c71e629"><td class="memTemplParams" colspan="2">template&lt;typename T , typename... Args&gt; </td></tr>
<tr class="memitem:ae494b840652fdcee82babd1e3c71e629"><td class="memTemplItemLeft" align="right" valign="top">ObjectPtr&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629">mxnet::runtime::make_object</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:ae494b840652fdcee82babd1e3c71e629"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate an object using default allocator. <a href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629">More...</a><br /></td></tr>
<tr class="separator:ae494b840652fdcee82babd1e3c71e629"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac46e925eac8fa378c6362a3f61ae32ec"><td class="memTemplParams" colspan="2">template&lt;typename ArrayType , typename ElemType , typename... Args&gt; </td></tr>
<tr class="memitem:ac46e925eac8fa378c6362a3f61ae32ec"><td class="memTemplItemLeft" align="right" valign="top">ObjectPtr&lt; ArrayType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1runtime.html#ac46e925eac8fa378c6362a3f61ae32ec">mxnet::runtime::make_inplace_array_object</a> (size_t num_elems, Args &amp;&amp;... args)</td></tr>
<tr class="separator:ac46e925eac8fa378c6362a3f61ae32ec"><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>Runtime memory management. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 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>