This function can be used to remove things from a set.
If a closure is used, then all things that satisfy the test are removed from the set and returned as list. The order of the removed things is not guaranteed since the set itself is unordered.
It is also possible to specify things as arguments. In this case a list is returned with
all the things which are removed from the set, in the order that the arguments are used.
Things which are not found in the set are ignored.
This function generates a change.
set.remove(callback, [limit])
Where limit is an optional positive integer which limits the things to remove. For example, a limit of 1 removes at most one thing from the set.
Or
set.remove(thing1, thing2, ..., thingX)
If a callback satisfies more than a given limit of things, it is not reliable which things are removed as the order of things in a set is not guaranteed.
Explanation of the callback argument:
| Iterable | Arguments | Description |
|---|---|---|
| set | thing, thing Id | Iterate over things in the set. Both thing and thing ID are optional. |
A list with the removed things from the set or an empty list if nothing is removed.
This code shows an example using remove() on a set:
t1 = {x:1}; t2 = {x:2}; t3 = {x:3}; t4 = {x:4};
s = set(t1, t2, t3, t4);
[
s.remove(|t| t.x < 3),
s.remove(t1, t2, t3, t4),
]
Example return value in JSON format
[
[
{
"x": 1
},
{
"x": 2
}
],
[
{
"x": 3
},
{
"x": 4
}
]
]