blob: b63a171d77d30cb426601cdf1216436632b8e918 [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: mxnet::common::LazyAllocArray&lt; TElem &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.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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1common.html">common</a></li><li class="navelem"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">LazyAllocArray</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="classmxnet_1_1common_1_1LazyAllocArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::common::LazyAllocArray&lt; TElem &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="lazy__alloc__array_8h_source.html">lazy_alloc_array.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::common::LazyAllocArray&lt; TElem &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1common_1_1LazyAllocArray__coll__graph.png" border="0" usemap="#mxnet_1_1common_1_1LazyAllocArray_3_01TElem_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1common_1_1LazyAllocArray_3_01TElem_01_4_coll__map" id="mxnet_1_1common_1_1LazyAllocArray_3_01TElem_01_4_coll__map">
</map>
</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:a1dd703a9eabfe691793a8398706bcc09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html#a1dd703a9eabfe691793a8398706bcc09">LazyAllocArray</a> ()</td></tr>
<tr class="separator:a1dd703a9eabfe691793a8398706bcc09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4528ab581eda5b0aba35faa3687c201"><td class="memTemplParams" colspan="2">template&lt;typename FCreate &gt; </td></tr>
<tr class="memitem:ac4528ab581eda5b0aba35faa3687c201"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr&lt; TElem &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html#ac4528ab581eda5b0aba35faa3687c201">Get</a> (int index, FCreate creator)</td></tr>
<tr class="memdesc:ac4528ab581eda5b0aba35faa3687c201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get element of corresponding index, if it is not created create by creator. <a href="#ac4528ab581eda5b0aba35faa3687c201">More...</a><br /></td></tr>
<tr class="separator:ac4528ab581eda5b0aba35faa3687c201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43a89c8e7b4e1a09f346694073a2d998"><td class="memTemplParams" colspan="2">template&lt;typename FVisit &gt; </td></tr>
<tr class="memitem:a43a89c8e7b4e1a09f346694073a2d998"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html#a43a89c8e7b4e1a09f346694073a2d998">ForEach</a> (FVisit fvisit)</td></tr>
<tr class="memdesc:a43a89c8e7b4e1a09f346694073a2d998"><td class="mdescLeft">&#160;</td><td class="mdescRight">for each not null element of the array, call fvisit <a href="#a43a89c8e7b4e1a09f346694073a2d998">More...</a><br /></td></tr>
<tr class="separator:a43a89c8e7b4e1a09f346694073a2d998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3af1ab75feb0ba07db5af7e6ef5717b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html#a3af1ab75feb0ba07db5af7e6ef5717b1">Clear</a> ()</td></tr>
<tr class="memdesc:a3af1ab75feb0ba07db5af7e6ef5717b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear all the allocated elements in array <a href="#a3af1ab75feb0ba07db5af7e6ef5717b1">More...</a><br /></td></tr>
<tr class="separator:a3af1ab75feb0ba07db5af7e6ef5717b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1dd703a9eabfe691793a8398706bcc09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dd703a9eabfe691793a8398706bcc09">&#9670;&nbsp;</a></span>LazyAllocArray()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TElem &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">mxnet::common::LazyAllocArray</a>&lt; TElem &gt;::<a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">LazyAllocArray</a> </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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3af1ab75feb0ba07db5af7e6ef5717b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3af1ab75feb0ba07db5af7e6ef5717b1">&#9670;&nbsp;</a></span>Clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TElem &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">mxnet::common::LazyAllocArray</a>&lt; TElem &gt;::Clear </td>
<td>(</td>
<td class="paramtype">void&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>clear all the allocated elements in array </p>
</div>
</div>
<a id="a43a89c8e7b4e1a09f346694073a2d998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43a89c8e7b4e1a09f346694073a2d998">&#9670;&nbsp;</a></span>ForEach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TElem &gt; </div>
<div class="memtemplate">
template&lt;typename FVisit &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">mxnet::common::LazyAllocArray</a>&lt; TElem &gt;::ForEach </td>
<td>(</td>
<td class="paramtype">FVisit&#160;</td>
<td class="paramname"><em>fvisit</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>for each not null element of the array, call fvisit </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fvisit</td><td>a function of (size_t, TElem*) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac4528ab581eda5b0aba35faa3687c201"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4528ab581eda5b0aba35faa3687c201">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TElem &gt; </div>
<div class="memtemplate">
template&lt;typename FCreate &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; TElem &gt; <a class="el" href="classmxnet_1_1common_1_1LazyAllocArray.html">mxnet::common::LazyAllocArray</a>&lt; TElem &gt;::Get </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FCreate&#160;</td>
<td class="paramname"><em>creator</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">
<p>Get element of corresponding index, if it is not created create by creator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>the array index position </td></tr>
<tr><td class="paramname">creator</td><td>a lambda function to create new element when needed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/src/common/<a class="el" href="lazy__alloc__array_8h_source.html">lazy_alloc_array.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:44 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>