new Set()
The functions below extend the built-in Set class with new functionality.
Source
Methods
difference(other) → {Set}
The usual set-theoretic difference of two sets, this one minus the other set passed as the first parameter.
Parameters
-
other
Setthe set to subtract from this one
Returns
-
Setthe difference, this set minus the other
Source
equals(other) → {boolean}
In mathematics, two sets $A$ and $B$ are equal if and only if $\forall x,(x\in A\text{ iff }x\in B)$. That is, they have exactly the same members. This function implements that definition.
Parameters
-
other
Setthe set to compare with this one for equality
Returns
-
booleanwhether the two sets have exactly the same elements
Source
intersection(other) → {Set}
The usual set-theoretic intersection of two sets, this one and any other, passed as the first parameter.
Parameters
-
other
Setthe set with which to intersect this one
Returns
-
Setthe intersection of this set with the other
Source
isSubset(other) → {boolean}
The usual $\subseteq$ relation from mathematics. Test whether this set is a
subset of the other passed as a parameter, returning true/false.
Parameters
-
other
Setthe set to be tested for whether this set is a subset of it
See
- subset() (for constructing subsets)
- isSuperset()
Returns
-
booleanwhether this set is a subset of
other
Source
isSuperset(other) → {boolean}
The usual $\supseteq$ relation from mathematics. Test whether this set is a
superset of the other passed as a parameter, returning true/false.
Parameters
-
other
Setthe set to be tested for whether this set is a superset of it
See
Returns
-
booleanwhether this set is a superset of
other
Source
subset(predicate) → {Set}
Construct a subset of this set, using precisely those elements that pass the given predicate. This is analogous to taking a set $S$ and forming a subset as we do with the mathematical notation $\{x\in S\mid P(x)\}$.
NOTE: This is not the "is a subset of" relation! This is a tool for computing subsets. If you'd like to check whether one set is a subset of another, see isSubset().
Parameters
-
predicate
functionthe predicate that elements must pass in order to be included in the subset; it will be evaluated on every element of this set and should return a boolean
Returns
-
Setthe subset of this set containing just those elements that satisfy the given predicate
Source
symmetricDifference(other) → {Set}
The usual set-theoretic symmetric difference of two sets, this one and any other, passed as the first parameter. The symmetric difference of sets $A$ and $B$, in usual mathematical notation, is $(A-B)\cup(B-A)$.
Parameters
-
other
Setthe set with which to compute the symmetric difference with this one
Returns
-
Setthe symmetric difference of this set with the other
Source
union(other) → {Set}
The usual set-theoretic union of two sets, this one and any other, passed as the first parameter.
Parameters
-
other
Setthe set with which to union this one
Returns
-
Setthe union of this set with the other