-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassaf_1_1index.htm
More file actions
410 lines (378 loc) · 22.4 KB
/
classaf_1_1index.htm
File metadata and controls
410 lines (378 loc) · 22.4 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<!-- HTML header for doxygen 1.9.5-->
<!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>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-130950618-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-130950618-1');
</script>
<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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArrayFire: index Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="arrayfire.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
DoxygenAwesomeInteractiveToc.init()
DoxygenAwesomeFragmentCopyButton.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="2" cellpadding="2" width="100%">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><a href="index.htm"><img alt="Logo" src="arrayfire_logo.png"/></a></td>
</tr>
<tr id="projectrow">
<td>
<div id="projectbrief">A high-performance general-purpose compute library</div>
</td>
</tr>
<!--END !PROJECT_NAME-->
<div>
<td id="gsearch">
<script async src="https://cse.google.com/cse.js?cx=004356362924927882526:zup3ehe-7bs"></script>
<div class="gcse-search"></div>
</td>
</div>
</tr>
<tr>
<td>
<div id="togglediv"></div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="tutorials.htm"><span>Tutorials</span></a></li>
<li><a href="modules.htm"><span>Functions</span></a></li>
<li><a href="releasenotes.htm"><span>Release Notes</span></a></li>
<li><a href="examples.htm"><span>Examples</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classaf_1_1index.htm',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle"><div class="title">index Class Reference<div class="ingroups"><a class="el" href="group__arrayfire__class.htm">ArrayFire Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Wrapper for af_index.
<a href="classaf_1_1index.htm#details">More...</a></p>
<p><code>#include <<a class="el" href="index_8h_source.htm">index.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a149eb92716c1084a935e04a8d95f7347"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a149eb92716c1084a935e04a8d95f7347">index</a> ()</td></tr>
<tr class="memdesc:a149eb92716c1084a935e04a8d95f7347"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classaf_1_1index.htm#a149eb92716c1084a935e04a8d95f7347">More...</a><br /></td></tr>
<tr class="separator:a149eb92716c1084a935e04a8d95f7347"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2ca18df5addbd81bb476477e822bf2e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#aa2ca18df5addbd81bb476477e822bf2e">~index</a> ()</td></tr>
<tr class="separator:aa2ca18df5addbd81bb476477e822bf2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6e05022b3f52755fbdad4d7ac680d7f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#ab6e05022b3f52755fbdad4d7ac680d7f">index</a> (const int idx)</td></tr>
<tr class="memdesc:ab6e05022b3f52755fbdad4d7ac680d7f"><td class="mdescLeft"> </td><td class="mdescRight">Implicit int converter. <a href="classaf_1_1index.htm#ab6e05022b3f52755fbdad4d7ac680d7f">More...</a><br /></td></tr>
<tr class="separator:ab6e05022b3f52755fbdad4d7ac680d7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09a23c678003d2ebc82873b54198481e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a09a23c678003d2ebc82873b54198481e">index</a> (const <a class="el" href="classaf_1_1seq.htm">af::seq</a> &s0)</td></tr>
<tr class="memdesc:a09a23c678003d2ebc82873b54198481e"><td class="mdescLeft"> </td><td class="mdescRight">Implicit seq converter. <a href="classaf_1_1index.htm#a09a23c678003d2ebc82873b54198481e">More...</a><br /></td></tr>
<tr class="separator:a09a23c678003d2ebc82873b54198481e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b8cbe8d9768c6e57b953f6e3c298b1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a4b8cbe8d9768c6e57b953f6e3c298b1b">index</a> (const <a class="el" href="structaf__seq.htm">af_seq</a> &s0)</td></tr>
<tr class="memdesc:a4b8cbe8d9768c6e57b953f6e3c298b1b"><td class="mdescLeft"> </td><td class="mdescRight">Implicit seq converter. <a href="classaf_1_1index.htm#a4b8cbe8d9768c6e57b953f6e3c298b1b">More...</a><br /></td></tr>
<tr class="separator:a4b8cbe8d9768c6e57b953f6e3c298b1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18866c96649b856448272fbe723bb330"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a18866c96649b856448272fbe723bb330">index</a> (const <a class="el" href="classaf_1_1array.htm">af::array</a> &idx0)</td></tr>
<tr class="memdesc:a18866c96649b856448272fbe723bb330"><td class="mdescLeft"> </td><td class="mdescRight">Implicit int converter. <a href="classaf_1_1index.htm#a18866c96649b856448272fbe723bb330">More...</a><br /></td></tr>
<tr class="separator:a18866c96649b856448272fbe723bb330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a538f1bf60d71a8ab134e2d377e04534b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a538f1bf60d71a8ab134e2d377e04534b">index</a> (const <a class="el" href="classaf_1_1index.htm">index</a> &idx0)</td></tr>
<tr class="memdesc:a538f1bf60d71a8ab134e2d377e04534b"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classaf_1_1index.htm#a538f1bf60d71a8ab134e2d377e04534b">More...</a><br /></td></tr>
<tr class="separator:a538f1bf60d71a8ab134e2d377e04534b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7214c97cc66f572fd6e61ded0a188550"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a7214c97cc66f572fd6e61ded0a188550">isspan</a> () const</td></tr>
<tr class="memdesc:a7214c97cc66f572fd6e61ded0a188550"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the <a class="el" href="classaf_1_1index.htm">af::index</a> represents a <a class="el" href="namespaceaf.htm#af5c1188f38105afaf8b3f383492a1c9f" title="A special value representing the entire axis of an af::array.">af::span</a> object. <a href="classaf_1_1index.htm#a7214c97cc66f572fd6e61ded0a188550">More...</a><br /></td></tr>
<tr class="separator:a7214c97cc66f572fd6e61ded0a188550"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9e1817970c35053692542837c847330"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structaf__index__t.htm">af_index_t</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#af9e1817970c35053692542837c847330">get</a> () const</td></tr>
<tr class="memdesc:af9e1817970c35053692542837c847330"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying <a class="el" href="structaf__index__t.htm" title="Struct used to index an af_array.">af_index_t</a> object. <a href="classaf_1_1index.htm#af9e1817970c35053692542837c847330">More...</a><br /></td></tr>
<tr class="separator:af9e1817970c35053692542837c847330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89360d29df9ac98997d0348012460452"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaf_1_1index.htm">index</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classaf_1_1index.htm#a89360d29df9ac98997d0348012460452">operator=</a> (const <a class="el" href="classaf_1_1index.htm">index</a> &idx0)</td></tr>
<tr class="memdesc:a89360d29df9ac98997d0348012460452"><td class="mdescLeft"> </td><td class="mdescRight">Assigns idx0 to this index. <a href="classaf_1_1index.htm#a89360d29df9ac98997d0348012460452">More...</a><br /></td></tr>
<tr class="separator:a89360d29df9ac98997d0348012460452"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Wrapper for af_index. </p>
<p >This class is a wrapper for the af_index struct in the C interface. It allows implicit type conversion from valid indexing types like int, <a class="el" href="classaf_1_1seq.htm">af::seq</a>, <a class="el" href="structaf__seq.htm">af_seq</a>, and <a class="el" href="classaf_1_1array.htm">af::array</a>.</p>
<dl class="section note"><dt>Note</dt><dd>This is a helper class and does not necessarily need to be created explicitly. It is used in the operator() overloads to simplify the API. </dd></dl>
<p class="definition">Definition at line <a class="el" href="index_8h_source.htm#l00052">52</a> of file <a class="el" href="index_8h_source.htm">index.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a149eb92716c1084a935e04a8d95f7347" name="a149eb92716c1084a935e04a8d95f7347"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a149eb92716c1084a935e04a8d95f7347">◆ </a></span>index() <span class="overload">[1/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p >Equivalent to <a class="el" href="namespaceaf.htm#af5c1188f38105afaf8b3f383492a1c9f">af::span</a> </p>
</div>
</div>
<a id="aa2ca18df5addbd81bb476477e822bf2e" name="aa2ca18df5addbd81bb476477e822bf2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2ca18df5addbd81bb476477e822bf2e">◆ </a></span>~index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab6e05022b3f52755fbdad4d7ac680d7f" name="ab6e05022b3f52755fbdad4d7ac680d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6e05022b3f52755fbdad4d7ac680d7f">◆ </a></span>index() <span class="overload">[2/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit int converter. </p>
<p >Indexes the <a class="el" href="classaf_1_1array.htm" title="A multi dimensional data container.">af::array</a> at index <code>idx</code> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>is the id of the index</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>indexing </dd></dl>
</div>
</div>
<a id="a09a23c678003d2ebc82873b54198481e" name="a09a23c678003d2ebc82873b54198481e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a23c678003d2ebc82873b54198481e">◆ </a></span>index() <span class="overload">[3/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1seq.htm">af::seq</a> & </td>
<td class="paramname"><em>s0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit seq converter. </p>
<p >Indexes the <a class="el" href="classaf_1_1array.htm" title="A multi dimensional data container.">af::array</a> using an <a class="el" href="classaf_1_1seq.htm">af::seq</a> object</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s0</td><td>is the set of indices to parse</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>indexing </dd></dl>
</div>
</div>
<a id="a4b8cbe8d9768c6e57b953f6e3c298b1b" name="a4b8cbe8d9768c6e57b953f6e3c298b1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b8cbe8d9768c6e57b953f6e3c298b1b">◆ </a></span>index() <span class="overload">[4/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structaf__seq.htm">af_seq</a> & </td>
<td class="paramname"><em>s0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit seq converter. </p>
<p >Indexes the <a class="el" href="classaf_1_1array.htm" title="A multi dimensional data container.">af::array</a> using an <a class="el" href="structaf__seq.htm">af_seq</a> object</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s0</td><td>is the set of indices to parse</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>indexing </dd></dl>
</div>
</div>
<a id="a18866c96649b856448272fbe723bb330" name="a18866c96649b856448272fbe723bb330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18866c96649b856448272fbe723bb330">◆ </a></span>index() <span class="overload">[5/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1array.htm">af::array</a> & </td>
<td class="paramname"><em>idx0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit int converter. </p>
<p >Indexes the <a class="el" href="classaf_1_1array.htm" title="A multi dimensional data container.">af::array</a> using an <a class="el" href="classaf_1_1array.htm">af::array</a> object</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">idx0</td><td>is the set of indices to parse</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>indexing </dd></dl>
</div>
</div>
<a id="a538f1bf60d71a8ab134e2d377e04534b" name="a538f1bf60d71a8ab134e2d377e04534b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a538f1bf60d71a8ab134e2d377e04534b">◆ </a></span>index() <span class="overload">[6/6]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1index.htm">index</a> & </td>
<td class="paramname"><em>idx0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">idx0</td><td>is index to copy.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>indexing </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af9e1817970c35053692542837c847330" name="af9e1817970c35053692542837c847330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9e1817970c35053692542837c847330">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structaf__index__t.htm">af_index_t</a> & get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the underlying <a class="el" href="structaf__index__t.htm" title="Struct used to index an af_array.">af_index_t</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="structaf__index__t.htm" title="Struct used to index an af_array.">af_index_t</a> represented by this object </dd></dl>
</div>
</div>
<a id="a7214c97cc66f572fd6e61ded0a188550" name="a7214c97cc66f572fd6e61ded0a188550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7214c97cc66f572fd6e61ded0a188550">◆ </a></span>isspan()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isspan </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the <a class="el" href="classaf_1_1index.htm">af::index</a> represents a <a class="el" href="namespaceaf.htm#af5c1188f38105afaf8b3f383492a1c9f" title="A special value representing the entire axis of an af::array.">af::span</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the <a class="el" href="classaf_1_1index.htm" title="Wrapper for af_index.">af::index</a> is an <a class="el" href="namespaceaf.htm#af5c1188f38105afaf8b3f383492a1c9f" title="A special value representing the entire axis of an af::array.">af::span</a> </dd></dl>
</div>
</div>
<a id="a89360d29df9ac98997d0348012460452" name="a89360d29df9ac98997d0348012460452"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89360d29df9ac98997d0348012460452">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classaf_1_1index.htm">index</a> & operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classaf_1_1index.htm">index</a> & </td>
<td class="paramname"><em>idx0</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns idx0 to this index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">idx0</td><td>is the index to be assigned to the /ref <a class="el" href="classaf_1_1index.htm" title="Wrapper for af_index.">af::index</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the reference to this </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="index_8h_source.htm">index.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.3-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceaf.htm">af</a></li><li class="navelem"><a class="el" href="classaf_1_1index.htm">index</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>