comparison: docs/Writerside/topics/list.h.md
docs/Writerside/topics/list.h.md
- changeset 1190
- a7b913d5d589
- parent 1146
- 151c057faf7c
equal
deleted
inserted
replaced
| 1188:b0300de92b72 | 1190:a7b913d5d589 |
|---|---|
| 1 # List Interface | 1 # List Interface |
| 2 | 2 |
| 3 <warning> | 3 <warning> |
| 4 Outdated - Rewrite! | 4 Outdated Section - will be updated soon! |
| 5 </warning> | 5 </warning> |
| 6 | 6 |
| 7 This header defines a common interface for all list implementations. | 7 This header defines a common interface for all list implementations. |
| 8 | 8 |
| 9 UCX already comes with two common list implementations (linked list and array list) that should cover most use cases. | 9 UCX already comes with two common list implementations (linked list and array list) that should cover most use cases. |
| 11 `struct cx_list_s` as first member, and set an appropriate list class that implements the functionality. | 11 `struct cx_list_s` as first member, and set an appropriate list class that implements the functionality. |
| 12 It is strongly recommended that this class is shared among all instances of the same list type, because otherwise | 12 It is strongly recommended that this class is shared among all instances of the same list type, because otherwise |
| 13 the `cxListCompare` function cannot use the optimized implementation of your class and will instead fall back to | 13 the `cxListCompare` function cannot use the optimized implementation of your class and will instead fall back to |
| 14 using iterators to compare the contents element-wise. | 14 using iterators to compare the contents element-wise. |
| 15 | 15 |
| 16 <!-- | |
| 16 ## Undocumented Symbols (TODO) | 17 ## Undocumented Symbols (TODO) |
| 17 ### cx_empty_list | 18 ### cx_empty_list |
| 18 ### cxEmptyList | 19 ### cxEmptyList |
| 19 ### cxListCompare | 20 ### cxListCompare |
| 20 ### cx_list_default_insert_array | 21 ### cx_list_default_insert_array |
| 23 ### cx_list_default_swap | 24 ### cx_list_default_swap |
| 24 ### cxListFree | 25 ### cxListFree |
| 25 ### cx_list_init | 26 ### cx_list_init |
| 26 ### cxListMutBackwardsIteratorAt | 27 ### cxListMutBackwardsIteratorAt |
| 27 ### cxListMutIteratorAt | 28 ### cxListMutIteratorAt |
| 29 --> | |
| 28 | 30 |
| 31 <seealso> | |
| 32 <category ref="apidoc"> | |
| 33 <a href="https://ucx.sourceforge.io/api/list_8h.html">list.h</a> | |
| 34 </category> | |
| 35 </seealso> |
