Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / array__view_8h_source.html
blob: c77c52e62dc73673b9b04925e3a1b10da16eb514 [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/3rdparty/dmlc-core/include/dmlc/array_view.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_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">array_view.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="array__view_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;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef DMLC_ARRAY_VIEW_H_</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define DMLC_ARRAY_VIEW_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;array&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="namespacedmlc.html"> 12</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> ValueType&gt;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html"> 36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1array__view.html">array_view</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classdmlc_1_1array__view.html#aa2989cb96ead82941ca708f982eb1ecb">array_view</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classdmlc_1_1array__view.html#aa2989cb96ead82941ca708f982eb1ecb">array_view</a>(<span class="keyword">const</span> <a class="code" href="classdmlc_1_1array__view.html">array_view&lt;ValueType&gt;</a> &amp;other) = <span class="keywordflow">default</span>; <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#ifndef _MSC_VER</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="classdmlc_1_1array__view.html#aa2989cb96ead82941ca708f982eb1ecb">array_view</a>(<a class="code" href="classdmlc_1_1array__view.html">array_view&lt;ValueType&gt;</a>&amp;&amp; other) = <span class="keywordflow">default</span>; <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classdmlc_1_1array__view.html#aa2989cb96ead82941ca708f982eb1ecb">array_view</a>(<a class="code" href="classdmlc_1_1array__view.html">array_view&lt;ValueType&gt;</a>&amp;&amp; other) { <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; begin_ = other.begin_;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; size_ = other.size_;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; other.begin_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="classdmlc_1_1array__view.html">array_view&lt;ValueType&gt;</a>&amp; <a class="code" href="classdmlc_1_1array__view.html#a41d5a5be90fb8113b54abf924b0ef3c0">operator=</a>(<span class="keyword">const</span> <a class="code" href="classdmlc_1_1array__view.html">array_view&lt;ValueType&gt;</a>&amp; other) = <span class="keywordflow">default</span>; <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#a307c58c244afdeda8abd5597b8d7ddc4"> 72</a></span>&#160;<span class="comment"></span> <a class="code" href="classdmlc_1_1array__view.html#a307c58c244afdeda8abd5597b8d7ddc4">array_view</a>(<span class="keyword">const</span> std::vector&lt;ValueType&gt;&amp; other) { <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">if</span> (other.size() != 0) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; begin_ = &amp;other[0]; size_ = other.size();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">template</span>&lt;std::<span class="keywordtype">size_t</span> size&gt;</div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#ae3f605a722b266dfcac991964fb74f7c"> 82</a></span>&#160; <a class="code" href="classdmlc_1_1array__view.html#ae3f605a722b266dfcac991964fb74f7c">array_view</a>(<span class="keyword">const</span> std::array&lt;ValueType, size&gt;&amp; other) { <span class="comment">// NOLINT(*)</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classdmlc_1_1array__view.html#af5ba06a92acbd6425bc86a6e7843c99d">size</a> != 0) {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; begin_ = &amp;other[0]; size_ = <a class="code" href="classdmlc_1_1array__view.html#af5ba06a92acbd6425bc86a6e7843c99d">size</a>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#a6d2423c90ee1c8adb1fab2be82a516e6"> 92</a></span>&#160; <a class="code" href="classdmlc_1_1array__view.html#a6d2423c90ee1c8adb1fab2be82a516e6">array_view</a>(<span class="keyword">const</span> ValueType* <a class="code" href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f">begin</a>, <span class="keyword">const</span> ValueType* <a class="code" href="classdmlc_1_1array__view.html#a368ee235e2e9587a06b30102b48450b6">end</a>) {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">if</span> (begin &lt; end) {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; begin_ = <a class="code" href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f">begin</a>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; size_ = end - <a class="code" href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f">begin</a>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#af5ba06a92acbd6425bc86a6e7843c99d"> 99</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classdmlc_1_1array__view.html#af5ba06a92acbd6425bc86a6e7843c99d">size</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> size_;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f"> 103</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> ValueType* <a class="code" href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f">begin</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">return</span> begin_;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#a368ee235e2e9587a06b30102b48450b6"> 107</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> ValueType* <a class="code" href="classdmlc_1_1array__view.html#a368ee235e2e9587a06b30102b48450b6">end</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">return</span> begin_ + size_;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classdmlc_1_1array__view.html#ac5dd843df7f5aa2c6ce3cbd13d12f42d"> 115</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> ValueType&amp; <a class="code" href="classdmlc_1_1array__view.html#ac5dd843df7f5aa2c6ce3cbd13d12f42d">operator[]</a>(<span class="keywordtype">size_t</span> i)<span class="keyword"> const </span>{</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">return</span> begin_[i];</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">const</span> ValueType* begin_{<span class="keyword">nullptr</span>};</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">size_t</span> size_{0};</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;};</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;} <span class="comment">// namespace dmlc</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="preprocessor">#endif // DMLC_ARRAY_VIEW_H_</span></div><div class="ttc" id="classdmlc_1_1array__view_html"><div class="ttname"><a href="classdmlc_1_1array__view.html">dmlc::array_view</a></div><div class="ttdoc">Read only data structure to reference continuous memory region of array. Provide unified view for vec...</div><div class="ttdef"><b>Definition:</b> array_view.h:36</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_a40cb7a315bd0ae1db67bb1d8eadbc66f"><div class="ttname"><a href="classdmlc_1_1array__view.html#a40cb7a315bd0ae1db67bb1d8eadbc66f">dmlc::array_view::begin</a></div><div class="ttdeci">const ValueType * begin() const</div><div class="ttdef"><b>Definition:</b> array_view.h:103</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_a6d2423c90ee1c8adb1fab2be82a516e6"><div class="ttname"><a href="classdmlc_1_1array__view.html#a6d2423c90ee1c8adb1fab2be82a516e6">dmlc::array_view::array_view</a></div><div class="ttdeci">array_view(const ValueType *begin, const ValueType *end)</div><div class="ttdoc">construct array view from continuous segment </div><div class="ttdef"><b>Definition:</b> array_view.h:92</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_a307c58c244afdeda8abd5597b8d7ddc4"><div class="ttname"><a href="classdmlc_1_1array__view.html#a307c58c244afdeda8abd5597b8d7ddc4">dmlc::array_view::array_view</a></div><div class="ttdeci">array_view(const std::vector&lt; ValueType &gt; &amp;other)</div><div class="ttdoc">construct array view std::vector </div><div class="ttdef"><b>Definition:</b> array_view.h:72</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_ac5dd843df7f5aa2c6ce3cbd13d12f42d"><div class="ttname"><a href="classdmlc_1_1array__view.html#ac5dd843df7f5aa2c6ce3cbd13d12f42d">dmlc::array_view::operator[]</a></div><div class="ttdeci">const ValueType &amp; operator[](size_t i) const</div><div class="ttdoc">get i-th element from the view </div><div class="ttdef"><b>Definition:</b> array_view.h:115</div></div>
<div class="ttc" id="namespacedmlc_html"><div class="ttname"><a href="namespacedmlc.html">dmlc</a></div><div class="ttdoc">namespace for dmlc </div><div class="ttdef"><b>Definition:</b> array_view.h:12</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_aa2989cb96ead82941ca708f982eb1ecb"><div class="ttname"><a href="classdmlc_1_1array__view.html#aa2989cb96ead82941ca708f982eb1ecb">dmlc::array_view::array_view</a></div><div class="ttdeci">array_view()=default</div><div class="ttdoc">default constructor </div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_af5ba06a92acbd6425bc86a6e7843c99d"><div class="ttname"><a href="classdmlc_1_1array__view.html#af5ba06a92acbd6425bc86a6e7843c99d">dmlc::array_view::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdef"><b>Definition:</b> array_view.h:99</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_ae3f605a722b266dfcac991964fb74f7c"><div class="ttname"><a href="classdmlc_1_1array__view.html#ae3f605a722b266dfcac991964fb74f7c">dmlc::array_view::array_view</a></div><div class="ttdeci">array_view(const std::array&lt; ValueType, size &gt; &amp;other)</div><div class="ttdoc">construct array std::array </div><div class="ttdef"><b>Definition:</b> array_view.h:82</div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_a41d5a5be90fb8113b54abf924b0ef3c0"><div class="ttname"><a href="classdmlc_1_1array__view.html#a41d5a5be90fb8113b54abf924b0ef3c0">dmlc::array_view::operator=</a></div><div class="ttdeci">array_view&lt; ValueType &gt; &amp; operator=(const array_view&lt; ValueType &gt; &amp;other)=default</div><div class="ttdoc">default assign constructor </div></div>
<div class="ttc" id="classdmlc_1_1array__view_html_a368ee235e2e9587a06b30102b48450b6"><div class="ttname"><a href="classdmlc_1_1array__view.html#a368ee235e2e9587a06b30102b48450b6">dmlc::array_view::end</a></div><div class="ttdeci">const ValueType * end() const</div><div class="ttdef"><b>Definition:</b> array_view.h:107</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:41 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>