blob: 857c5efd4b808ce04188693e96346eff7fa69262 [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 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: mxnet::common::StaticArray&lt; T, num &gt; Struct Template Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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="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> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<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 alt="Collaboration graph" border="0" src="structmxnet_1_1common_1_1StaticArray__coll__graph.png" usemap="#mxnet_1_1common_1_1StaticArray_3_01T_00_01num_01_4_coll__map"/></div>
<map id="mxnet_1_1common_1_1StaticArray_3_01T_00_01num_01_4_coll__map" name="mxnet_1_1common_1_1StaticArray_3_01T_00_01num_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:a1c3a79ddcb6b472f1a903f1753f4194a"><td align="right" class="memItemLeft" valign="top">MSHADOW_XINLINE </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"> </td><td class="mdescRight">default constructor, do nothing <a href="#a1c3a79ddcb6b472f1a903f1753f4194a">More...</a><br/></td></tr>
<tr class="separator:a1c3a79ddcb6b472f1a903f1753f4194a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a857e64b386ca8e0bfab5087a42ae2f53"><td align="right" class="memItemLeft" valign="top">MSHADOW_XINLINE </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"> </td><td class="mdescRight">constructor, fill in the array with the input value <a href="#a857e64b386ca8e0bfab5087a42ae2f53">More...</a><br/></td></tr>
<tr class="separator:a857e64b386ca8e0bfab5087a42ae2f53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb2f84b9e5f856fed4435c3d5f0ef044"><td align="right" class="memItemLeft" valign="top">MSHADOW_XINLINE </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"> </td><td class="mdescRight">constuctor <a href="#abb2f84b9e5f856fed4435c3d5f0ef044">More...</a><br/></td></tr>
<tr class="separator:abb2f84b9e5f856fed4435c3d5f0ef044"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73ee83769fb76d465481097f572252ce"><td align="right" class="memItemLeft" valign="top">MSHADOW_XINLINE T &amp; </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"> </td></tr>
<tr class="memitem:a82f141a5e77df93e2082866165e95e4e"><td align="right" class="memItemLeft" valign="top">MSHADOW_XINLINE const T &amp; </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1StaticArray.html#a82f141a5e77df93e2082866165e95e4e">operator[]</a> (const <a class="el" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a> idx) const </td></tr>
<tr class="separator:a82f141a5e77df93e2082866165e95e4e"><td class="memSeparator" colspan="2"> </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 align="right" class="memItemLeft" valign="top"></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"> </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 align="right" class="memItemLeft" valign="top">static const int </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"> </td></tr>
</table>
<a id="details" name="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 class="anchor" id="a1c3a79ddcb6b472f1a903f1753f4194a"></a>
<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">MSHADOW_XINLINE <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 </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 class="anchor" id="a857e64b386ca8e0bfab5087a42ae2f53"></a>
<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">MSHADOW_XINLINE <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; </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 class="anchor" id="abb2f84b9e5f856fed4435c3d5f0ef044"></a>
<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">MSHADOW_XINLINE <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; </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 class="anchor" id="a73ee83769fb76d465481097f572252ce"></a>
<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">MSHADOW_XINLINE 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> </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 class="anchor" id="a82f141a5e77df93e2082866165e95e4e"></a>
<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">MSHADOW_XINLINE const 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> </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 class="anchor" id="a2b48c2aff03cc1c29306defddbca3649"></a>
<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 class="anchor" id="a12a35d1d843c258cc1dca2cf340d12f0"></a>
<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>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 Fri Feb 23 2018 12:20:48 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>