Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / structmxnet_1_1common_1_1StaticArray.html
blob: bb3ddaf6e2f9ff5b2f9fbd7f4c687242f2cb21de [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::common::StaticArray&lt; T, num &gt; Struct 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_1common.html">common</a></li><li class="navelem"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structmxnet_1_1common_1_1StaticArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::common::StaticArray&lt; T, num &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Static array. This code is borrowed from struct Shape&lt;ndim&gt;, except that users can specify the type of the elements of the statically allocated array. The object instance of the struct is copyable between CPU and GPU.
<a href="structmxnet_1_1common_1_1StaticArray.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="static__array_8h_source.html">static_array.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::common::StaticArray&lt; T, num &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structmxnet_1_1common_1_1StaticArray__coll__graph.png" border="0" usemap="#mxnet_1_1common_1_1StaticArray_3_01T_00_01num_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:a1c3a79ddcb6b472f1a903f1753f4194a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a1c3a79ddcb6b472f1a903f1753f4194a">StaticArray</a> (void)</td></tr>
<tr class="memdesc:a1c3a79ddcb6b472f1a903f1753f4194a"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor, do nothing <a href="structmxnet_1_1common_1_1StaticArray.html#a1c3a79ddcb6b472f1a903f1753f4194a">More...</a><br /></td></tr>
<tr class="separator:a1c3a79ddcb6b472f1a903f1753f4194a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a857e64b386ca8e0bfab5087a42ae2f53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a857e64b386ca8e0bfab5087a42ae2f53">StaticArray</a> (const T &amp;val)</td></tr>
<tr class="memdesc:a857e64b386ca8e0bfab5087a42ae2f53"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor, fill in the array with the input value <a href="structmxnet_1_1common_1_1StaticArray.html#a857e64b386ca8e0bfab5087a42ae2f53">More...</a><br /></td></tr>
<tr class="separator:a857e64b386ca8e0bfab5087a42ae2f53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb2f84b9e5f856fed4435c3d5f0ef044"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#abb2f84b9e5f856fed4435c3d5f0ef044">StaticArray</a> (const <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a>&lt; T, num &gt; &amp;sa)</td></tr>
<tr class="memdesc:abb2f84b9e5f856fed4435c3d5f0ef044"><td class="mdescLeft">&#160;</td><td class="mdescRight">constuctor <a href="structmxnet_1_1common_1_1StaticArray.html#abb2f84b9e5f856fed4435c3d5f0ef044">More...</a><br /></td></tr>
<tr class="separator:abb2f84b9e5f856fed4435c3d5f0ef044"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73ee83769fb76d465481097f572252ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a73ee83769fb76d465481097f572252ce">operator[]</a> (const <a class="el" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a> idx)</td></tr>
<tr class="separator:a73ee83769fb76d465481097f572252ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab527caaf683fb4ad9f6fc375fdb4ae67"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#ab527caaf683fb4ad9f6fc375fdb4ae67">operator[]</a> (const <a class="el" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a> idx) const</td></tr>
<tr class="separator:ab527caaf683fb4ad9f6fc375fdb4ae67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2b48c2aff03cc1c29306defddbca3649"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a> [<a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">kNum</a>]</td></tr>
<tr class="separator:a2b48c2aff03cc1c29306defddbca3649"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a12a35d1d843c258cc1dca2cf340d12f0"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">kNum</a> = num</td></tr>
<tr class="separator:a12a35d1d843c258cc1dca2cf340d12f0"><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 T, int num&gt;<br />
struct mxnet::common::StaticArray&lt; T, num &gt;</h3>
<p>Static array. This code is borrowed from struct Shape&lt;ndim&gt;, except that users can specify the type of the elements of the statically allocated array. The object instance of the struct is copyable between CPU and GPU. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>element type of the array, must be copyable between CPU and GPU </td></tr>
<tr><td class="paramname">num</td><td>number of elements in the array </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1c3a79ddcb6b472f1a903f1753f4194a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c3a79ddcb6b472f1a903f1753f4194a">&#9670;&nbsp;</a></span>StaticArray() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::<a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a> </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>default constructor, do nothing </p>
</div>
</div>
<a id="a857e64b386ca8e0bfab5087a42ae2f53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a857e64b386ca8e0bfab5087a42ae2f53">&#9670;&nbsp;</a></span>StaticArray() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::<a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a> </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>val</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>constructor, fill in the array with the input value </p>
</div>
</div>
<a id="abb2f84b9e5f856fed4435c3d5f0ef044"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb2f84b9e5f856fed4435c3d5f0ef044">&#9670;&nbsp;</a></span>StaticArray() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::<a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a>&lt; T, num &gt; &amp;&#160;</td>
<td class="paramname"><em>sa</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>constuctor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a73ee83769fb76d465481097f572252ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73ee83769fb76d465481097f572252ce">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> T&amp; <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a>&#160;</td>
<td class="paramname"><em>idx</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">
</div>
</div>
<a id="ab527caaf683fb4ad9f6fc375fdb4ae67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab527caaf683fb4ad9f6fc375fdb4ae67">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> T&amp; <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a>&#160;</td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td> const</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 Data Documentation</h2>
<a id="a2b48c2aff03cc1c29306defddbca3649"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b48c2aff03cc1c29306defddbca3649">&#9670;&nbsp;</a></span>array_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::array_[<a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">kNum</a>]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a12a35d1d843c258cc1dca2cf340d12f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12a35d1d843c258cc1dca2cf340d12f0">&#9670;&nbsp;</a></span>kNum</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , int num&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a>&lt; T, num &gt;::kNum = num</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/src/common/<a class="el" href="static__array_8h_source.html">static_array.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>