/
directions.html
377 lines (371 loc) · 8.63 KB
/
directions.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
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
<head>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" ></link>
<style>
pre, code {
white-space: pre-line;
min-width: 400px;
}
</style>
</head>
<body>
<h1>Node Class API</h1>
<table class="table">
<thead>
<tr>
<td>Function</td>
<td>Arguments</td>
<td>Returns</td>
<td>Directions</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr>
<td>Node.constructor</td>
<td>(Data, Node)</td>
<td>Node</td>
<td>
Creates a class instance to represent a node. The node should
have two properties, 'data' and 'next'. Accept both
of these as arguments to the 'Node' constructor, then
assign them to the instance as properties 'data' and 'next'.
If 'next' is not provided to the constructor, then default its
value to be 'null'.
</td>
<td>
<pre>
const n = new Node('There');
n.data // 'Hi'
n.next // null
const n2 = new Node('Hi', n);
n.next // returns n
</pre>
</td>
</tr>
</tbody>
</table>
<h1>LinkedList Class API</h1>
<table class="table">
<thead>
<tr>
<td>Function</td>
<td>Arguments</td>
<td>Returns</td>
<td>Directions</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr>
<td>constructor</td>
<td>-</td>
<td>(LinkedList)</td>
<td>
Create a class to represent a linked list. When created,
a linked list should have *no* head node associated with it.
The LinkedList instance will have one property, 'head', which
is a reference to the first node of the linked list. By default
'head' should be 'null'.
</td>
<td>
<pre>
const list = new LinkedList();
list.head // null
</pre>
</td>
</tr>
<tr>
<td>insertFirst</td>
<td>(data)</td>
<td>-</td>
<td>
Creates a new Node from argument 'data' and assigns the resulting
node to the 'head' property. Make sure to handle the case in which
the linked list already has a node assigned to the 'head' property.
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('Hi There'); // List has one node
</pre>
</td>
</tr>
<tr>
<td>size</td>
<td>-</td>
<td>(integer)</td>
<td>
Returns the number of nodes in the linked list.
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.insertFirst('c');
list.size(); // returns 3
</pre>
</td>
</tr>
<tr>
<td>getFirst</td>
<td>-</td>
<td>(Node)</td>
<td>
Returns the first node of the linked list.
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.getFirst(); // returns Node instance with data 'a'
</pre>
</td>
</tr>
<tr>
<td>
getLast
</td>
<td>
-
</td>
<td>
(Node)
</td>
<td>
Returns the last node of the linked list
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.getLast(); // returns node with data 'a'
</pre>
</td>
</tr>
<tr>
<td>
clear
</td>
<td>
-
</td>
<td>
-
</td>
<td>
Empties the linked list of any nodes.
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.clear();
list.size(); // returns 0
</pre>
</td>
</tr>
<tr>
<td>
removeFirst
</td>
<td>
-
</td>
<td>
-
</td>
<td>
Removes only the first node of the linked list. The list's head should
now be the second element.
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.removeFirst();
list.getFirst(); // returns node with data 'a'
</pre>
</td>
</tr>
<tr>
<td>
removeLast
</td>
<td>
-
</td>
<td>
-
</td>
<td>
Removes the last node of the chain
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.removeLast();
list.size(); // returns 1
list.getLast(); // returns node with data of 'b'
</pre>
</td>
</tr>
<tr>
<td>
insertLast
</td>
<td>
(Data)
</td>
<td>
-
</td>
<td>
Inserts a new node with provided data at the end of the chain
</td>
<td>
<pre>
const list = new LinkedList();
list.insertFirst('a');
list.insertFirst('b');
list.insertLast('c');
list.getLast(); // returns node with data 'C'
</pre>
</td>
</tr>
<tr>
<td>
getAt
</td>
<td>
(integer)
</td>
<td>
(Node)
</td>
<td>
Returns the node at the provided index
</td>
<td>
<pre>
const list = new List();
list.insertFirst('a');
list.insertFirst('b');
list.insertFirst('c');
list.getAt(1); // returns node with data 'b'
</pre>
</td>
</tr>
<tr>
<td>
removeAt
</td>
<td>
(integer)
</td>
<td>
-
</td>
<td>
Removes node at the provided index
</td>
<td>
<pre>
const list = new List();
list.insertFirst('a');
list.insertFirst('b');
list.insertFirst('c');
list.removeAt(1);
list.getAt(1); // returns node with data 'a'
</pre>
</td>
</tr>
<tr>
<td>
insertAt
</td>
<td>
(Data, integer)
</td>
<td>
-
</td>
<td>
Create an insert a new node at provided index.
If index is out of bounds, add the node to the end
of the list.
</td>
<td>
<pre>
const list = new List();
list.insertFirst('a');
list.insertFirst('b');
list.insertFirst('c');
list.insertAt('Hi', 1)
list.getAt(1); // returns node with data 'Hi'
</pre>
</td>
</tr>
<tr>
<td>
forEach
</td>
<td>
(function)
</td>
<td>
-
</td>
<td>
Calls the provided function with every node of the chain
</td>
<td>
<pre>
const list = new List();
list.insertLast(1);
list.insertLast(2);
list.insertLast(3);
list.insertLast(4);
list.forEach(node => {
node.data += 10;
});
list.getAt(0); // Returns node with data '11'
</pre>
</td>
</tr>
<tr>
<td>
for...of Loop
</td>
<td>
-
</td>
<td>
-
</td>
<td>
Linked list should be compatible as the subject of a 'for...of' loop
</td>
<td>
<pre>
const list = new List();
list.insertLast(1);
list.insertLast(2);
list.insertLast(3);
list.insertLast(4);
for (let node of list) {
node.data += 10;
}
node.getAt(1); // returns node with data 11
</pre>
</td>
</tr>
</tbody>
</table>
</body>