blob: c5c755222effaea5d74e9289bfe757f3b8819ada [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::runtime::ObjAllocatorBase&lt; Derived &gt; Class Template 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="namespacemxnet_1_1runtime.html">runtime</a></li><li class="navelem"><a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">ObjAllocatorBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmxnet_1_1runtime_1_1ObjAllocatorBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::runtime::ObjAllocatorBase&lt; Derived &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class of object allocators that implements make. Use curiously recurring template pattern.
<a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="include_2mxnet_2runtime_2memory_8h_source.html">memory.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::runtime::ObjAllocatorBase&lt; Derived &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1runtime_1_1ObjAllocatorBase__coll__graph.png" border="0" usemap="#mxnet_1_1runtime_1_1ObjAllocatorBase_3_01Derived_01_4_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</div>
<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:aa5513f69a466de425c500600350aa5e6"><td class="memTemplParams" colspan="2">template&lt;typename T , typename... Args&gt; </td></tr>
<tr class="memitem:aa5513f69a466de425c500600350aa5e6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6">make_object</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:aa5513f69a466de425c500600350aa5e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make a new object using the allocator. <a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6">More...</a><br /></td></tr>
<tr class="separator:aa5513f69a466de425c500600350aa5e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae914a57fd55f72b586038c72f0005ba4"><td class="memTemplParams" colspan="2">template&lt;typename ArrayType , typename ElemType , typename... Args&gt; </td></tr>
<tr class="memitem:ae914a57fd55f72b586038c72f0005ba4"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt; ArrayType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#ae914a57fd55f72b586038c72f0005ba4">make_inplace_array</a> (size_t num_elems, Args &amp;&amp;... args)</td></tr>
<tr class="separator:ae914a57fd55f72b586038c72f0005ba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Derived&gt;<br />
class mxnet::runtime::ObjAllocatorBase&lt; Derived &gt;</h3>
<p>Base class of object allocators that implements make. Use curiously recurring template pattern. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Derived</td><td>The derived class. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae914a57fd55f72b586038c72f0005ba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae914a57fd55f72b586038c72f0005ba4">&#9670;&nbsp;</a></span>make_inplace_array()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename ArrayType , typename ElemType , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt;ArrayType&gt; <a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">mxnet::runtime::ObjAllocatorBase</a>&lt; Derived &gt;::make_inplace_array </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>num_elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ArrayType</td><td>The type to be allocated. </td></tr>
<tr><td class="paramname">ElemType</td><td>The type of array element. </td></tr>
<tr><td class="paramname">Args</td><td>The constructor signature. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num_elems</td><td>The number of array elements. </td></tr>
<tr><td class="paramname">args</td><td>The arguments. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa5513f69a466de425c500600350aa5e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5513f69a466de425c500600350aa5e6">&#9670;&nbsp;</a></span>make_object()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename T , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr</a>&lt;T&gt; <a class="el" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">mxnet::runtime::ObjAllocatorBase</a>&lt; Derived &gt;::make_object </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Make a new object using the allocator. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to be allocated. </td></tr>
<tr><td class="paramname">Args</td><td>The constructor signature. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>The arguments. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/runtime/<a class="el" href="include_2mxnet_2runtime_2memory_8h_source.html">memory.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>