-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassgymbo_1_1Linkedlist.html
344 lines (315 loc) · 16.8 KB
/
classgymbo_1_1Linkedlist.html
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
<!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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gymbo: gymbo::Linkedlist< T > Class Template 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="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">Gymbo
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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">
<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="namespacegymbo.html">gymbo</a></li><li class="navelem"><a class="el" href="classgymbo_1_1Linkedlist.html">Linkedlist</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classgymbo_1_1Linkedlist-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gymbo::Linkedlist< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Doubly Linked List Implementation.
<a href="classgymbo_1_1Linkedlist.html#details">More...</a></p>
<p><code>#include <<a class="el" href="utils_8h_source.html">utils.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a66b58b49de1f5be816a8773c02e61a8f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#a66b58b49de1f5be816a8773c02e61a8f">Linkedlist</a> ()</td></tr>
<tr class="memdesc:a66b58b49de1f5be816a8773c02e61a8f"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for <a class="el" href="classgymbo_1_1Linkedlist.html" title="Doubly Linked List Implementation.">Linkedlist</a>. <a href="classgymbo_1_1Linkedlist.html#a66b58b49de1f5be816a8773c02e61a8f">More...</a><br /></td></tr>
<tr class="separator:a66b58b49de1f5be816a8773c02e61a8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad169b5ca8b53a0157ede207d813c6958"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#ad169b5ca8b53a0157ede207d813c6958">len</a> ()</td></tr>
<tr class="memdesc:ad169b5ca8b53a0157ede207d813c6958"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the linked list. <a href="classgymbo_1_1Linkedlist.html#ad169b5ca8b53a0157ede207d813c6958">More...</a><br /></td></tr>
<tr class="separator:ad169b5ca8b53a0157ede207d813c6958"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b39502f9ea3d252ffb0f9e2f043fbd1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#a2b39502f9ea3d252ffb0f9e2f043fbd1">push</a> (T data)</td></tr>
<tr class="memdesc:a2b39502f9ea3d252ffb0f9e2f043fbd1"><td class="mdescLeft"> </td><td class="mdescRight">Pushes a new element onto the back of the linked list. <a href="classgymbo_1_1Linkedlist.html#a2b39502f9ea3d252ffb0f9e2f043fbd1">More...</a><br /></td></tr>
<tr class="separator:a2b39502f9ea3d252ffb0f9e2f043fbd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87fa5aecca5c855d988fdbff462b341f"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#a87fa5aecca5c855d988fdbff462b341f">back</a> ()</td></tr>
<tr class="memdesc:a87fa5aecca5c855d988fdbff462b341f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the element at the back of the linked list. <a href="classgymbo_1_1Linkedlist.html#a87fa5aecca5c855d988fdbff462b341f">More...</a><br /></td></tr>
<tr class="separator:a87fa5aecca5c855d988fdbff462b341f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5c7ec8bd1153caf1f9d767032c1dcd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#aa5c7ec8bd1153caf1f9d767032c1dcd2">pop</a> ()</td></tr>
<tr class="memdesc:aa5c7ec8bd1153caf1f9d767032c1dcd2"><td class="mdescLeft"> </td><td class="mdescRight">Pops the element at the back of the linked list. <a href="classgymbo_1_1Linkedlist.html#aa5c7ec8bd1153caf1f9d767032c1dcd2">More...</a><br /></td></tr>
<tr class="separator:aa5c7ec8bd1153caf1f9d767032c1dcd2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6ee52305433ed55928d68c287a300e40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a>< T > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#a6ee52305433ed55928d68c287a300e40">ghost</a></td></tr>
<tr class="memdesc:a6ee52305433ed55928d68c287a300e40"><td class="mdescLeft"> </td><td class="mdescRight">Ghost node for maintaining previous tails during pops. <a href="classgymbo_1_1Linkedlist.html#a6ee52305433ed55928d68c287a300e40">More...</a><br /></td></tr>
<tr class="separator:a6ee52305433ed55928d68c287a300e40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c258672d7f8a8973ab92b10643b0c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a>< T > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#a8c258672d7f8a8973ab92b10643b0c32">head</a></td></tr>
<tr class="memdesc:a8c258672d7f8a8973ab92b10643b0c32"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the head of the linked list. <a href="classgymbo_1_1Linkedlist.html#a8c258672d7f8a8973ab92b10643b0c32">More...</a><br /></td></tr>
<tr class="separator:a8c258672d7f8a8973ab92b10643b0c32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa41806f06aaa8d01ca7e1a899a0a95b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a>< T > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgymbo_1_1Linkedlist.html#aa41806f06aaa8d01ca7e1a899a0a95b1">tail</a></td></tr>
<tr class="memdesc:aa41806f06aaa8d01ca7e1a899a0a95b1"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the tail of the linked list. <a href="classgymbo_1_1Linkedlist.html#aa41806f06aaa8d01ca7e1a899a0a95b1">More...</a><br /></td></tr>
<tr class="separator:aa41806f06aaa8d01ca7e1a899a0a95b1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br />
class gymbo::Linkedlist< T ></h3>
<p>Doubly Linked List Implementation. </p>
<p>The <code><a class="el" href="classgymbo_1_1Linkedlist.html" title="Doubly Linked List Implementation.">Linkedlist</a></code> class provides a simple implementation of a doubly linked list. It supports basic operations such as pushing elements onto the back, getting the length, accessing the element at the back, and popping the element at the back.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of data to store in the linked list. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a66b58b49de1f5be816a8773c02e61a8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66b58b49de1f5be816a8773c02e61a8f">◆ </a></span>Linkedlist()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::<a class="el" href="classgymbo_1_1Linkedlist.html">Linkedlist</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor for <a class="el" href="classgymbo_1_1Linkedlist.html" title="Doubly Linked List Implementation.">Linkedlist</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a87fa5aecca5c855d988fdbff462b341f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87fa5aecca5c855d988fdbff462b341f">◆ </a></span>back()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::back </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the element at the back of the linked list. </p>
<dl class="section return"><dt>Returns</dt><dd>The element at the back of the linked list. </dd></dl>
</div>
</div>
<a id="ad169b5ca8b53a0157ede207d813c6958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad169b5ca8b53a0157ede207d813c6958">◆ </a></span>len()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::len </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the length of the linked list. </p>
<dl class="section return"><dt>Returns</dt><dd>The length of the linked list. </dd></dl>
</div>
</div>
<a id="aa5c7ec8bd1153caf1f9d767032c1dcd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5c7ec8bd1153caf1f9d767032c1dcd2">◆ </a></span>pop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops the element at the back of the linked list. </p>
</div>
</div>
<a id="a2b39502f9ea3d252ffb0f9e2f043fbd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b39502f9ea3d252ffb0f9e2f043fbd1">◆ </a></span>push()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::push </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a new element onto the back of the linked list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The element to push onto the linked list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6ee52305433ed55928d68c287a300e40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ee52305433ed55928d68c287a300e40">◆ </a></span>ghost</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a><T>* <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::ghost</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ghost node for maintaining previous tails during pops. </p>
</div>
</div>
<a id="a8c258672d7f8a8973ab92b10643b0c32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c258672d7f8a8973ab92b10643b0c32">◆ </a></span>head</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a><T>* <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::head</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the head of the linked list. </p>
</div>
</div>
<a id="aa41806f06aaa8d01ca7e1a899a0a95b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa41806f06aaa8d01ca7e1a899a0a95b1">◆ </a></span>tail</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgymbo_1_1LLNode.html">LLNode</a><T>* <a class="el" href="classgymbo_1_1Linkedlist.html">gymbo::Linkedlist</a>< T >::tail</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the tail of the linked list. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libgymbo/<a class="el" href="utils_8h_source.html">utils.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.1
</small></address>
</body>
</html>