blob: f933a5019ecde82a754dcf25cfeee5e8f331151c [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: src/common/static_array.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File 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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">static_array.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="static__array_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef MXNET_COMMON_STATIC_ARRAY_H_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_COMMON_STATIC_ARRAY_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include &lt;mshadow/base.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>mxnet {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>common {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keywordtype">int</span> num&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0"> 41</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">kNum</a> = num;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649"> 43</a></span>  T <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a>[<a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">kNum</a>];</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a1c3a79ddcb6b472f1a903f1753f4194a"> 46</a></span>  MSHADOW_XINLINE <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a1c3a79ddcb6b472f1a903f1753f4194a">StaticArray</a>(<span class="keywordtype">void</span>) {}</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a857e64b386ca8e0bfab5087a42ae2f53"> 49</a></span>  MSHADOW_XINLINE <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a857e64b386ca8e0bfab5087a42ae2f53">StaticArray</a>(<span class="keyword">const</span> T&amp; val) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> #pragma unroll</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; num; ++i) {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  this-&gt;<a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a>[i] = val;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#abb2f84b9e5f856fed4435c3d5f0ef044"> 57</a></span>  MSHADOW_XINLINE <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#abb2f84b9e5f856fed4435c3d5f0ef044">StaticArray</a>(<span class="keyword">const</span> <a class="code" href="structmxnet_1_1common_1_1StaticArray.html">StaticArray&lt;T, num&gt;</a>&amp; sa) {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> #pragma unroll</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"></span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; num; ++i) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  this-&gt;<a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a>[i] = sa[i];</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a73ee83769fb76d465481097f572252ce"> 64</a></span>  MSHADOW_XINLINE T&amp; <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a73ee83769fb76d465481097f572252ce">operator[]</a>(<span class="keyword">const</span> <a class="code" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a> idx) {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a>[idx];</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a82f141a5e77df93e2082866165e95e4e"> 68</a></span>  MSHADOW_XINLINE <span class="keyword">const</span> T&amp; <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a82f141a5e77df93e2082866165e95e4e">operator[]</a>(<span class="keyword">const</span> <a class="code" href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">index_t</a> idx)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">array_</a>[idx];</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }; <span class="comment">// StaticArray</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace common</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> } <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif // MXNET_COMMON_STATIC_ARRAY_H_</span></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a2b48c2aff03cc1c29306defddbca3649"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a2b48c2aff03cc1c29306defddbca3649">mxnet::common::StaticArray::array_</a></div><div class="ttdeci">T array_[kNum]</div><div class="ttdef"><b>Definition:</b> static_array.h:43</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_abb2f84b9e5f856fed4435c3d5f0ef044"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#abb2f84b9e5f856fed4435c3d5f0ef044">mxnet::common::StaticArray::StaticArray</a></div><div class="ttdeci">MSHADOW_XINLINE StaticArray(const StaticArray&lt; T, num &gt; &amp;sa)</div><div class="ttdoc">constuctor </div><div class="ttdef"><b>Definition:</b> static_array.h:57</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a857e64b386ca8e0bfab5087a42ae2f53"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a857e64b386ca8e0bfab5087a42ae2f53">mxnet::common::StaticArray::StaticArray</a></div><div class="ttdeci">MSHADOW_XINLINE StaticArray(const T &amp;val)</div><div class="ttdoc">constructor, fill in the array with the input value </div><div class="ttdef"><b>Definition:</b> static_array.h:49</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a12a35d1d843c258cc1dca2cf340d12f0"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a12a35d1d843c258cc1dca2cf340d12f0">mxnet::common::StaticArray::kNum</a></div><div class="ttdeci">static const int kNum</div><div class="ttdef"><b>Definition:</b> static_array.h:41</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a82f141a5e77df93e2082866165e95e4e"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a82f141a5e77df93e2082866165e95e4e">mxnet::common::StaticArray::operator[]</a></div><div class="ttdeci">MSHADOW_XINLINE const T &amp; operator[](const index_t idx) const </div><div class="ttdef"><b>Definition:</b> static_array.h:68</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html">mxnet::common::StaticArray</a></div><div class="ttdoc">Static array. This code is borrowed from struct Shape&lt;ndim&gt;, except that users can specify the type o...</div><div class="ttdef"><b>Definition:</b> static_array.h:40</div></div>
<div class="ttc" id="namespacemxnet_html_abadedc1b42ee3e5b8852e63783b982ef"><div class="ttname"><a href="namespacemxnet.html#abadedc1b42ee3e5b8852e63783b982ef">mxnet::index_t</a></div><div class="ttdeci">mshadow::index_t index_t</div><div class="ttdoc">index type usually use unsigned </div><div class="ttdef"><b>Definition:</b> base.h:133</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a73ee83769fb76d465481097f572252ce"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a73ee83769fb76d465481097f572252ce">mxnet::common::StaticArray::operator[]</a></div><div class="ttdeci">MSHADOW_XINLINE T &amp; operator[](const index_t idx)</div><div class="ttdef"><b>Definition:</b> static_array.h:64</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a1c3a79ddcb6b472f1a903f1753f4194a"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a1c3a79ddcb6b472f1a903f1753f4194a">mxnet::common::StaticArray::StaticArray</a></div><div class="ttdeci">MSHADOW_XINLINE StaticArray(void)</div><div class="ttdoc">default constructor, do nothing </div><div class="ttdef"><b>Definition:</b> static_array.h:46</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 01:41:23 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>