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
|
# STC [csset](../stc/csmap.h): Sorted Set
A **csset** is an associative container that contains a sorted set of unique objects of type *Key*. Sorting is done using the key comparison function *keyCompare*. Search, removal, and insertion operations have logarithmic complexity. **csset** is implemented as an AA-tree.
See the c++ class [std::set](https://en.cppreference.com/w/cpp/container/set) for a functional description.
## Header file and declaration
```c
#include <stc/csset.h>
using_csset(X, Key);
using_csset(X, Key, keyCompare);
using_csset(X, Key, keyCompare, keyDel, keyClone = c_no_clone);
using_csset(X, Key, keyCompareRaw, keyDel, keyFromRaw, keyToRaw, RawKey);
using_csset_str(); // using_csset(str, cstr, ...)
```
The macro `using_csset()` must be instantiated in the global scope. `X` is a type tag name and
will affect the names of all csset types and methods. E.g. declaring `using_csset(i, int);`, `X` should
be replaced by `i` in all of the following documentation.
## Methods
```c
csset_X csset_X_init(void);
csset_X csset_X_clone(csset_x set);
void csset_X_clear(csset_X* self);
void csset_X_swap(csset_X* a, csset_X* b);
void csset_X_del(csset_X* self); // destructor
bool csset_X_empty(csset_X set);
size_t csset_X_size(csset_X set);
bool csset_X_contains(const csset_X* self, RawKey rkey);
csset_X_value_t* csset_X_get(const csset_X* self, RawKey rkey); // return NULL if not found
csset_X_iter_t csset_X_lower_bound(const csset_X* self, RawKey rkey); // find closest entry >= rkey
csset_X_iter_t csset_X_find(const csset_X* self, RawKey rkey);
csset_X_value_t* csset_X_find_it(const csset_X* self, RawKey rkey, csset_X_iter_t* out); // return NULL if not found
csset_X_result_t csset_X_insert(csset_X* self, Key key);
csset_X_result_t csset_X_emplace(csset_X* self, RawKey rkey);
void csset_X_emplace_items(csset_X* self, const RawKey arr[], size_t n);
size_t csset_X_erase(csset_X* self, RawKey rkey);
csset_X_iter_t csset_X_erase_at(csset_X* self, csset_X_iter_t it); // return iter after it
csset_X_iter_t csset_X_erase_range(csset_X* self, csset_X_iter_t it1, csset_X_iter_t it2); // return updated it2
csset_X_iter_t csset_X_begin(const csset_X* self);
csset_X_iter_t csset_X_end(const csset_X* self);
void csset_X_next(csset_X_iter_t* it);
csset_X_value_t csset_X_value_clone(csset_X_value_t val);
```
## Types
| Type name | Type definition | Used to represent... |
|:---------------------|:--------------------------------------------------|:----------------------------|
| `csset_X` | `struct { ... }` | The csset type |
| `csset_X_rawkey_t` | `RawKey` | The raw key type |
| `csset_X_rawvalue_t` | `csset_X_rawkey_t` | The raw key type |
| `csset_X_key_t` | `Key` | The key type |
| `csset_X_value_t` | `const Key` | The value: key is immutable |
| `csset_X_result_t` | `struct { csset_X_value_t* ref; bool inserted; }` | Result of insert/emplace |
| `csset_X_iter_t` | `struct { csset_X_value_t *ref; ... }` | Iterator type |
## Example
```c
#include <stc/csset.h>
#include <stc/cstr.h>
using_csset_str();
int main ()
{
csset_str first = csset_str_init(); // empty
c_var (csset_str, second, {"red", "green", "blue"});
c_var (csset_str, third, {"orange", "pink", "yellow"});
csset_str fourth = csset_str_init();
csset_str_emplace(&fourth, "potatoes");
csset_str_emplace(&fourth, "milk");
csset_str_emplace(&fourth, "flour");
csset_str fifth = csset_str_clone(second);
c_foreach (i, csset_str, third)
csset_str_emplace(&fifth, i.ref->str);
c_foreach (i, csset_str, fourth)
csset_str_emplace(&fifth, i.ref->str);
c_del(csset_str, &first, &second, &third, &fourth);
printf("fifth contains:\n\n");
c_foreach (i, csset_str, fifth)
printf("%s\n", i.ref->str);
csset_str_del(&fifth);
return 0;
}
```
Output:
```
fifth contains:
blue
flour
green
milk
orange
pink
potatoes
red
yellow
```
|
