aboutsummaryrefslogtreecommitdiff
path: root/api/sets.md
blob: b64439c206ee171ff1f16e0c804751f37e268ea6 (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
% API

# Builtins

# Set
## Set.add

```tomo
Set.add : func(set: |T|, item: T -> Void)
```

Adds an item to the set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The mutable reference to the set.  | -
item | `T` | The item to add to the set.  | -

**Return:** Nothing.


**Example:**
```tomo
>> nums.add(42)

```
## Set.add_all

```tomo
Set.add_all : func(set: @|T|, items: [T] -> Void)
```

Adds multiple items to the set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `@|T|` | The mutable reference to the set.  | -
items | `[T]` | The list of items to add to the set.  | -

**Return:** Nothing.


**Example:**
```tomo
>> nums.add_all([1, 2, 3])

```
## Set.clear

```tomo
Set.clear : func(set: @|T| -> Void)
```

Removes all items from the set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `@|T|` | The mutable reference to the set.  | -

**Return:** Nothing.


**Example:**
```tomo
>> nums.clear()

```
## Set.has

```tomo
Set.has : func(set: |T|, item: T -> Bool)
```

Checks if the set contains a specified item.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The set to check.  | -
item | `T` | The item to check for presence.  | -

**Return:** `yes` if the item is present, `no` otherwise.


**Example:**
```tomo
>> |10, 20|.has(20)
= yes

```
## Set.is_subset_of

```tomo
Set.is_subset_of : func(set: |T|, other: |T|, strict: Bool = no -> Bool)
```

Checks if the set is a subset of another set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The set to check.  | -
other | `|T|` | The set to compare against.  | -
strict | `Bool` | If `yes`, checks if the set is a strict subset (does not equal the other set).  | `no`

**Return:** `yes` if the set is a subset of the other set (strictly or not), `no` otherwise.


**Example:**
```tomo
>> |1, 2|.is_subset_of(|1, 2, 3|)
= yes

```
## Set.is_superset_of

```tomo
Set.is_superset_of : func(set: |T|, other: |T|, strict: Bool = no -> Bool)
```

Checks if the set is a superset of another set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The set to check.  | -
other | `|T|` | The set to compare against.  | -
strict | `Bool` | If `yes`, checks if the set is a strict superset (does not equal the other set).  | `no`

**Return:** `yes` if the set is a superset of the other set (strictly or not), `no` otherwise.


**Example:**
```tomo
>> |1, 2, 3|.is_superset_of(|1, 2|)
= yes

```
## Set.overlap

```tomo
Set.overlap : func(set: |T|, other: |T| -> |T|)
```

Creates a new set with items that are in both the original set and another set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The original set.  | -
other | `|T|` | The set to intersect with.  | -

**Return:** A new set containing only items present in both sets.


**Example:**
```tomo
>> |1, 2|.overlap(|2, 3|)
= |2|

```
## Set.remove

```tomo
Set.remove : func(set: @|T|, item: T -> Void)
```

Removes an item from the set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `@|T|` | The mutable reference to the set.  | -
item | `T` | The item to remove from the set.  | -

**Return:** Nothing.


**Example:**
```tomo
>> nums.remove(42)

```
## Set.remove_all

```tomo
Set.remove_all : func(set: @|T|, items: [T] -> Void)
```

Removes multiple items from the set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `@|T|` | The mutable reference to the set.  | -
items | `[T]` | The list of items to remove from the set.  | -

**Return:** Nothing.


**Example:**
```tomo
>> nums.remove_all([1, 2, 3])

```
## Set.with

```tomo
Set.with : func(set: |T|, other: |T| -> |T|)
```

Creates a new set that is the union of the original set and another set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The original set.  | -
other | `|T|` | The set to union with.  | -

**Return:** A new set containing all items from both sets.


**Example:**
```tomo
>> |1, 2|.with(|2, 3|)
= |1, 2, 3|

```
## Set.without

```tomo
Set.without : func(set: |T|, other: |T| -> |T|)
```

Creates a new set with items from the original set but without items from another set.

Argument | Type | Description | Default
---------|------|-------------|---------
set | `|T|` | The original set.  | -
other | `|T|` | The set of items to remove from the original set.  | -

**Return:** A new set containing items from the original set excluding those in the other set.


**Example:**
```tomo
>> |1, 2|.without(|2, 3|)
= |1|

```