-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathStridedIterator_8h_source.html
More file actions
175 lines (173 loc) · 17.2 KB
/
Copy pathStridedIterator_8h_source.html
File metadata and controls
175 lines (173 loc) · 17.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ndarray: /home/runner/work/ndarray/ndarray/include/ndarray/detail/StridedIterator.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 id="projectrow">
<td id="projectalign">
<div id="projectname">ndarray
</div>
<div id="projectbrief">NumPy-friendly multidimensional arrays in C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_ac74797f0b787ddb83590f17abce6693.html">ndarray</a></li><li class="navelem"><a class="el" href="dir_a77cade9321fd3104f77bb58a6231bfa.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">StridedIterator.h</div></div>
</div><!--header-->
<div class="contents">
<a href="StridedIterator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2010-2012, Jim Bosch</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * All rights reserved.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * ndarray is distributed under a simple BSD-like license;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * see the LICENSE file that should be present in the root</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * of the source distribution, or alternately available at:</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * https://github.com/ndarray/ndarray</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> */</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef NDARRAY_DETAIL_StridedIterator_h_INCLUDED</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define NDARRAY_DETAIL_StridedIterator_h_INCLUDED</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "<a class="code" href="ndarray__fwd_8h.html">ndarray_fwd.h</a>"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <boost/iterator/iterator_facade.hpp></span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">namespace </span>ndarray {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classndarray_1_1detail_1_1StridedIterator.html"> 32</a></span><span class="keyword">class </span><a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a> : <span class="keyword">public</span> boost::iterator_facade<</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> StridedIterator<T>, </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> T, boost::random_access_traversal_tag</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">typedef</span> T Value;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">typedef</span> T & Reference;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a>() : _data(0), _stride(0) {}</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a>(T * data, Offset stride) : _data(data), _stride(stride) {}</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a>(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a> <span class="keyword">const</span> & other) : _data(other._data), _stride(other._stride) {}</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">template</span> <<span class="keyword">typename</span> U></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a>(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator<U></a> <span class="keyword">const</span> & other) : _data(other._data), _stride(other._stride) {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> BOOST_STATIC_ASSERT((boost::is_convertible<U*,T*>::value));</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a> & operator=(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a> <span class="keyword">const</span> & other) {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">if</span> (&other != <span class="keyword">this</span>) {</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> _data = other._data;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> _stride = other._stride;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">template</span> <<span class="keyword">typename</span> U></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a> & operator=(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator<U></a> <span class="keyword">const</span> & other) {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> BOOST_STATIC_ASSERT((boost::is_convertible<U*,T*>::value));</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> _data = other._data;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> _stride = other._stride;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">friend</span> <span class="keyword">class </span>boost::iterator_core_access;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">template</span> <<span class="keyword">typename</span> OtherT> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator</a>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> Reference dereference()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *_data; }</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span> increment() { _data += _stride; }</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">void</span> decrement() { _data -= _stride; }</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">void</span> advance(Offset n) { _data += _stride * n; }</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">template</span> <<span class="keyword">typename</span> U></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> Offset distance_to(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator<U></a> <span class="keyword">const</span> & other)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordflow">return</span> std::distance(_data, other._data) / _stride; </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> }</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">template</span> <<span class="keyword">typename</span> U></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">bool</span> equal(<a class="code hl_class" href="classndarray_1_1detail_1_1StridedIterator.html">StridedIterator<U></a> <span class="keyword">const</span> & other)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> _data == other._data;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> T * _data;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> Offset _stride;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>};</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>} <span class="comment">// namespace ndarray</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="preprocessor">#endif </span><span class="comment">// !NDARRAY_DETAIL_StridedIterator_h_INCLUDED</span></div>
<div class="ttc" id="aclassndarray_1_1detail_1_1StridedIterator_html"><div class="ttname"><a href="classndarray_1_1detail_1_1StridedIterator.html">ndarray::detail::StridedIterator</a></div><div class="ttdef"><b>Definition</b> StridedIterator.h:36</div></div>
<div class="ttc" id="andarray__fwd_8h_html"><div class="ttname"><a href="ndarray__fwd_8h.html">ndarray_fwd.h</a></div><div class="ttdoc">Forward declarations and default template parameters for ndarray.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 21 2023 03:04:30 for ndarray by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>