aboutsummaryrefslogtreecommitdiffstats
path: root/libparc/parc/algol/parc_LinkedList.h
blob: 7babff793c5255f35725b964a3ec53440186f39e (plain)
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file parc_LinkedList.h
 * @ingroup datastructures
 * @brief PARC Double-ended Queue (Deque)
 *
 */
#ifndef libparc_parc_LinkedList_h
#define libparc_parc_LinkedList_h
#include <stdbool.h>
#include <stdint.h>

#include <parc/algol/parc_List.h>
#include <parc/algol/parc_HashCode.h>
#include <parc/algol/parc_Object.h>
#include <parc/algol/parc_Iterator.h>

struct parc_linkedlist;
/**
 * A simple linked list.
 *
 * @see {@link parcLinkedList_Create}
 */
typedef struct parc_linkedlist PARCLinkedList;

/**
 * Create a `PARCLinkedList` instance with the default element equality and copy functions.
 *
 * The queue is created with no elements.
 *
 * The default element equals function is used by the `{@link parcLinkedList_Equals} function and
 * simply compares the values using the `==` operator.
 *
 * @return non-NULL A pointer to a `PARCLinkedList` instance.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
PARCLinkedList *parcLinkedList_Create(void);

#ifdef PARCLibrary_DISABLE_VALIDATION
#  define parcLinkedList_OptionalAssertValid(_instance_)
#else
#  define parcLinkedList_OptionalAssertValid(_instance_) parcLinkedList_AssertValid(_instance_)
#endif
void parcLinkedList_AssertValid(const PARCLinkedList *list);

/**
 * Create a new instance of PARCIterator that iterates through the given PARCLinkedList.
 * The returned value must be released via {@link parcIterator_Release}.
 *
 * @param [in] list A pointer to a valid `PARCLinkedList`.
 *
 * @see parcIterator_Release
 *
 * Example:
 * @code
 * {
 *    PARCIterator *iterator = parcLinkedList_CreateIterator(list);
 *
 *    while (parcIterator_HasNext(iterator)) {
 *        PARCObject *object = parcIterator_Next(iterator);
 *    }
 *
 *    parcIterator_Release(&iterator);
 * }
 * @endcode
 */
PARCIterator *parcLinkedList_CreateIterator(PARCLinkedList *list);

/**
 * Acquire a new reference to an instance of `PARCLinkedList`.
 *
 * The reference count to the instance is incremented.
 *
 * @param [in] list The instance of `PARCLinkedList` to which to refer.
 *
 * @return The same value as the input parameter @p deque
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCLinkedList *parcLinkedList_Acquire(const PARCLinkedList *list);

/**
 * Release a previously acquired reference to the specified instance,
 * decrementing the reference count for the instance.
 *
 * The pointer to the instance is set to NULL as a side-effect of this function.
 *
 * If the invocation causes the last reference to the instance to be released,
 * the instance is deallocated and the instance's interface will perform
 * additional cleanup and release other privately held references.
 *
 * @param [in,out] listPtr A pointer to a pointer to the instance of `PARCLinkedList` to release.
 *
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *buffer = parcLinkedList_Create(10);
 *
 *     parcLinkedList_Release(&buffer);
 * }
 * @endcode
 */
void parcLinkedList_Release(PARCLinkedList **listPtr);

/**
 * Copy a a `PARCLinkedList` to another.
 *
 * @param [in] list A pointer to an instance of `PARCLinkedList`
 *
 * @return A pointer to a copy of the original instance of `PARCLinkedList`
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
PARCLinkedList *parcLinkedList_Copy(const PARCLinkedList *list);

/**
 * Determine if an instance of `PARCLinkedList` is valid.
 *
 * Valid means the internal state of the type is consistent with its required current or future behaviour.
 * This may include the validation of internal instances of types.
 *
 * @param [in] list A pointer to a `PARCLinkedList` instance.
 *
 * @return true The instance is valid.
 * @return false The instance is not valid.
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *instance = parcLinkedList_Create();
 *
 *     if (parcLinkedList_IsValid(instance)) {
 *         printf("Instance is valid.\n");
 *     }
 * }
 * @endcode
 */
bool parcLinkedList_IsValid(const PARCLinkedList *list);

/**
 * Returns a hash code value for the given instance.
 *
 * The general contract of the `HashCode` function is:
 *
 * Whenever it is invoked on the same instance more than once during an execution of an application,
 * the `HashCode` function must consistently return the same value,
 * provided no information in the instance is modified.
 *
 * This value need not remain consistent from one execution of an application to another execution of the same application.
 * If two instances are equal according to the `Equals` function,
 * then calling the `HashCode` function on each of the two instances must produce the same result.
 *
 * It is not required that if two instances are unequal according to the `Equals` function,
 * then calling the `HashCode` function
 * on each of the two objects must produce distinct integer results.
 *
 * @param [in] instance A pointer to the `PARCLinkedList` instance.
 *
 * @return The hashcode for the given instance.
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *buffer = parcLinkedList_Allocate(10);
 *     PARCHashCode hash = parcLinkedList_HashCode(buffer);
 *     parcLinkedList_Release(&buffer);
 * }
 * @endcode
 */
PARCHashCode parcLinkedList_HashCode(const PARCLinkedList *instance);

/**
 * Returns true if the given `PARCLinkedList` contains the specified `PARCObject`.
 *
 * The semantics are such that the function returns `true` if and only if the `PARCLinkedList`
 * list contains at least one `PARCObject` _o_ such that PARCObject_Equals(_o_, object) is true.
 *
 * @param [in] list A pointer to a valid `PARCLinkedList` instance.
 * @param [in] object A pointer to a valid `PARCObject` instance.
 *
 * @return true The given `PARCLinkedList` contains the specified `PARCObject`.
 * @return false The given `PARCLinkedList` does not contain the specified `PARCObject`.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
bool parcLinkedList_Contains(const PARCLinkedList *list, const PARCObject *object);

/**
 * Append an element to the tail end of the specified `PARCLinkedList`
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` to which the element will be appended
 * @param [in] element A pointer to the element to be appended to the instance of `PARCLinkedList`
 *
 * @return  non NULL A pointer to the specific instance of `PARCLinkedList`
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCLinkedList *parcLinkedList_Append(PARCLinkedList *list, const PARCObject *element);

/**
 * Append each element from the PARCLinkedList @p other to @p list.
 *
 * @param [in] list A pointer to a valid PARCLinkedList instance that will be receive each element from @p other.
 * @param [in] other A pointer to a valid PARCLinkedList instance containing the elements to append to @p list.
 *
 * @return The value of @p list.
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
PARCLinkedList *parcLinkedList_AppendAll(PARCLinkedList *list, const PARCLinkedList *other);

/**
 * Prepend an element to the head end of the specified `PARCLinkedList`
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` to which the element will be prepended
 * @param [in] element A pointer to the element to be appended to the instance of `PARCLinkedList`
 *
 * @return  non NULL A pointer to the specific instance of `PARCLinkedList`
 *
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCLinkedList *parcLinkedList_Prepend(PARCLinkedList *list, const PARCObject *element);

/**
 * Return the first element of the specified `PARCLinkedList` and remove it from the list.
 * The element's reference count is not modified,
 * the caller must release the returned element when it is finished with it.
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` from which the first element will be returned and removed
 *
 * @return  non NULL A pointer to the element removed
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
PARCObject *parcLinkedList_RemoveFirst(PARCLinkedList *list);

/**
 * Remove the last element in the queue and return it.
 * The element's reference count is not modified,
 * the caller must release the returned element when it is finished with it.
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` from which the last element will be removed and returned.
 *
 * @return non-NULL A pointer to the element removed
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
PARCObject *parcLinkedList_RemoveLast(PARCLinkedList *list);

/**
 * Remove the first occurrence of the given element from the specified 'PARCLinkedList'.
 * The element's reference count is decremented.
 *
 * @param [in] element the element to remove
 * @return true if the element was found in the list and successfully removed
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *list = parcLinkedList_Create();
 *
 *     PARCBuffer *buffer = parcBuffer_WrapCString("1");
 *     parcLinkedList_Append(list, buffer);
 *     parcBuffer_Release(&buffer);
 *     // ...
 *     PARCBuffer *actual = parcLinkedList_Remove(list, buffer);
 *     parcBuffer_Release(&actual);
 *
 *     // ...
 *
 *     parcLinkedList_Release(&list);
 * }
 * @endcode
 */
bool parcLinkedList_Remove(PARCLinkedList *list, const PARCObject *element);

/**
 * Removes the element at the specified position in this list.
 *
 * Shifts all subsequent elements to the left (subtracts one from their indices).
 * Return the element that was removed from the list without modifying the reference count.
 * The caller must eventually release the returned value.
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` from which the element will be removed.
 * @param [in] index The index (origin 0) of the element to remove.
 *
 * @return The element that was removed from the list.
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *list = parcLinkedList_Create();
 *     // add elements to the list.
 *
 *     parcLinkedList_RemoveAtIndex(list, 2); // remove the 3rd element in the list.
 *
 *     // ...
 *
 *     parcLinkedList_Release(&list);
 * }
 * @endcode
 */
PARCObject *parcLinkedList_RemoveAtIndex(PARCLinkedList *list, size_t index);

/**
 * Return the first element of the specified `PARCLinkedList` but do NOT remove it from the queue
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` from which the first element will be returned
 *
 * @return  non NULL A pointer to the first element
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
PARCObject *parcLinkedList_GetFirst(const PARCLinkedList *list);

/**
 * Return the last element of the specified `PARCLinkedList` but do NOT remove it from the queue
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList` from which the last element will be returned
 *
 * @return  non NULL A pointer to the last element
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
PARCObject *parcLinkedList_GetLast(const PARCLinkedList *list);

/**
 * Return the size of the specified queue
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList`
 *
 * @return `size_t` The size of the queue
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
size_t parcLinkedList_Size(const PARCLinkedList *list);

/**
 * Return True if the `PARCLinkedList` is empty or False if not.
 *
 * @param [in] list A pointer to the instance of `PARCLinkedList`
 *
 * @return bool True if the `PARCLinkedList` is empty or False if not.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 *
 */
bool parcLinkedList_IsEmpty(const PARCLinkedList *list);

/**
 * Get a pointer to the specified element.
 *
 * @param [in] list A pointer to a `PARCLinkedList` instance.
 * @param [in] index The index of the element to be retrieved.
 *
 * @throws `trapOutOfBounds`
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCObject *parcLinkedList_GetAtIndex(const PARCLinkedList *list, size_t index);

/**
 * Replace the element at the specified position in this list with the given element.
 *
 * @param [in] list A pointer to a `PARCLinkedList` instance.
 * @param [in] index The index of the element to be replaced.
 * @param [in] element A pointer to a valid PARCObject instance that will replace the current element at @p index.
 *
 * @throws `trapOutOfBounds`
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
PARCObject *parcLinkedList_SetAtIndex(PARCLinkedList *list, size_t index, PARCObject *element);

/**
 * Determine if two `PARCLinkedList` instances are equal.
 *
 * This function implements the following equivalence relations on non-null `PARCLinkedList` instances:
 *
 *   * It is reflexive: for any non-null reference value x, `parcLinkedList_Equals(x, x)` must return true.
 *
 *   * It is symmetric: for any non-null reference values x and y, `parcLinkedList_Equals(x, y)` must return true if and only if
 *        `parcLinkedList_Equals(y x)` returns true.
 *
 *   * It is transitive: for any non-null reference values x, y, and z, if
 *        `parcLinkedList_Equals(x, y)` returns true and
 *        `parcLinkedList_Equals(y, z)` returns true,
 *        then `parcLinkedList_Equals(x, z)` must return true.
 *
 *   * It is consistent: for any non-null reference values x and y, multiple invocations of `parcLinkedList_Equals(x, y)`
 *         consistently return true or consistently return false.
 *
 *   * For any non-null reference value x, `parcLinkedList_Equals(x, NULL)` must return false.
 *
 * Two `PARCLinkedList` instances with different element equality functions are always unequal.
 *
 * @param [in] x A pointer to a `PARCLinkedList` instance.
 * @param [in] y A pointer to a `PARCLinkedList` instance.
 *
 * @return true `PARCLinkedList` x and y are equal.
 * @return false `PARCLinkedList` x and y are not equal.
 *
 * Example:
 * @code
 * <#example#>
 * @endcode
 */
bool parcLinkedList_Equals(const PARCLinkedList *x, const PARCLinkedList *y);

/**
 * Print a human readable representation of the given `PARCLinkedList`.
 *
 * @param [in] indentation The level of indentation to use to pretty-print the output.
 * @param [in] list A pointer to the instance to display.
 *
 * Example:
 * @code
 * {
 *     PARCLinkedList *instance = parcLinkedList_Create();
 *
 *     parcLinkedList_Display(instance, 0);
 *
 *     parcLinkedList_Release(&instance);
 * }
 * @endcode
 *
 */
void parcLinkedList_Display(const PARCLinkedList *list, int indentation);

/**
 * Wakes up a single thread that is waiting on this object (see `parcLinkedList_Wait)`.
 * If any threads are waiting on this object, one of them is chosen to be awakened.
 * The choice is arbitrary and occurs at the discretion of the underlying implementation.
 *
 * The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object.
 * The awakened thread will compete in the usual manner with any other threads that might be actively
 * competing to synchronize on this object;
 * for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.
 *
 * @param [in] object A pointer to a valid PARCLinkedList instance.
 *
 * Example:
 * @code
 * {
 *
 *     parcLinkedList_Notify(object);
 * }
 * @endcode
 */
parcObject_ImplementNotify(parcLinkedList, PARCLinkedList);

/**
 * Wakes up all threads that are waiting on the given object's lock.
 *
 * A thread waits on an object by calling one of the wait methods, `parcLinkedList_Wait`, `parcLinkedList_WaitFor`, `parcLinkedList_WaitUntil`.
 * The awakened threads will proceed after the current thread relinquishes the lock on the given object.
 * The awakened threads will compete in the usual manner with any other threads that might be actively competing
 * to synchronize on this object.
 * Awakened threads have no priority between them in being the next thread to lock this object.
 *
 * This method can only be called by a thread that is the owner of this object's lock.
 *
 * @param [in] object A pointer to a valid `PARCLinkedList` instance.
 *
 * Example:
 * @code
 * {
 *     if (parcLinkedList_Lock(object)) {
 *         parcLinkedList_NotifyAll(object);
 *         parcLinkedList_Unlock(object);
 *     }
 * }
 * @endcode
 */
parcObject_ImplementNotifyAll(parcLinkedList, PARCLinkedList);

/**
 * Causes the calling thread to wait until either another thread invokes the parcLinkedList_Notify() function on the same object.
 *
 * @param [in] object A pointer to a valid `PARCLinkedList` instance.
 *
 * Example:
 * @code
 * {
 *
 *     parcLinkedList_Wait(object);
 * }
 * @endcode
 */
parcObject_ImplementWait(parcLinkedList, PARCLinkedList);

parcObject_ImplementWaitFor(parcLinkedList, PARCLinkedList);

parcObject_ImplementWaitUntil(parcLinkedList, PARCLinkedList);

/**
 * Obtain the lock on the given `PARCLinkedList` instance.
 *
 * If the lock is already held by another thread, this function will block.
 * If the lock is aleady held by the current thread, this function will return `false`.
 *
 * Implementors must avoid deadlock by attempting to lock the object a second time within the same calling thread.
 *
 * @param [in] object A pointer to a valid `PARCLinkedList` instance.
 *
 * @return true The lock was obtained successfully.
 * @return false The lock is already held by the current thread, or the `PARCLinkedList` is invalid.
 *
 * Example:
 * @code
 * {
 *     if (parcLinkedList_Lock(object)) {
 *
 *     }
 * }
 * @endcode
 */
parcObject_ImplementLock(parcLinkedList, PARCLinkedList);

/**
 * Try to obtain the advisory lock on the given PARCLinkedList instance.
 *
 * Once the lock is obtained, the caller must release the lock as soon as possible.
 *
 * @param [in] object A pointer to a valid PARCLinkedList instance.
 *
 * @return true The PARCLinkedList is locked.
 * @return false The PARCLinkedList is unlocked.
 *
 * Example:
 * @code
 * {
 *     parcLinkedList_TryLock(object);
 * }
 * @endcode
 */
parcObject_ImplementTryLock(parcLinkedList, PARCLinkedList);

/**
 * Try to unlock the advisory lock on the given `PARCLinkedList` instance.
 *
 * @param [in] object A pointer to a valid `PARCLinkedList` instance.
 *
 * @return true The `PARCLinkedList` was locked and now is unlocked.
 * @return false The `PARCLinkedList` was not locked and remains unlocked.
 *
 * Example:
 * @code
 * {
 *     parcLinkedList_Unlock(object);
 * }
 * @endcode
 */
parcObject_ImplementUnlock(parcLinkedList, PARCLinkedList);

/**
 * Determine if the advisory lock on the given `PARCLinkedList` instance is locked.
 *
 * @param [in] object A pointer to a valid `PARCLinkedList` instance.
 *
 * @return true The `PARCLinkedList` is locked.
 * @return false The `PARCLinkedList` is unlocked.
 * Example:
 * @code
 * {
 *     if (parcLinkedList_IsLocked(object)) {
 *         ...
 *     }
 * }
 * @endcode
 */
parcObject_ImplementIsLocked(parcLinkedList, PARCLinkedList);

/**
 * Determine if two `PARCLinkedList` instances are equivalent sets.
 *
 * The lists are examined without regard to order.
 * If both lists, x and y are of equal length, and all of the elements in list `x` are present in list `y`, this function returns true.
 *
 * @param [in] x A pointer to a valid `PARCLinkedList` instance.
 * @param [in] y A pointer to a valid `PARCLinkedList` instance.
 * @return true The instances are equivalent.
 * @return false The instances are equivalent.
 *
 */
bool parcLinkedList_SetEquals(const PARCLinkedList *x, const PARCLinkedList *y);

/**
 * Insert the given element into the list such that it is the index'th element in the list.
 */
PARCLinkedList *parcLinkedList_InsertAtIndex(PARCLinkedList *list, size_t index, const PARCObject *element);

/**
 * Apply a function to every element in the given PARCLinkedList.
 *
 * The function is applied in order, any return value is ignored.
 *
 * @param [in] list A pointer to a valid PARCLinkedList instance.
 * @param [in] function A pointer to a function that will be called with each element of the list.
 * @param [in] parameter A pointer to arbitrary data that will supplied as an additional parameter to @p function
 *
 */
#define parcLinkedList_Apply(_list_, _function_, _parameter_) \
    parcLinkedList_ApplyImpl(_list_, (void (*))_function_, (const void *) _parameter_)
void parcLinkedList_ApplyImpl(PARCLinkedList *list, void (*function)(PARCObject *, const void *), const void *parameter);

/**
 * <#One Line Description#>
 *
 * <#Paragraphs Of Explanation#>
 *
 * @param [<#in#> | <#out#> | <#in,out#>] <#name#> <#description#>
 *
 * @return <#value#> <#explanation#>
 *
 * Example:
 * @code
 * {
 *     <#example#>
 * }
 * @endcode
 */
PARCList *parcLinkedList_AsPARCList(PARCLinkedList *list);
#endif // libparc_parc_Deque_h