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
|
# STC [clist](../stc/clist.h): Singly Linked List
The **clist** container supports fast insertion and removal of elements from anywhere in the container.
Fast random access is not supported.
Unlike the c++ class *std::forward_list*, **clist** has an API similar to *std::list*, and also supports
*push_back()* (**O**(1) time). It is still implemented as a singly-linked list. A **clist** object
occupies only one pointer in memory, and like *std::forward_list* the length of the list is not stored.
The method *clist_X_count()* returns size of list, computed in **O**(*n*) time.
***Iterator invalidation***: Adding, removing and moving the elements within the list, or across several lists
will invalidate other iterators currently refering to these elements and their immediate succesive elements.
However, an iterator to a succesive element can both be dereferenced and advanced. After advancing (using
*clist_X_next(&it)* or *it = cslist_X_fwd(it, n)*), the iterator is in a valid state. This implies:
- `clist_X_insert(&L, clist_X_fwd(it,1))` (insert_after) is well formed if element at `it` exists.
- `clist_X_erase_at(&L, clist_X_fwd(it,1))` (erase_after) is well formed if element at `it` exists and is not last in list.
- Iterators returned from *clist_X_insert()* and *clist_X_erase_at()* are always valid or `end`.
- Elements can be safely removed from a list via multiple iterators if done in back to front order.
See the c++ class [std::list](https://en.cppreference.com/w/cpp/container/list) for similar API and
[std::forward_list](https://en.cppreference.com/w/cpp/container/forward_list) for a functional description.
## Header file and declaration
```c
#include <stc/clist.h>
using_clist(X, Value);
using_clist(X, Value, valueCompare);
using_clist(X, Value, valueCompare, valueDel, valueClone = c_no_clone);
using_clist(X, Value, valueCompareRaw, valueDel, valueFromRaw, valueToRaw, RawValue);
using_clist_str()
```
The macro `using_clist()` must be instantiated in the global scope. `X` is a type tag name and
will affect the names of all clist types and methods. E.g. declaring `using_clist(i, int);`, `X` should
be replaced by `i` in all of the following documentation. `using_clist_str()` is a shorthand for
```c
using_clist(str, cstr, cstr_compare_raw, cstr_del, cstr_from, cstr_c_str, const char*)
```
## Methods
```c
clist_X clist_X_init(void);
clist_X clist_X_clone(clist_X list);
void clist_X_clear(clist_X* self);
void clist_X_del(clist_X* self); // destructor
bool clist_X_empty(clist_X list);
size_t clist_X_count(clist_X list); // size() in O(n)
clist_X_value_t* clist_X_front(const clist_X* self);
clist_X_value_t* clist_X_back(const clist_X* self);
void clist_X_push_front(clist_X* self, Value value);
void clist_X_emplace_front(clist_X* self, RawValue raw);
void clist_X_pop_front(clist_X* self);
// non-std:
void clist_X_push_back(clist_X* self, Value value);
void clist_X_emplace_back(clist_X* self, RawValue raw);
void clist_X_emplace_n(clist_X *self, const clist_X_rawvalue_t arr[], size_t size);
clist_X_iter_t clist_X_insert(clist_X* self, clist_X_iter_t it, Value value); // return iter to new elem; `it` may be end
clist_X_iter_t clist_X_emplace(clist_X* self, clist_X_iter_t it, RawValue raw);
clist_X_iter_t clist_X_erase_at(clist_X* self, clist_X_iter_t it); // return iter before it
clist_X_iter_t clist_X_erase_range(clist_X* self, clist_X_iter_t it1, clist_X_iter_t it2);
size_t clist_X_remove(clist_X* self, RawValue raw); // removes all elements equal to raw
void clist_X_splice(clist_X* self, clist_X_iter_t it, clist_X* other);
void clist_X_splice_range(clist_X* self, clist_X_iter_t it,
clist_X* other, clist_X_iter_t it1, clist_X_iter_t it2);
// non-std: split out [it1, it2) from self, returned as a clist
clist_X clist_X_split(clist_X* self, clist_X_iter_t it1, clist_X_iter_t it2);
clist_X_iter_t clist_X_find(const clist_X* self, RawValue raw);
clist_X_iter_t clist_X_find_in_range(const clist_X* self,
clist_X_iter_t it1, clist_X_iter_t it2, RawValue raw);
void clist_X_sort(clist_X* self);
clist_X_iter_t clist_X_begin(const clist_X* self);
clist_X_iter_t clist_X_end(const clist_X* self);
void clist_X_next(clist_X_iter_t* it);
// non-std: iterator advanced n elements forward. returns end if `it` == end.
clist_X_iter_t clist_X_fwd(clist_X_iter it, size_t n);
clist_X_value_t clist_X_value_clone(clist_X_value_t val);
```
## Types
| Type name | Type definition | Used to represent... |
|:----------------------|:------------------------------------|:--------------------------|
| `clist_X` | `struct { clist_X_node_t* last; }` | The clist type |
| `clist_X_value_t` | `Value` | The clist element type |
| `clist_X_rawvalue_t` | `RawValue` | clist raw value type |
| `clist_X_iter_t` | `struct { clist_value_t *ref; ... }`| clist iterator |
## Example
Interleave *push_front()* / *push_back()* then *sort()*:
```c
#include <stc/clist.h>
#include <stdio.h>
using_clist(d, double);
int main() {
c_init (clist_d, list, {
10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0
});
c_forrange (i, int, 1, 10) {
if (i & 1) clist_d_push_front(&list, (float) i);
else clist_d_push_back(&list, (float) i);
}
printf("initial: ");
c_foreach (i, clist_d, list)
printf(" %g", *i.ref);
clist_d_sort(&list); // mergesort O(n*log n)
printf("\nsorted: ");
c_foreach (i, clist_d, list)
printf(" %g", *i.ref);
clist_d_del(&list);
}
```
Output:
```
initial: 9 7 5 3 1 10 20 30 40 50 60 70 80 90 2 4 6 8
sorted: 1 2 3 4 5 6 7 8 9 10 20 30 40 50 60 70 80 90
```
### Example 2
Use of *erase_at()* and *erase_range()*:
```c
// erasing from clist
#include <stc/clist.h>
#include <stdio.h>
using_clist(i, int);
int main ()
{
c_init (clist_i, L, {10, 20, 30, 40, 50});
// 10 20 30 40 50
clist_i_iter_t it = clist_i_begin(&L); // ^
clist_i_next(&it);
it = clist_i_erase_at(&L, it); // 10 30 40 50
// ^
clist_i_iter_t end = clist_i_end(&L); //
clist_i_next(&it);
it = clist_i_erase_range(&L, it, end); // 10 30
// ^
printf("mylist contains:");
c_foreach (x, clist_i, L) printf(" %d", *x.ref);
puts("");
clist_i_del(&L);
}
```
Output:
```
mylist contains: 10 30
```
### Example 3
Splice `[30, 40]` from *L2* into *L1* before `3`:
```c
#include <stc/clist.h>
#include <stdio.h>
using_clist(i, int);
int main() {
c_init (clist_i, L1, {1, 2, 3, 4, 5});
c_init (clist_i, L2, {10, 20, 30, 40, 50});
clist_i_iter_t i = clist_i_fwd(clist_i_begin(&L1), 2);
clist_i_iter_t j1 = clist_i_fwd(clist_i_begin(&L2), 2), j2 = clist_i_fwd(j1, 2);
clist_i_splice_range(&L1, i, &L2, j1, j2);
c_foreach (i, clist_i, L1) printf(" %d", *i.ref); puts("");
c_foreach (i, clist_i, L2) printf(" %d", *i.ref); puts("");
}
```
Output:
```
1 2 30 40 3 4 5
10 20 50
```
|
