Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / static__array_8h_source.html
blob: 8c7666f22622a24d5d90aa3567dc6fb8db79f3bc [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: /work/mxnet/src/common/static_array.h Source File</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="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>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<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>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<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>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef MXNET_COMMON_STATIC_ARRAY_H_</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define MXNET_COMMON_STATIC_ARRAY_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html">mshadow/base.h</a>&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span>common {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<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>&#160;<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>&#160; <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>&#160;</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>&#160; 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>&#160;</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>&#160; <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <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>&#160;</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>&#160; <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <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>&#160;<span class="preprocessor"> #pragma unroll</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <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>&#160; this-&gt;array_[i] = val;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</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>&#160; <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <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>&#160;<span class="preprocessor"> #pragma unroll</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <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>&#160; this-&gt;array_[i] = sa[i];</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</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>&#160; <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> 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>&#160; <span class="keywordflow">return</span> array_[idx];</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1StaticArray.html#a0ad9c934ff3b0ba5643ecf7cb8cacf53"> 68</a></span>&#160; <a class="code" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <span class="keyword">const</span> T&amp; <a class="code" href="structmxnet_1_1common_1_1StaticArray.html#a0ad9c934ff3b0ba5643ecf7cb8cacf53">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>&#160; <span class="keywordflow">return</span> array_[idx];</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}; <span class="comment">// StaticArray</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace common</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<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="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> api_registry.h:33</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="3rdparty_2mshadow_2mshadow_2base_8h_html_af205b8ab4d8733133d590df7d2639d69"><div class="ttname"><a href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a></div><div class="ttdeci">#define MSHADOW_XINLINE</div><div class="ttdef"><b>Definition:</b> base.h:230</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"><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:94</div></div>
<div class="ttc" id="structmxnet_1_1common_1_1StaticArray_html_a0ad9c934ff3b0ba5643ecf7cb8cacf53"><div class="ttname"><a href="structmxnet_1_1common_1_1StaticArray.html#a0ad9c934ff3b0ba5643ecf7cb8cacf53">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="3rdparty_2mshadow_2mshadow_2base_8h_html"><div class="ttname"><a href="3rdparty_2mshadow_2mshadow_2base_8h.html">base.h</a></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 Thu Jan 5 2023 00:58:42 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>