An unordered collection of unique elements.
- Xcode 6.3+
- Swift Standard Library
You use a set instead of an array when you need to test efficiently for membership and you aren’t concerned with the order of the elements in the collection, or when you need to ensure that each element appears only once in a collection.
You can create a set with any element type that conforms to the
Hashable protocol. By default, most types in the standard library are hashable, including strings, numeric and Boolean types, enumeration cases without associated values, and even sets themselves.
Swift makes it as easy to create a new set as to create a new array. Simply assign an array literal to a variable or constant with the
Set type specified.
Sets provide a suite of mathematical set operations. For example, you can efficiently test a set for membership of an element or check its intersection with another set:
contains(_:)method to test whether a set contains a specific element.
Use the “equal to” operator (
==) to test whether two sets contain the same elements.
ismethod to test whether a set contains all the elements of another set or sequence.
ismethod to test whether all elements of a set are contained in another set or sequence.
ismethods to test whether a set is a subset or superset of, but not equal to, another set.
ismethod to test whether a set has any elements in common with another set.
You can also combine, exclude, or subtract the elements of two sets:
union(_:)method to create a new set with the elements of a set and another set or sequence.
intersection(_:)method to create a new set with only the elements common to a set and another set or sequence.
symmetricmethod to create a new set with the elements that are in either a set or another set or sequence, but not in both.
subtracting(_:)method to create a new set with the elements of a set that are not also in another set or sequence.
You can modify a set in place by using these methods’ mutating counterparts:
Set operations are not limited to use with other sets. Instead, you can perform set operations with another set, an array, or any other sequence type.
Sequence and Collection Operations
In addition to the
Set type’s set operations, you can use any nonmutating sequence or collection methods with a set.
You can iterate through a set’s unordered elements with a
Many sequence and collection operations return an array or a type-erasing collection wrapper instead of a set. To restore efficient set operations, create a new set from the result.
Bridging Between Set and NSSet
You can bridge between
NSSet using the
as operator. For bridging to be possible, the
Element type of a set must be a class, an
@objc protocol (a protocol imported from Objective-C or marked with the
@objc attribute), or a type that bridges to a Foundation type.
NSSet always takes O(1) time and space. When the set’s
Element type is neither a class nor an
@objc protocol, any required bridging of elements occurs at the first access of each element, so the first operation that uses the contents of the set (for example, a membership test) can take O(n).
Set first calls the
copy(with:) method (
- copy in Objective-C) on the set to get an immutable copy and then performs additional Swift bookkeeping work that takes O(1) time. For instances of
NSSet that are already immutable,
copy(with:) returns the same set in constant time; otherwise, the copying performance is unspecified. The instances of
Set share buffer using the same copy-on-write optimization that is used when two instances of
Set share buffer.