In mathematical notation, difference is defined as:
And using Venn diagram:
difference() accepts set-like objects as the other parameter. It requires this to be an actual Set instance, because it directly retrieves the underlying data stored in this without invoking any user code. Then, its behavior depends on the sizes of this and other:
- If there are more elements in
this than other.size, then it iterates over other by calling its keys() method, and constructs a new set with all elements in this that are not seen in other. - Otherwise, it iterates over the elements in
this, and constructs a new set with all elements e in this that cause other.has(e) to return a falsy value.
The order of elements in the returned set is the same as in this.