Inheritance |
Collection, CustomDebugStringConvertible, CustomReflectable, CustomStringConvertible, Equatable, ExpressibleByArrayLiteral, Hashable, Sequence, SetAlgebra
View Protocol Hierarchy →
|
---|---|
Nested Types | Set.Index |
Import |
|
Initializers
Creates a new set from a finite sequence of items.
Use this initializer to create a new set from an existing sequence, for example, an array or a range.
let
validIndices
=
Set
(
0
..
<
7
).
subtracting
([
2
,
4
,
5
])
(
validIndices
)
// Prints "[6, 0, 1, 3]"
This initializer can also be used to restore set methods after performing
sequence operations such as filter(_:)
or map(_:)
on a set. For
example, after filtering a set of prime numbers to remove any below 10,
you can create a new set by using this initializer.
sequence
: The elements to use as members of the new set.
Declaration
init
<
Source
where
Source
:
Sequence
,
Source
.
Iterator
.
Element
==
Element
>
(
_
sequence
:
Source
)
Declared In
Set
, SetAlgebra
Creates a set containing the elements of the given array literal.
Do not call this initializer directly. It is used by the compiler when you use an array literal. Instead, create a new set using an array literal as its value by enclosing a comma-separated list of values in square brackets. You can use an array literal anywhere a set is expected by the type context.
Here, a set of strings is created from an array literal holding only strings.
let
ingredients
:
Set
= [
"cocoa beans"
,
"sugar"
,
"cocoa butter"
,
"salt"
]
if
ingredients
.
isSuperset
(
of
: [
"sugar"
,
"salt"
]) {
(
"Whatever it is, it's bound to be delicious!"
)
}
// Prints "Whatever it is, it's bound to be delicious!"
elements
: A variadic list of elements of the new set.
Declaration
init
(
arrayLiteral
elements
:
Element
...)
Declared In
Set
, SetAlgebra
Creates a new, empty set with at least the specified number of elements' worth of buffer.
Use this initializer to avoid repeated reallocations of a set's buffer
if you know you'll be adding elements to the set after creation. The
actual capacity of the created set will be the smallest power of 2 that
is greater than or equal to minimumCapacity
.
minimumCapacity
: The minimum number of elements that the
newly created set should be able to store without reallocating its
buffer.
Declaration
init
(
minimumCapacity
:
Int
)
Instance Variables
A string that represents the contents of the set, suitable for debugging.
Declaration
var
debugDescription
:
String
{
get
}
The "past the end" position for the set---that is, the position one greater than the last valid subscript argument.
If the set is empty, endIndex
is equal to startIndex
.
Declaration
var
endIndex
:
Set
<
Element
>
.
Index
{
get
}
The first element of the set.
The first element of the set is not necessarily the first element added to the set. Don't expect any particular ordering of set elements.
If the set is empty, the value of this property is nil
.
Declaration
var
first
:
Element
? {
get
}
The hash value for the set.
Two sets that are equal will always have equal hash values.
Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.
Declaration
var
hashValue
:
Int
{
get
}
A Boolean value that indicates whether the set is empty.
Declaration
var
isEmpty
:
Bool
{
get
}
Declared In
Set
, SetAlgebra
, Collection
A view onto this collection that provides lazy implementations of
normally eager operations, such as map
and filter
.
Use the lazy
property when chaining operations to prevent
intermediate operations from allocating storage, or when you only
need a part of the final collection to avoid unnecessary computation.
See Also: LazySequenceProtocol
, LazyCollectionProtocol
.
Declaration
var
lazy
:
LazyCollection
<
Set
<
Element
>
>
{
get
}
Declared In
Collection
The starting position for iterating members of the set.
If the set is empty, startIndex
is equal to endIndex
.
Declaration
var
startIndex
:
Set
<
Element
>
.
Index
{
get
}
A value less than or equal to the number of elements in the collection.
Complexity: O(1) if the collection conforms to
RandomAccessCollection
; otherwise, O(n), where n is the length
of the collection.
Declaration
var
underestimatedCount
:
Int
{
get
}
Declared In
Collection
, Sequence
2 inherited items hidden. (Show all)
Subscripts
Accesses the member at the given position.
Declaration
subscript
(
position
:
Set
<
Element
>
.
Index
) -
>
Element
{
get
}
Instance Methods
Returns a Boolean value that indicates whether the given element exists in the set.
This example uses the contains(_:)
method to test whether an integer is
a member of a set of prime numbers.
let
primes
:
Set
= [
2
,
3
,
5
,
7
]
let
x
=
5
if
primes
.
contains
(
x
) {
(
"\(
x
) is prime!"
)
}
else
{
(
"\(
x
). Not prime."
)
}
// Prints "5 is prime!"
member
: An element to look for in the set.
Returns: true
if member
exists in the set; otherwise, false
.
Declaration
func
contains
(
_
member
:
Element
) -
>
Bool
Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
You can use the predicate to check for an element of a type that
doesn't conform to the Equatable
protocol, such as the
HTTPResponse
enumeration in this example.
enum
HTTPResponse
{
case
ok
case
error
(
Int
)
}
let
lastThreeResponses
: [
HTTPResponse
] = [.
ok
, .
ok
, .
error
(
404
)]
let
hadError
=
lastThreeResponses
.
contains
{
element
in
if
case
.
error
=
element
{
return
true
}
else
{
return
false
}
}
// 'hadError' == true
Alternatively, a predicate can be satisfied by a range of Equatable
elements or a general condition. This example shows how you can check an
array for an expense greater than $100.
let
expenses
= [
21.37
,
55.21
,
9.32
,
10.18
,
388.77
,
11.41
]
let
hasBigPurchase
=
expenses
.
contains
{ $
0
>
100
}
// 'hasBigPurchase' == true
predicate
: A closure that takes an element of the sequence
as its argument and returns a Boolean value that indicates whether
the passed element represents a match.
Returns: true
if the sequence contains an element that satisfies
predicate
; otherwise, false
.
Declaration
Declared In
Collection
, Sequence
Returns a subsequence by skipping elements while predicate
returns
true
and returning the remaining elements.
predicate
: A closure that takes an element of the
sequence as its argument and returns true
if the element should
be skipped or false
if it should be included. Once the predicate
returns false
it will not be called again.
Complexity: O(n), where n is the length of the collection.
Declaration
Declared In
Collection
Returns a subsequence containing all but the first element of the sequence.
The following example drops the first element from an array of integers.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropFirst
())
// Prints "[2, 3, 4, 5]"
If the sequence has no elements, the result is an empty subsequence.
let
empty
: [
Int
] = []
(
empty
.
dropFirst
())
// Prints "[]"
Returns: A subsequence starting after the first element of the sequence.
Complexity: O(1)
Declaration
func
dropFirst
() -
>
Set
<
Element
>
.
SubSequence
Declared In
Collection
, Sequence
Returns a subsequence containing all but the given number of initial elements.
If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropFirst
(
2
))
// Prints "[3, 4, 5]"
(
numbers
.
dropFirst
(
10
))
// Prints "[]"
n
: The number of elements to drop from the beginning of
the collection. n
must be greater than or equal to zero.
Returns: A subsequence starting after the specified number of
elements.
Complexity: O(n), where n is the number of elements to drop from the beginning of the collection.
Declaration
Declared In
Collection
Returns a subsequence containing all but the last element of the sequence.
The sequence must be finite.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropLast
())
// Prints "[1, 2, 3, 4]"
If the sequence has no elements, the result is an empty subsequence.
let
empty
: [
Int
] = []
(
empty
.
dropLast
())
// Prints "[]"
Returns: A subsequence leaving off the last element of the sequence.
Complexity: O(n), where n is the length of the sequence.
Declaration
func
dropLast
() -
>
Set
<
Element
>
.
SubSequence
Declared In
Collection
, Sequence
Returns a subsequence containing all but the specified number of final elements.
If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropLast
(
2
))
// Prints "[1, 2, 3]"
(
numbers
.
dropLast
(
10
))
// Prints "[]"
n
: The number of elements to drop off the end of the
collection. n
must be greater than or equal to zero.
Returns: A subsequence that leaves off the specified number of elements
at the end.
Complexity: O(n), where n is the length of the collection.
Declaration
Declared In
Collection
Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements, using the given predicate as the equivalence test.
At least one of the sequences must be finite.
The predicate must be a equivalence relation over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areEquivalent(a, a)
is alwaystrue
. (Reflexivity)areEquivalent(a, b)
impliesareEquivalent(b, a)
. (Symmetry)- If
areEquivalent(a, b)
andareEquivalent(b, c)
are bothtrue
, thenareEquivalent(a, c)
is alsotrue
. (Transitivity)
Parameters:
other: A sequence to compare to this sequence.
areEquivalent: A predicate that returns true
if its two arguments
are equivalent; otherwise, false
.
Returns: true
if this sequence and other
contain equivalent items,
using areEquivalent
as the equivalence test; otherwise, false.
See Also: elementsEqual(_:)
Declaration
Declared In
Collection
, Sequence
Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero, and x represents an element of the sequence.
This example enumerates the characters of the string "Swift" and prints each character along with its place in the string.
for
(
n
,
c
)
in
"Swift"
.
characters
.
enumerated
() {
(
"\(
n
): '\(
c
)'"
)
}
// Prints "0: 'S'"
// Prints "1: 'w'"
// Prints "2: 'i'"
// Prints "3: 'f'"
// Prints "4: 't'"
When enumerating a collection, the integer part of each pair is a counter
for the enumeration, not necessarily the index of the paired value.
These counters can only be used as indices in instances of zero-based,
integer-indexed collections, such as Array
and ContiguousArray
. For
other collections the counters may be out of range or of the wrong type
to use as an index. To iterate over the elements of a collection with its
indices, use the zip(_:_:)
function.
This example iterates over the indices and elements of a set, building a list of indices of names with five or fewer letters.
Now that the shorterIndices
array holds the indices of the shorter
names in the names
set, you can use those indices to access elements in
the set.
for
i
in
shorterIndices
{
(
names
[
i
])
}
// Prints "Sofia"
// Prints "Mateo"
Returns: A sequence of pairs enumerating the sequence.
Declaration
func
enumerated
() -
>
EnumeratedSequence
<
Set
<
Element
>
>
Declared In
Collection
, Sequence
Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
In this example, filter
is used to include only names shorter than
five characters.
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
let
shortNames
=
cast
.
filter
{ $
0
.
characters
.
count
<
5
}
(
shortNames
)
// Prints "["Kim", "Karl"]"
isIncluded
: A closure that takes an element of the
sequence as its argument and returns a Boolean value indicating
whether the element should be included in the returned array.
Returns: An array of the elements that includeElement
allowed.
Declaration
Declared In
Collection
, Sequence
Returns the first element of the sequence that satisfies the given predicate.
The following example uses the first(where:)
method to find the first
negative number in an array of integers:
let
numbers
= [
3
,
7
,
4
, -
2
,
9
, -
6
,
10
,
1
]
if
let
firstNegative
=
numbers
.
first
(
where
: { $
0
<
0
}) {
(
"The first negative number is \(
firstNegative
)."
)
}
// Prints "The first negative number is -2."
predicate
: A closure that takes an element of the sequence as
its argument and returns a Boolean value indicating whether the
element is a match.
Returns: The first element of the sequence that satisfies predicate
,
or nil
if there is no element that satisfies predicate
.
Declaration
Declared In
Collection
, Sequence
Returns an array containing the non-nil
results of calling the given
transformation with each element of this sequence.
Use this method to receive an array of nonoptional values when your transformation produces an optional value.
In this example, note the difference in the result of using map
and
flatMap
with a transformation that returns an optional Int
value.
transform
: A closure that accepts an element of this
sequence as its argument and returns an optional value.
Returns: An array of the non-nil
results of calling transform
with each element of the sequence.
Complexity: O(m + n), where m is the length of this sequence and n is the length of the result.
Declaration
func
flatMap
<
ElementOfResult
>
(
_
transform
: (
Set
<
Element
>
.
Iterator
.
Element
)
throws
-
>
ElementOfResult
?)
rethrows
-
>
[
ElementOfResult
]
Declared In
Collection
, Sequence
Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
Use this method to receive a single-level collection when your transformation produces a sequence or collection for each element.
In this example, note the difference in the result of using map
and
flatMap
with a transformation that returns an array.
In fact, s.flatMap(transform)
is equivalent to
Array(s.map(transform).joined())
.
transform
: A closure that accepts an element of this
sequence as its argument and returns a sequence or collection.
Returns: The resulting flattened array.
Complexity: O(m + n), where m is the length of this sequence
and n is the length of the result.
See Also: joined()
, map(_:)
Declaration
Declared In
Collection
, Sequence
Calls the given closure on each element in the sequence in the same order
as a for
-in
loop.
The two loops in the following example produce the same output:
let
numberWords
= [
"one"
,
"two"
,
"three"
]
for
word
in
numberWords
{
(
word
)
}
// Prints "one"
// Prints "two"
// Prints "three"
numberWords
.
forEach
{
word
in
(
word
)
}
// Same as above
Using the forEach
method is distinct from a for
-in
loop in two
important ways:
- You cannot use a
break
orcontinue
statement to exit the current call of thebody
closure or skip subsequent calls. - Using the
return
statement in thebody
closure will exit only from the current call tobody
, not from any outer scope, and won't skip subsequent calls.
body
: A closure that takes an element of the sequence as a
parameter.
Declaration
Declared In
Collection
, Sequence
Removes the elements of the set that aren't also in the given sequence.
In the following example, the elements of the employees
set that are
not also members of the neighbors
set are removed. In particular, the
names "Alicia"
, "Chris"
, and "Diana"
are removed.
var
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
,
"Greta"
]
employees
.
formIntersection
(
neighbors
)
(
employees
)
// Prints "["Bethany", "Eric"]"
other
: A sequence of elements. other
must be finite.
Declaration
mutating
func
formIntersection
<
S
where
S
:
Sequence
,
S
.
Iterator
.
Element
==
Element
>
(
_
other
:
S
)
Removes the elements of the set that are also in the given sequence and adds the members of the sequence that are not already in the set.
In the following example, the elements of the employees
set that are
also members of neighbors
are removed from employees
, while the
elements of neighbors
that are not members of employees
are added to
employees
. In particular, the names "Alicia"
, "Chris"
, and
"Diana"
are removed from employees
while the names "Forlani"
and
"Greta"
are added.
other
: Another set.
Declaration
mutating
func
formSymmetricDifference
(
_
other
:
Set
<
Set
.
Element
>
)
Replace this set with the elements contained in this set or the given set, but not both.
In the following example, the elements of the employees
set that are
also members of neighbors
are removed from employees
, while the
elements of neighbors
that are not members of employees
are added to
employees
. In particular, the names "Alicia"
, "Chris"
, and
"Diana"
are removed from employees
while the name "Forlani"
is
added.
var
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
]
employees
.
formSymmetricDifference
(
neighbors
)
(
employees
)
// Prints "["Diana", "Forlani", "Alicia"]"
other
: A sequence of elements. other
must be finite.
Declaration
mutating
func
formSymmetricDifference
<
S
where
S
:
Sequence
,
S
.
Iterator
.
Element
==
Element
>
(
_
other
:
S
)
Inserts the elements of the given sequence into the set.
If the set already contains one or more elements that are also in
other
, the existing members are kept. If other
contains multiple
instances of equivalent elements, only the first instance is kept.
var
attendees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
let
visitors
= [
"Diana"
,
""
Marcia
", "
Nathaniel
"]
attendees
.
formUnion
(
visitors
)
(
attendees
)
// Prints "["Diana", "Nathaniel", "Bethany", "Alicia", "Marcia"]"
other
: A sequence of elements. other
must be finite.
Declaration
mutating
func
formUnion
<
S
where
S
:
Sequence
,
S
.
Iterator
.
Element
==
Element
>
(
_
other
:
S
)
Returns the position immediately after the given index.
The successor of an index must be well defined. For an index i
into a
collection c
, calling c.index(after: i)
returns the same index every
time.
i
: A valid index of the collection. i
must be less than
endIndex
.
Returns: The index value immediately after i
.
Declaration
Returns the index of the given element in the set, or nil
if the
element is not a member of the set.
member
: An element to search for in the set.
Returns: The index of member
if it exists in the set; otherwise,
nil
.
Declaration
func
index
(
of
member
:
Set
.
Element
) -
>
Set
<
Element
>
.
Index
?
Returns the first index in which an element of the collection satisfies the given predicate.
You can use the predicate to find an element of a type that doesn't
conform to the Equatable
protocol or to find an element that matches
particular criteria. Here's an example that finds a student name that
begins with the letter "A":
let
students
= [
"Kofi"
,
"Abena"
,
"Peter"
,
"Kweku"
,
"Akosua"
]
if
let
i
=
students
.
index
(
where
: { $
0
.
hasPrefix
(
"A"
) }) {
(
"\(
students
[
i
]
) starts with 'A'!"
)
}
// Prints "Abena starts with 'A'!"
predicate
: A closure that takes an element as its argument
and returns a Boolean value that indicates whether the passed element
represents a match.
Returns: The index of the first element for which predicate
returns
true
. If no elements in the collection satisfy the given predicate,
returns nil
.
See Also: index(of:)
Declaration
Declared In
Collection
Inserts the given element in the set if it is not already present.
If an element equal to newMember
is already contained in the set, this
method has no effect. In the following example, a new element is
inserted into classDays
, a set of days of the week. When an existing
element is inserted, the classDays
set does not change.
enum
DayOfTheWeek
:
Int
{
case
sunday
,
monday
,
tuesday
,
wednesday
,
thursday
,
friday
,
saturday
}
var
classDays
:
Set
<
DayOfTheWeek
>
= [.
wednesday
, .
friday
]
(
classDays
.
insert
(.
monday
))
// Prints "(true, .monday)"
(
classDays
)
// Prints "[.friday, .wednesday, .monday]"
(
classDays
.
insert
(.
friday
))
// Prints "(false, .friday)"
(
classDays
)
// Prints "[.friday, .wednesday, .monday]"
newMember
: An element to insert into the set.
Returns: (true, newMember)
if newMember
was not contained in the
set. If an element equal to newMember
was already contained in the
set, the method returns (false, oldMember)
, where oldMember
is the
element that was equal to newMember
. In some cases, oldMember
may
be distinguishable from newMember
by identity comparison or some
other means.
Declaration
mutating
func
insert
(
_
newMember
:
Element
) -
>
(
inserted
:
Bool
,
memberAfterInsert
:
Element
)
Returns a new set with the elements that are common to both this set and the given sequence.
In the following example, the bothNeighborsAndEmployees
set is made up
of the elements that are in both the employees
and neighbors
sets.
Elements that are in only one or the other are left out of the result of
the intersection.
other
: Another set.
Returns: A new set.
Declaration
Returns a new set with the elements that are common to both this set and the given sequence.
In the following example, the bothNeighborsAndEmployees
set is made up
of the elements that are in both the employees
and neighbors
sets.
Elements that are in only one or the other are left out of the result of
the intersection.
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
,
"Greta"
]
let
bothNeighborsAndEmployees
=
employees
.
intersection
(
neighbors
)
(
bothNeighborsAndEmployees
)
// Prints "["Bethany", "Eric"]"
other
: A sequence of elements. other
must be finite.
Returns: A new set.
Declaration
Returns a Boolean value that indicates whether this set has no members in common with the given set.
In the following example, the employees
set is disjoint with the
visitors
set because no name appears in both sets.
other
: Another set.
Returns: true
if the set has no elements in common with other
;
otherwise, false
.
Declaration
Returns a Boolean value that indicates whether the set has no members in common with the given set.
In the following example, the employees
set is disjoint with the
visitors
set because no name appears in both sets.
other
: A set of the same type as the current set.
Returns: true
if the set has no elements in common with other
;
otherwise, false
.
Declaration
Declared In
SetAlgebra
Returns a Boolean value that indicates whether the set has no members in common with the given sequence.
In the following example, the employees
set is disjoint with the
elements of the visitors
array because no name appears in both.
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
visitors
= [
"Marcia"
,
"Nathaniel"
,
"Olivia"
]
(
employees
.
isDisjoint
(
with
:
visitors
))
// Prints "true"
other
: A sequence of elements. other
must be finite.
Returns: true
if the set has no elements in common with other
;
otherwise, false
.
Declaration
Returns a Boolean value that indicates whether the set is a strict subset of the given sequence.
Set A is a strict subset of another set B if every member of A is also a member of B and B contains at least one element that is not a member of A.
other
: Another set.
Returns: true
if the set is a strict subset of
other
; otherwise, false
.
Declaration
Returns a Boolean value that indicates whether this set is a strict subset of the given set.
Set A is a strict subset of another set B if every member of A is also a member of B and B contains at least one element that is not a member of A.
other
: A set of the same type as the current set.
Returns: true
if the set is a strict subset of other
; otherwise,
false
.
Declaration
Declared In
SetAlgebra
Returns a Boolean value that indicates whether the set is a strict subset of the given sequence.
Set A is a strict subset of another set B if every member of A is also a member of B and B contains at least one element that is not a member of A.
let
employees
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
attendees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
(
attendees
.
isStrictSubset
(
of
:
employees
))
// Prints "true"
// A set is never a strict subset of itself:
(
attendees
.
isStrictSubset
(
of
:
attendees
))
// Prints "false"
possibleStrictSuperset
: A sequence of elements.
possibleStrictSuperset
must be finite.
Returns: true
is the set is strict subset of
possibleStrictSuperset
; otherwise, false
.
Declaration
Returns a Boolean value that indicates whether the set is a strict superset of the given sequence.
Set A is a strict superset of another set B if every member of B is also a member of A and A contains at least one element that is not a member of B.
other
: Another set.
Returns: true
if the set is a strict superset of
other
; otherwise, false
.
Declaration
Returns a Boolean value that indicates whether this set is a strict superset of the given set.
Set A is a strict superset of another set B if every member of B is also a member of A and A contains at least one element that is not a member of B.
other
: A set of the same type as the current set.
Returns: true
if the set is a strict superset of other
; otherwise,
false
.
Declaration
Declared In
SetAlgebra
Returns a Boolean value that indicates whether the set is a strict superset of the given sequence.
Set A is a strict superset of another set B if every member of B is also a member of A and A contains at least one element that is not a member of B.
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
attendees
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
(
employees
.
isStrictSuperset
(
of
:
attendees
))
// Prints "true"
(
employees
.
isStrictSuperset
(
of
:
employees
))
// Prints "false"
possibleStrictSubset
: A sequence of elements.
possibleStrictSubset
must be finite.
Returns: true
if the set is a strict superset of
possibleStrictSubset
; otherwise, false
.
Declaration
Returns a Boolean value that indicates whether this set is a subset of the given set.
Set A is a subset of another set B if every member of A is also a member of B.
other
: Another set.
Returns: true
if the set is a subset of other
; otherwise, false
.
Declaration
Returns a Boolean value that indicates whether the set is a subset of another set.
Set A is a subset of another set B if every member of A is also a member of B.
other
: A set of the same type as the current set.
Returns: true
if the set is a subset of other
; otherwise, false
.
Declaration
Declared In
SetAlgebra
Returns a Boolean value that indicates whether the set is a subset of the given sequence.
Set A is a subset of another set B if every member of A is also a member of B.
let
employees
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
attendees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
(
attendees
.
isSubset
(
of
:
employees
))
// Prints "true"
possibleSuperset
: A sequence of elements. possibleSuperset
must be finite.
Returns: true
if the set is a subset of possibleSuperset
;
otherwise, false
.
Declaration
Returns a Boolean value that indicates whether this set is a superset of the given set.
Set A is a superset of another set B if every member of B is also a member of A.
other
: Another set.
Returns: true
if the set is a superset of other
; otherwise,
false
.
Declaration
Returns a Boolean value that indicates whether the set is a superset of the given set.
Set A is a superset of another set B if every member of B is also a member of A.
other
: A set of the same type as the current set.
Returns: true
if the set is a superset of other
; otherwise,
false
.
Declaration
Declared In
SetAlgebra
Returns a Boolean value that indicates whether the set is a superset of the given sequence.
Set A is a superset of another set B if every member of B is also a member of A.
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
attendees
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
(
employees
.
isSuperset
(
of
:
attendees
))
// Prints "true"
possibleSubset
: A sequence of elements. possibleSubset
must
be finite.
Returns: true
if the set is a superset of possibleSubset
;
otherwise, false
.
Declaration
Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
The predicate must be a strict weak ordering over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areInIncreasingOrder(a, a)
is alwaysfalse
. (Irreflexivity)- If
areInIncreasingOrder(a, b)
andareInIncreasingOrder(b, c)
are bothtrue
, thenareInIncreasingOrder(a, c)
is alsotrue
. (Transitive comparability) - Two elements are incomparable if neither is ordered before the other
according to the predicate. If
a
andb
are incomparable, andb
andc
are incomparable, thena
andc
are also incomparable. (Transitive incomparability)
Parameters:
other: A sequence to compare to this sequence.
areInIncreasingOrder: A predicate that returns true
if its first
argument should be ordered before its second argument; otherwise,
false
.
Returns: true
if this sequence precedes other
in a dictionary
ordering as ordered by areInIncreasingOrder
; otherwise, false
.
Note: This method implements the mathematical notion of lexicographical
ordering, which has no connection to Unicode. If you are sorting
strings to present to the end user, use String
APIs that perform
localized comparison instead.
See Also: lexicographicallyPrecedes(_:)
Declaration
Declared In
Collection
, Sequence
Returns an iterator over the members of the set.
Declaration
func
makeIterator
() -
>
SetIterator
<
Element
>
Returns an array containing the results of mapping the given closure over the sequence's elements.
In this example, map
is used first to convert the names in the array
to lowercase strings and then to count their characters.
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
let
lowercaseNames
=
cast
.
map
{ $
0
.
lowercaseString
}
// 'lowercaseNames' == ["vivien", "marlon", "kim", "karl"]
let
letterCounts
=
cast
.
map
{ $
0
.
characters
.
count
}
// 'letterCounts' == [6, 6, 3, 4]
transform
: A mapping closure. transform
accepts an
element of this sequence as its parameter and returns a transformed
value of the same or of a different type.
Returns: An array containing the transformed elements of this
sequence.
Declaration
func
map
<
T
>
(
_
transform
: (
Set
<
Element
>
.
Iterator
.
Element
)
throws
-
>
T
)
rethrows
-
>
[
T
]
Declared In
Collection
, Sequence
Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
The predicate must be a strict weak ordering over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areInIncreasingOrder(a, a)
is alwaysfalse
. (Irreflexivity)- If
areInIncreasingOrder(a, b)
andareInIncreasingOrder(b, c)
are bothtrue
, thenareInIncreasingOrder(a, c)
is alsotrue
. (Transitive comparability) - Two elements are incomparable if neither is ordered before the other
according to the predicate. If
a
andb
are incomparable, andb
andc
are incomparable, thena
andc
are also incomparable. (Transitive incomparability)
This example shows how to use the max(by:)
method on a
dictionary to find the key-value pair with the highest value.
let
hues
= [
"Heliotrope"
:
296
,
"Coral"
:
16
,
"Aquamarine"
:
156
]
let
greatestHue
=
hues
.
max
{
a
,
b
in
a
.
value
<
b
.
value
}
(
greatestHue
)
// Prints "Optional(("Heliotrope", 296))"
areInIncreasingOrder
: A predicate that returns true
if its
first argument should be ordered before its second argument;
otherwise, false
.
Returns: The sequence's maximum element if the sequence is not empty;
otherwise, nil
.
See Also: max()
Declaration
Declared In
Collection
, Sequence
Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
The predicate must be a strict weak ordering over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areInIncreasingOrder(a, a)
is alwaysfalse
. (Irreflexivity)- If
areInIncreasingOrder(a, b)
andareInIncreasingOrder(b, c)
are bothtrue
, thenareInIncreasingOrder(a, c)
is alsotrue
. (Transitive comparability) - Two elements are incomparable if neither is ordered before the other
according to the predicate. If
a
andb
are incomparable, andb
andc
are incomparable, thena
andc
are also incomparable. (Transitive incomparability)
This example shows how to use the min(by:)
method on a
dictionary to find the key-value pair with the lowest value.
let
hues
= [
"Heliotrope"
:
296
,
"Coral"
:
16
,
"Aquamarine"
:
156
]
let
leastHue
=
hues
.
min
{
a
,
b
in
a
.
value
<
b
.
value
}
(
leastHue
)
// Prints "Optional(("Coral", 16))"
areInIncreasingOrder
: A predicate that returns true
if its first argument should be ordered before its second
argument; otherwise, false
.
Returns: The sequence's minimum element, according to
areInIncreasingOrder
. If the sequence has no elements, returns
nil
.
See Also: min()
Declaration
Declared In
Collection
, Sequence
Removes and returns the first element of the set.
Because a set is not an ordered collection, the "first" element may not be the first element that was added to the set.
Returns: A member of the set. If the set is empty, returns nil
.
Declaration
mutating
func
popFirst
() -
>
Set
.
Element
?
Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
If the maximum length exceeds the number of elements in the collection, the result contains all the elements in the collection.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
prefix
(
2
))
// Prints "[1, 2]"
(
numbers
.
prefix
(
10
))
// Prints "[1, 2, 3, 4, 5]"
maxLength
: The maximum number of elements to return.
maxLength
must be greater than or equal to zero.
Returns: A subsequence starting at the beginning of this collection
with at most maxLength
elements.
Declaration
Declared In
Collection
Returns a subsequence from the start of the collection through the specified position.
The resulting subsequence includes the element at the position end
.
The following example searches for the index of the number 40
in an
array of integers, and then prints the prefix of the array up to, and
including, that index:
let
numbers
= [
10
,
20
,
30
,
40
,
50
,
60
]
if
let
i
=
numbers
.
index
(
of
:
40
) {
(
numbers
.
prefix
(
through
:
i
))
}
// Prints "[10, 20, 30, 40]"
end
: The index of the last element to include in the
resulting subsequence. end
must be a valid index of the collection
that is not equal to the endIndex
property.
Returns: A subsequence up to, and including, the end
position.
Complexity: O(1)
See Also: prefix(upTo:)
Declaration
Declared In
Collection
Returns a subsequence from the start of the collection up to, but not including, the specified position.
The resulting subsequence does not include the element at the position
end
. The following example searches for the index of the number 40
in an array of integers, and then prints the prefix of the array up to,
but not including, that index:
let
numbers
= [
10
,
20
,
30
,
40
,
50
,
60
]
if
let
i
=
numbers
.
index
(
of
:
40
) {
(
numbers
.
prefix
(
upTo
:
i
))
}
// Prints "[10, 20, 30]"
Passing the collection's starting index as the end
parameter results in
an empty subsequence.
(
numbers
.
prefix
(
upTo
:
numbers
.
startIndex
))
// Prints "[]"
end
: The "past the end" index of the resulting subsequence.
end
must be a valid index of the collection.
Returns: A subsequence up to, but not including, the end
position.
Complexity: O(1)
See Also: prefix(through:)
Declaration
Declared In
Collection
Returns a subsequence containing the initial elements until predicate
returns false
and skipping the remaining elements.
predicate
: A closure that takes an element of the
sequence as its argument and returns true
if the element should
be included or false
if it should be excluded. Once the predicate
returns false
it will not be called again.
Complexity: O(n), where n is the length of the collection.
Declaration
Declared In
Collection
Returns the result of combining the elements of the sequence using the given closure.
Use the reduce(_:_:)
method to produce a single value from the elements
of an entire sequence. For example, you can use this method on an array
of numbers to find their sum or product.
The nextPartialResult
closure is called sequentially with an
accumulating value initialized to initialResult
and each element of
the sequence. This example shows how to find the sum of an array of
numbers.
let
numbers
= [
1
,
2
,
3
,
4
]
let
numberSum
=
numbers
.
reduce
(
0
, {
x
,
y
in
x
+
y
})
// numberSum == 10
When numbers.reduce(_:_:)
is called, the following steps occur:
- The
nextPartialResult
closure is called withinitialResult
---0
in this case---and the first element ofnumbers
, returning the sum:1
. - The closure is called again repeatedly with the previous call's return value and each element of the sequence.
- When the sequence is exhausted, the last value returned from the closure is returned to the caller.
If the sequence has no elements, nextPartialResult
is never executed
and initialResult
is the result of the call to reduce(_:_:)
.
Parameters:
initialResult: The value to use as the initial accumulating value.
initialResult
is passed to nextPartialResult
the first time the
closure is executed.
nextPartialResult: A closure that combines an accumulating value and
an element of the sequence into a new accumulating value, to be used
in the next call of the nextPartialResult
closure or returned to
the caller.
Returns: The final accumulated value. If the sequence has no elements,
the result is initialResult
.
Declaration
func
reduce
<
Result
>
(
_
initialResult
:
Result
,
_
nextPartialResult
: (
Result
,
Set
<
Element
>
.
Iterator
.
Element
)
throws
-
>
Result
)
rethrows
-
>
Result
Declared In
Collection
, Sequence
Removes the specified element from the set.
This example removes the element "sugar"
from a set of ingredients.
var
ingredients
:
Set
= [
"cocoa beans"
,
"sugar"
,
"cocoa butter"
,
"salt"
]
let
toRemove
=
"sugar"
if
let
removed
=
ingredients
.
remove
(
toRemove
) {
(
"The recipe is now \(
removed
)-free."
)
}
// Prints "The recipe is now sugar-free."
member
: The element to remove from the set.
Returns: The value of the member
parameter if it was a member of the
set; otherwise, nil
.
Declaration
mutating
func
remove
(
_
member
:
Element
) -
>
Element
?
Declaration
mutating
func
remove
<
ConcreteElement
where
ConcreteElement
:
Hashable
>
(
_
member
:
ConcreteElement
) -
>
ConcreteElement
?
Removes the element at the given index of the set.
position
: The index of the member to remove. position
must
be a valid index of the set, and must not be equal to the set's end
index.
Returns: The element that was removed from the set.
Declaration
mutating
func
remove
(
at
position
:
Set
<
Element
>
.
Index
) -
>
Element
Removes all members from the set.
keepingCapacity
: If true
, the set's buffer capacity is
preserved; if false
, the underlying buffer is released. The
default is false
.
Declaration
mutating
func
removeAll
(
keepingCapacity
keepCapacity
:
Bool
=
default
)
Removes the first element of the set.
Because a set is not an ordered collection, the "first" element may not be the first element that was added to the set. The set must not be empty.
Complexity: Amortized O(1) if the set does not wrap a bridged NSSet
.
If the set wraps a bridged NSSet
, the performance is unspecified.
Returns: A member of the set.
Declaration
mutating
func
removeFirst
() -
>
Set
.
Element
Returns an array containing the elements of this sequence in reverse order.
The sequence must be finite.
Complexity: O(n), where n is the length of the sequence.
Returns: An array containing the elements of this sequence in reverse order.
Declaration
func
reversed
() -
>
[
Set
<
Element
>
.
Iterator
.
Element
]
Declared In
Collection
, Sequence
Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
When you want to sort a sequence of elements that don't conform to
the Comparable
protocol, pass a predicate to this method that returns
true
when the first element passed should be ordered before the
second. The elements of the resulting array are ordered according to the
given predicate.
The predicate must be a strict weak ordering over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areInIncreasingOrder(a, a)
is alwaysfalse
. (Irreflexivity)- If
areInIncreasingOrder(a, b)
andareInIncreasingOrder(b, c)
are bothtrue
, thenareInIncreasingOrder(a, c)
is alsotrue
. (Transitive comparability) - Two elements are incomparable if neither is ordered before the other
according to the predicate. If
a
andb
are incomparable, andb
andc
are incomparable, thena
andc
are also incomparable. (Transitive incomparability)
The sorting algorithm is not stable. A nonstable sort may change the
relative order of elements for which areInIncreasingOrder
does not
establish an order.
In the following example, the predicate provides an ordering for an array
of a custom HTTPResponse
type. The predicate orders errors before
successes and sorts the error responses by their error code.
enum
HTTPResponse
{
case
ok
case
error
(
Int
)
}
let
responses
: [
HTTPResponse
] = [.
error
(
500
), .
ok
, .
ok
, .
error
(
404
), .
error
(
403
)]
let
sortedResponses
=
responses
.
sorted
{
switch
($
0
, $
1
) {
// Order errors by code
case
let
(.
error
(
aCode
), .
error
(
bCode
)):
return
aCode
<
bCode
// All successes are equivalent, so none is before any other
case
(.
ok
, .
ok
):
return
false
// Order errors before successes
case
(.
error
, .
ok
):
return
true
case
(.
ok
, .
error
):
return
false
}
}
(
sortedResponses
)
// Prints "[.error(403), .error(404), .error(500), .ok, .ok]"
You also use this method to sort elements that conform to the
Comparable
protocol in descending order. To sort your sequence
in descending order, pass the greater-than operator (>
) as the
areInIncreasingOrder
parameter.
let
students
:
Set
= [
"Kofi"
,
"Abena"
,
"Peter"
,
"Kweku"
,
"Akosua"
]
let
descendingStudents
=
students
.
sorted
(
by
:
>
)
(
descendingStudents
)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"
Calling the related sorted()
method is equivalent to calling this
method and passing the less-than operator (<
) as the predicate.
(
students
.
sorted
())
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"
(
students
.
sorted
(
by
:
<
))
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"
areInIncreasingOrder
: A predicate that returns true
if its first
argument should be ordered before its second argument; otherwise,
false
.
Returns: A sorted array of the sequence's elements.
See Also: sorted()
Declaration
Declared In
Collection
, Sequence
Returns the longest possible subsequences of the collection, in order, that don't contain elements satisfying the given predicate.
The resulting array consists of at most maxSplits + 1
subsequences.
Elements that are used to split the sequence are not returned as part of
any subsequence.
The following examples show the effects of the maxSplits
and
omittingEmptySubsequences
parameters when splitting a string using a
closure that matches spaces. The first use of split
returns each word
that was originally separated by one or more spaces.
let
line
=
"BLANCHE: I don't want realism. I want magic!"
(
line
.
characters
.
split
(
whereSeparator
: { $
0
==
" "
})
.
map
(
String
.
init
))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"
The second example passes 1
for the maxSplits
parameter, so the
original string is split just once, into two new strings.
(
line
.
characters
.
split
(
maxSplits
:
1
,
whereSeparator
: { $
0
==
" "
}
).
map
(
String
.
init
))
// Prints "["BLANCHE:", " I don\'t want realism. I want magic!"]"
The final example passes false
for the omittingEmptySubsequences
parameter, so the returned array contains empty strings where spaces
were repeated.
(
line
.
characters
.
split
(
omittingEmptySubsequences
:
false
,
whereSeparator
: { $
0
==
" "
})
.
map
(
String
.
init
))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"
Parameters:
maxSplits: The maximum number of times to split the collection, or
one less than the number of subsequences to return. If
maxSplits + 1
subsequences are returned, the last one is a suffix
of the original collection containing the remaining elements.
maxSplits
must be greater than or equal to zero. The default value
is Int.max
.
omittingEmptySubsequences: If false
, an empty subsequence is
returned in the result for each pair of consecutive elements
satisfying the isSeparator
predicate and for each element at the
start or end of the collection satisfying the isSeparator
predicate. The default value is true
.
isSeparator: A closure that takes an element as an argument and
returns a Boolean value indicating whether the collection should be
split at that element.
Returns: An array of subsequences, split from this collection's
elements.
Declaration
Declared In
Collection
, Sequence
Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.
The predicate must be a equivalence relation over the elements. That
is, for any elements a
, b
, and c
, the following conditions must
hold:
areEquivalent(a, a)
is alwaystrue
. (Reflexivity)areEquivalent(a, b)
impliesareEquivalent(b, a)
. (Symmetry)- If
areEquivalent(a, b)
andareEquivalent(b, c)
are bothtrue
, thenareEquivalent(a, c)
is alsotrue
. (Transitivity)
Parameters:
possiblePrefix: A sequence to compare to this sequence.
areEquivalent: A predicate that returns true
if its two arguments
are equivalent; otherwise, false
.
Returns: true
if the initial elements of the sequence are equivalent
to the elements of possiblePrefix
; otherwise, false
. If
possiblePrefix
has no elements, the return value is true
.
See Also: starts(with:)
Declaration
Declared In
Collection
, Sequence
Removes the elements of the given set from this set.
In the following example, the elements of the employees
set that are
also members of the neighbors
set are removed. In particular, the
names "Bethany"
and "Eric"
are removed from employees
.
other
: Another set.
Declaration
mutating
func
subtract
(
_
other
:
Set
<
Set
.
Element
>
)
Removes the elements of the given set from this set.
In the following example, the elements of the employees
set that are
also members of the neighbors
set are removed. In particular, the
names "Bethany"
and "Eric"
are removed from employees
.
other
: A set of the same type as the current set.
Declaration
mutating
func
subtract
(
_
other
:
Set
<
Element
>
)
Declared In
SetAlgebra
Removes the elements of the given sequence from the set.
In the following example, the elements of the employees
set that are
also elements of the neighbors
array are removed. In particular, the
names "Bethany"
and "Eric"
are removed from employees
.
var
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
,
"Greta"
]
employees
.
subtract
(
neighbors
)
(
employees
)
// Prints "["Chris", "Diana", "Alicia"]"
other
: A sequence of elements. other
must be finite.
Declaration
mutating
func
subtract
<
S
where
S
:
Sequence
,
S
.
Iterator
.
Element
==
Element
>
(
_
other
:
S
)
Returns a new set containing the elements of this set that do not occur in the given set.
In the following example, the nonNeighbors
set is made up of the
elements of the employees
set that are not elements of neighbors
:
other
: Another set.
Returns: A new set.
Declaration
Returns a new set containing the elements of this set that do not occur in the given set.
In the following example, the nonNeighbors
set is made up of the
elements of the employees
set that are not elements of neighbors
:
other
: A set of the same type as the current set.
Returns: A new set.
Declaration
Declared In
SetAlgebra
Returns a new set containing the elements of this set that do not occur in the given sequence.
In the following example, the nonNeighbors
set is made up of the
elements of the employees
set that are not elements of neighbors
:
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Chris"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
,
"Greta"
]
let
nonNeighbors
=
employees
.
subtracting
(
neighbors
)
(
nonNeighbors
)
// Prints "["Chris", "Diana", "Alicia"]"
other
: A sequence of elements. other
must be finite.
Returns: A new set.
Declaration
Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
If the maximum length exceeds the number of elements in the collection, the result contains all the elements in the collection.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
suffix
(
2
))
// Prints "[4, 5]"
(
numbers
.
suffix
(
10
))
// Prints "[1, 2, 3, 4, 5]"
maxLength
: The maximum number of elements to return. The
value of maxLength
must be greater than or equal to zero.
Returns: A subsequence terminating at the end of the collection with at
most maxLength
elements.
Complexity: O(n), where n is the length of the collection.
Declaration
Declared In
Collection
, Sequence
Returns a subsequence from the specified position to the end of the collection.
The following example searches for the index of the number 40
in an
array of integers, and then prints the suffix of the array starting at
that index:
let
numbers
= [
10
,
20
,
30
,
40
,
50
,
60
]
if
let
i
=
numbers
.
index
(
of
:
40
) {
(
numbers
.
suffix
(
from
:
i
))
}
// Prints "[40, 50, 60]"
Passing the collection's endIndex
as the start
parameter results in
an empty subsequence.
(
numbers
.
suffix
(
from
:
numbers
.
endIndex
))
// Prints "[]"
start
: The index at which to start the resulting subsequence.
start
must be a valid index of the collection.
Returns: A subsequence starting at the start
position.
Complexity: O(1)
Declaration
Declared In
Collection
Returns a new set with the elements that are either in this set or in the given sequence, but not in both.
In the following example, the eitherNeighborsOrEmployees
set is made up
of the elements of the employees
and neighbors
sets that are not in
both employees
and neighbors
. In particular, the names "Bethany"
and "Eric"
do not appear in eitherNeighborsOrEmployees
.
let
employees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
,
"Eric"
]
let
neighbors
= [
"Bethany"
,
"Eric"
,
"Forlani"
]
let
eitherNeighborsOrEmployees
=
employees
.
symmetricDifference
(
neighbors
)
(
eitherNeighborsOrEmployees
)
// Prints "["Diana", "Forlani", "Alicia"]"
other
: A sequence of elements. other
must be finite.
Returns: A new set.
Declaration
Returns a new set with the elements of both this set and the given sequence.
In the following example, the attendeesAndVisitors
set is made up
of the elements of the attendees
set and the visitors
array:
let
attendees
:
Set
= [
"Alicia"
,
"Bethany"
,
"Diana"
]
let
visitors
= [
"Marcia"
,
"Nathaniel"
]
let
attendeesAndVisitors
=
attendees
.
union
(
visitors
)
(
attendeesAndVisitors
)
// Prints "["Diana", "Nathaniel", "Bethany", "Alicia", "Marcia"]"
If the set already contains one or more elements that are also in
other
, the existing members are kept. If other
contains multiple
instances of equivalent elements, only the first instance is kept.
let
initialIndices
=
Set
(
0
..
<
5
)
let
expandedIndices
=
initialIndices
.
union
([
2
,
3
,
6
,
6
,
7
,
7
])
(
expandedIndices
)
// Prints "[2, 4, 6, 7, 0, 1, 3]"
other
: A sequence of elements. other
must be finite.
Returns: A new set with the unique elements of this set and other
.
Declaration
Inserts the given element into the set unconditionally.
If an element equal to newMember
is already contained in the set,
newMember
replaces the existing element. In this example, an existing
element is inserted into classDays
, a set of days of the week.
newMember
: An element to insert into the set.
Returns: An element equal to newMember
if the set already contained
such a member; otherwise, nil
. In some cases, the returned element
may be distinguishable from newMember
by identity comparison or some
other means.
Declaration
mutating
func
update
(
with
newMember
:
Element
) -
>
Element
?
Declaration
mutating
func
update
<
ConcreteElement
where
ConcreteElement
:
Hashable
>
(
with
newMember
:
ConcreteElement
) -
>
ConcreteElement
?
36 inherited items hidden. (Show all)
Conditionally Inherited Items
The initializers, methods, and properties listed below may be available on this type under certain conditions (such as methods that are available on Array
when its elements are Equatable
) or may not ever be available if that determination is beyond SwiftDoc.org's capabilities. Please open an issue on GitHub if you see something out of place!
Where Base.Iterator == Iterator
Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
In this example, filter
is used to include only names shorter than five
characters.
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
let
shortNames
=
cast
.
filter
{ $
0
.
characters
.
count
<
5
}
(
shortNames
)
// Prints "["Kim", "Karl"]"
includeElement
: A closure that takes an element of the
sequence as its argument and returns a Boolean value indicating
whether the element should be included in the returned array.
Returns: An array of the elements that includeElement
allowed.
Declaration
Declared In
Collection
, Sequence
Returns an iterator over the elements of this sequence.
Declaration
func
makeIterator
() -
>
Set
<
Element
>
.
Base
.
Iterator
Declared In
Collection
, Sequence
Returns an array containing the results of mapping the given closure over the sequence's elements.
In this example, map
is used first to convert the names in the array to
lowercase strings and then to count their characters.
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
let
lowercaseNames
=
cast
.
map
{ $
0
.
lowercaseString
}
// 'lowercaseNames' == ["vivien", "marlon", "kim", "karl"]
let
letterCounts
=
cast
.
map
{ $
0
.
characters
.
count
}
// 'letterCounts' == [6, 6, 3, 4]
transform
: A mapping closure. transform
accepts an
element of this sequence as its parameter and returns a transformed
value of the same or of a different type.
Returns: An array containing the transformed elements of this
sequence.
Declaration
func
map
<
T
>
(
_
transform
: (
Set
<
Element
>
.
Base
.
Iterator
.
Element
)
throws
-
>
T
)
rethrows
-
>
[
T
]
Declared In
Collection
, Sequence
3 inherited items hidden. (Show all)
Where Indices == DefaultIndices, Indices.Index == Index, Indices.IndexDistance == Int, Indices.Iterator == IndexingIterator>, Indices.SubSequence == DefaultIndices, Indices._Element == Index, Indices.IndexDistance.IntegerLiteralType == Int, Indices.IndexDistance.Stride == Int, Indices.IndexDistance._DisabledRangeIndex == Int._DisabledRangeIndex, Indices.Iterator.Element == Index, Indices.IndexDistance.Stride.IntegerLiteralType == Int
The indices that are valid for subscripting the collection, in ascending order.
A collection's indices
property can hold a strong reference to the
collection itself, causing the collection to be non-uniquely referenced.
If you mutate the collection while iterating over its indices, a strong
reference can cause an unexpected copy of the collection. To avoid the
unexpected copy, use the index(after:)
method starting with
startIndex
to produce indices instead.
var
c
=
MyFancyCollection
([
10
,
20
,
30
,
40
,
50
])
var
i
=
c
.
startIndex
while
i
!=
c
.
endIndex
{
c
[
i
] /=
5
i
=
c
.
index
(
after
:
i
)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])
Declaration
var
indices
:
DefaultIndices
<
Set
<
Element
>
>
{
get
}
Declared In
Collection
1 inherited item hidden. (Show all)
Where Iterator == IndexingIterator, Iterator.Element == _Element
Returns an iterator over the elements of the collection.
Declaration
func
makeIterator
() -
>
IndexingIterator
<
Set
<
Element
>
>
Declared In
Collection
1 inherited item hidden. (Show all)
Where Iterator == Self
Returns an iterator over the elements of this sequence.
Declaration
func
makeIterator
() -
>
Set
<
Element
>
Declared In
Collection
, Sequence
1 inherited item hidden. (Show all)
Where Iterator.Element : Collection
Returns the elements of this collection of collections, concatenated.
In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.
let
ranges
= [
0
..
<
3
,
8
..
<
10
,
15
..
<
17
]
// A for-in loop over 'ranges' accesses each range:
for
range
in
ranges
{
(
range
)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"
// Use 'joined()' to access each element of each range:
for
index
in
ranges
.
joined
() {
(
index
,
terminator
:
" "
)
}
// Prints: "0 1 2 8 9 15 16"
Returns: A flattened view of the elements of this collection of collections.
See Also: flatMap(_:)
, joined(separator:)
Declaration
func
joined
() -
>
FlattenCollection
<
Set
<
Element
>
>
Declared In
Collection
1 inherited item hidden. (Show all)
Where Iterator.Element : Comparable
Returns a Boolean value indicating whether the sequence precedes another
sequence in a lexicographical (dictionary) ordering, using the
less-than operator (<
) to compare elements.
This example uses the lexicographicallyPrecedes
method to test which
array of integers comes first in a lexicographical ordering.
let
a
= [
1
,
2
,
2
,
2
]
let
b
= [
1
,
2
,
3
,
4
]
(
a
.
lexicographicallyPrecedes
(
b
))
// Prints "true"
(
b
.
lexicographicallyPrecedes
(
b
))
// Prints "false"
other
: A sequence to compare to this sequence.
Returns: true
if this sequence precedes other
in a dictionary
ordering; otherwise, false
.
Note: This method implements the mathematical notion of lexicographical
ordering, which has no connection to Unicode. If you are sorting
strings to present to the end user, use String
APIs that
perform localized comparison.
See Also: lexicographicallyPrecedes(_:by:)
Declaration
Declared In
Collection
, Sequence
Returns the maximum element in the sequence.
This example finds the smallest value in an array of height measurements.
let
heights
= [
67.5
,
65.7
,
64.3
,
61.1
,
58.5
,
60.3
,
64.9
]
let
greatestHeight
=
heights
.
max
()
(
greatestHeight
)
// Prints "Optional(67.5)"
Returns: The sequence's maximum element. If the sequence has no
elements, returns nil
.
See Also: max(by:)
Declaration
@
warn_unqualified_access
func
max
() -
>
Set
<
Element
>
.
Iterator
.
Element
?
Declared In
Collection
, Sequence
Returns the minimum element in the sequence.
This example finds the smallest value in an array of height measurements.
let
heights
= [
67.5
,
65.7
,
64.3
,
61.1
,
58.5
,
60.3
,
64.9
]
let
lowestHeight
=
heights
.
min
()
(
lowestHeight
)
// Prints "Optional(58.5)"
Returns: The sequence's minimum element. If the sequence has no
elements, returns nil
.
See Also: min(by:)
Declaration
@
warn_unqualified_access
func
min
() -
>
Set
<
Element
>
.
Iterator
.
Element
?
Declared In
Collection
, Sequence
Returns the elements of the sequence, sorted.
You can sort any sequence of elements that conform to the
Comparable
protocol by calling this method. Elements are sorted in
ascending order.
The sorting algorithm is not stable. A nonstable sort may change the relative order of elements that compare equal.
Here's an example of sorting a list of students' names. Strings in Swift
conform to the Comparable
protocol, so the names are sorted in
ascending order according to the less-than operator (<
).
let
students
:
Set
= [
"Kofi"
,
"Abena"
,
"Peter"
,
"Kweku"
,
"Akosua"
]
let
sortedStudents
=
students
.
sorted
()
(
sortedStudents
)
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"
To sort the elements of your sequence in descending order, pass the
greater-than operator (>
) to the sorted(by:)
method.
let
descendingStudents
=
students
.
sorted
(
by
:
>
)
(
descendingStudents
)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"
Returns: A sorted array of the sequence's elements.
See Also: sorted(by:)
Declaration
func
sorted
() -
>
[
Set
<
Element
>
.
Iterator
.
Element
]
Declared In
Collection
, Sequence
4 inherited items hidden. (Show all)
Where Iterator.Element : Equatable
Returns a Boolean value indicating whether the sequence contains the given element.
This example checks to see whether a favorite actor is in an array storing a movie's cast.
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
(
cast
.
contains
(
"Marlon"
))
// Prints "true"
(
cast
.
contains
(
"James"
))
// Prints "false"
element
: The element to find in the sequence.
Returns: true
if the element was found in the sequence; otherwise,
false
.
Declaration
Declared In
Collection
, Sequence
Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
At least one of the sequences must be finite.
This example tests whether one countable range shares the same elements as another countable range and an array.
let
a
=
1
...
3
let
b
=
1
...
10
(
a
.
elementsEqual
(
b
))
// Prints "false"
(
a
.
elementsEqual
([
1
,
2
,
3
]))
// Prints "true"
other
: A sequence to compare to this sequence.
Returns: true
if this sequence and other
contain the same elements
in the same order.
See Also: elementsEqual(_:by:)
Declaration
Declared In
Collection
, Sequence
Returns the first index where the specified value appears in the collection.
After using index(of:)
to find the position of a particular element in
a collection, you can use it to access the element by subscripting. This
example shows how you can modify one of the names in an array of
students.
var
students
= [
"Ben"
,
"Ivy"
,
"Jordell"
,
"Maxime"
]
if
let
i
=
students
.
index
(
of
:
"Maxime"
) {
students
[
i
] =
"Max"
}
(
students
)
// Prints "["Ben", "Ivy", "Jordell", "Max"]"
element
: An element to search for in the collection.
Returns: The first index where element
is found. If element
is not
found in the collection, returns nil
.
See Also: index(where:)
Declaration
Declared In
Collection
Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.
The resulting array consists of at most maxSplits + 1
subsequences.
Elements that are used to split the collection are not returned as part
of any subsequence.
The following examples show the effects of the maxSplits
and
omittingEmptySubsequences
parameters when splitting a string at each
space character (" "). The first use of split
returns each word that
was originally separated by one or more spaces.
let
line
=
"BLANCHE: I don't want realism. I want magic!"
(
line
.
characters
.
split
(
separator
:
" "
)
.
map
(
String
.
init
))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"
The second example passes 1
for the maxSplits
parameter, so the
original string is split just once, into two new strings.
(
line
.
characters
.
split
(
separator
:
" "
,
maxSplits
:
1
)
.
map
(
String
.
init
))
// Prints "["BLANCHE:", " I don\'t want realism. I want magic!"]"
The final example passes false
for the omittingEmptySubsequences
parameter, so the returned array contains empty strings where spaces
were repeated.
(
line
.
characters
.
split
(
separator
:
" "
,
omittingEmptySubsequences
:
false
)
.
map
(
String
.
init
))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"
Parameters:
separator: The element that should be split upon.
maxSplits: The maximum number of times to split the collection, or
one less than the number of subsequences to return. If
maxSplits + 1
subsequences are returned, the last one is a suffix
of the original collection containing the remaining elements.
maxSplits
must be greater than or equal to zero. The default value
is Int.max
.
omittingEmptySubsequences: If false
, an empty subsequence is
returned in the result for each consecutive pair of separator
elements in the collection and for each instance of separator
at
the start or end of the collection. If true
, only nonempty
subsequences are returned. The default value is true
.
Returns: An array of subsequences, split from this collection's
elements.
Declaration
Declared In
Collection
, Sequence
Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
This example tests whether one countable range begins with the elements of another countable range.
let
a
=
1
...
3
let
b
=
1
...
10
(
b
.
starts
(
with
:
a
))
// Prints "true"
Passing a sequence with no elements or an empty collection as
possiblePrefix
always results in true
.
(
b
.
starts
(
with
: []))
// Prints "true"
possiblePrefix
: A sequence to compare to this sequence.
Returns: true
if the initial elements of the sequence are the same as
the elements of possiblePrefix
; otherwise, false
. If
possiblePrefix
has no elements, the return value is true
.
See Also: starts(with:by:)
Declaration
Declared In
Collection
, Sequence
5 inherited items hidden. (Show all)
Where Iterator.Element : Sequence
Returns the elements of this sequence of sequences, concatenated.
In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.
let
ranges
= [
0
..
<
3
,
8
..
<
10
,
15
..
<
17
]
// A for-in loop over 'ranges' accesses each range:
for
range
in
ranges
{
(
range
)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"
// Use 'joined()' to access each element of each range:
for
index
in
ranges
.
joined
() {
(
index
,
terminator
:
" "
)
}
// Prints: "0 1 2 8 9 15 16"
Returns: A flattened view of the elements of this sequence of sequences.
See Also: flatMap(_:)
, joined(separator:)
Declaration
func
joined
() -
>
FlattenSequence
<
Set
<
Element
>
>
Declared In
Collection
, Sequence
Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
This example shows how an array of [Int]
instances can be joined, using
another [Int]
instance as the separator:
let
nestedNumbers
= [[
1
,
2
,
3
], [
4
,
5
,
6
], [
7
,
8
,
9
]]
let
joined
=
nestedNumbers
.
joined
(
separator
: [-
1
, -
2
])
(
Array
(
joined
))
// Prints "[1, 2, 3, -1, -2, 4, 5, 6, -1, -2, 7, 8, 9]"
separator
: A sequence to insert between each of this
sequence's elements.
Returns: The joined sequence of elements.
See Also: joined()
Declaration
func
joined
<
Separator
where
Separator
:
Sequence
,
Separator
.
Iterator
.
Element
==
Set
<
Element
>
.
Iterator
.
Element
.
Iterator
.
Element
>
(
separator
:
Separator
) -
>
JoinedSequence
<
Set
<
Element
>
>
Declared In
Collection
, Sequence
2 inherited items hidden. (Show all)
Where Iterator.Element == String
Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
The following example shows how an array of strings can be joined to a single, comma-separated string:
let
cast
= [
"Vivien"
,
"Marlon"
,
"Kim"
,
"Karl"
]
let
list
=
cast
.
joined
(
separator
:
", "
)
(
list
)
// Prints "Vivien, Marlon, Kim, Karl"
separator
: A string to insert between each of the elements
in this sequence. The default separator is an empty string.
Returns: A single, concatenated string.
Declaration
Declared In
Collection
, Sequence
1 inherited item hidden. (Show all)
Where SubSequence : Sequence, SubSequence.SubSequence == SubSequence, SubSequence.Iterator.Element == Iterator.Element
Returns a subsequence by skipping the initial, consecutive elements that satisfy the given predicate.
The following example uses the drop(while:)
method to skip over the
positive numbers at the beginning of the numbers
array. The result
begins with the first element of numbers
that does not satisfy
predicate
.
let
numbers
= [
3
,
7
,
4
, -
2
,
9
, -
6
,
10
,
1
]
let
startingWithNegative
=
numbers
.
drop
(
while
: { $
0
>
0
})
// startingWithNegative == [-2, 9, -6, 10, 1]
If predicate
matches every element in the sequence, the result is an
empty sequence.
predicate
: A closure that takes an element of the sequence as
its argument and returns a Boolean value indicating whether the
element should be included in the result.
Returns: A subsequence starting after the initial, consecutive elements
that satisfy predicate
.
Complexity: O(n), where n is the length of the collection.
See Also: prefix(while:)
Declaration
func
drop
(
while
predicate
: (
Set
<
Element
>
.
Iterator
.
Element
)
throws
-
>
Bool
)
rethrows
-
>
AnySequence
<
Set
<
Element
>
.
Iterator
.
Element
>
Declared In
Collection
, Sequence
Returns a subsequence containing all but the given number of initial elements.
If the number of elements to drop exceeds the number of elements in the sequence, the result is an empty subsequence.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropFirst
(
2
))
// Prints "[3, 4, 5]"
(
numbers
.
dropFirst
(
10
))
// Prints "[]"
n
: The number of elements to drop from the beginning of
the sequence. n
must be greater than or equal to zero.
Returns: A subsequence starting after the specified number of
elements.
Complexity: O(1).
Declaration
func
dropFirst
(
_
n
:
Int
) -
>
AnySequence
<
Set
<
Element
>
.
Iterator
.
Element
>
Declared In
Collection
, Sequence
Returns a subsequence containing all but the given number of final elements.
The sequence must be finite. If the number of elements to drop exceeds the number of elements in the sequence, the result is an empty subsequence.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
dropLast
(
2
))
// Prints "[1, 2, 3]"
(
numbers
.
dropLast
(
10
))
// Prints "[]"
n
: The number of elements to drop off the end of the
sequence. n
must be greater than or equal to zero.
Returns: A subsequence leaving off the specified number of elements.
Complexity: O(n), where n is the length of the sequence.
Declaration
func
dropLast
(
_
n
:
Int
) -
>
AnySequence
<
Set
<
Element
>
.
Iterator
.
Element
>
Declared In
Collection
, Sequence
Returns a subsequence, up to the specified maximum length, containing the initial elements of the sequence.
If the maximum length exceeds the number of elements in the sequence, the result contains all the elements in the sequence.
let
numbers
= [
1
,
2
,
3
,
4
,
5
]
(
numbers
.
prefix
(
2
))
// Prints "[1, 2]"
(
numbers
.
prefix
(
10
))
// Prints "[1, 2, 3, 4, 5]"
maxLength
: The maximum number of elements to return. The
value of maxLength
must be greater than or equal to zero.
Returns: A subsequence starting at the beginning of this sequence
with at most maxLength
elements.
Complexity: O(1)
Declaration
func
prefix
(
_
maxLength
:
Int
) -
>
AnySequence
<
Set
<
Element
>
.
Iterator
.
Element
>
Declared In
Collection
, Sequence
Returns a subsequence containing the initial, consecutive elements that satisfy the given predicate.
The following example uses the prefix(while:)
method to find the
positive numbers at the beginning of the numbers
array. Every element
of numbers
up to, but not including, the first negative value is
included in the result.
let
numbers
= [
3
,
7
,
4
, -
2
,
9
, -
6
,
10
,
1
]
let
positivePrefix
=
numbers
.
prefix
(
while
: { $
0
>
0
})
// positivePrefix == [3, 7, 4]
If predicate
matches every element in the sequence, the resulting
sequence contains every element of the sequence.
predicate
: A closure that takes an element of the sequence as
its argument and returns a Boolean value indicating whether the
element should be included in the result.
Returns: A subsequence of the initial, consecutive elements that
satisfy predicate
.
Complexity: O(n), where n is the length of the collection.
See Also: drop(while:)
Declaration
func
prefix
(
while
predicate
: (
Set
<
Element
>
.
Iterator
.
Element
)
throws
-
>
Bool
)
rethrows
-
>
AnySequence
<
Set
<
Element
>
.
Iterator
.
Element
>
Declared In
Collection
, Sequence
5 inherited items hidden. (Show all)
Where SubSequence == Self
Removes and returns the first element of the collection.
Returns: The first element of the collection if the collection is
not empty; otherwise, nil
.
Complexity: O(1)
Declaration
mutating
func
popFirst
() -
>
Set
<
Element
>
.
Iterator
.
Element
?
Declared In
Collection
Removes and returns the first element of the collection.
The collection must not be empty.
Returns: The first element of the collection.
Complexity: O(1)
See Also: popFirst()
Declaration
mutating
func
removeFirst
() -
>
Set
<
Element
>
.
Iterator
.
Element
Declared In
Collection
Removes the specified number of elements from the beginning of the collection.
n
: The number of elements to remove. n
must be greater than
or equal to zero, and must be less than or equal to the number of
elements in the collection.
Complexity: O(1) if the collection conforms to
RandomAccessCollection
; otherwise, O(n).
Declaration
mutating
func
removeFirst
(
_
n
:
Int
)
Declared In
Collection
3 inherited items hidden. (Show all)
Where SubSequence == Slice, SubSequence.Index == Index, SubSequence.Iterator == IndexingIterator>, SubSequence.SubSequence == Slice, SubSequence._Element == _Element, SubSequence.Iterator.Element == _Element
Accesses a contiguous subrange of the collection's elements.
The accessed slice uses the same indices for the same elements as the
original collection uses. Always use the slice's startIndex
property
instead of assuming that its indices start at a particular value.
This example demonstrates getting a slice of an array of strings, finding the index of one of the strings in the slice, and then using that index in the original array.
let
streets
= [
"Adams"
,
"Bryant"
,
"Channing"
,
"Douglas"
,
"Evarts"
]
let
streetsSlice
=
streets
[
2
..
<
streets
.
endIndex
]
(
streetsSlice
)
// Prints "["Channing", "Douglas", "Evarts"]"
let
index
=
streetsSlice
.
index
(
of
:
"Evarts"
)
// 4
(
streets
[
index
!])
// Prints "Evarts"
bounds
: A range of the collection's indices. The bounds of
the range must be valid indices of the collection.
Complexity: O(1)
Declaration
Declared In
Collection
1 inherited item hidden. (Show all)
An unordered collection of unique elements.
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.Set Operations
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.==
) to test whether two sets contain the same elements.isSubset(of:)
method to test whether a set contains all the elements of another set or sequence.isSuperset(of:)
method to test whether all elements of a set are contained in another set or sequence.isStrictSubset(of:)
andisStrictSuperset(of:)
methods to test whether a set is a subset or superset of, but not equal to, another set.isDisjoint(with:)
method 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.symmetricDifference(_:)
method 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:
formUnion(_:)
,formIntersection(_:)
,formSymmetricDifference(_:)
, andsubtract(_:)
.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
for
-in
loop.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
Set
andNSSet
using theas
operator. For bridging to be possible, theElement
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.Bridging from
Set
toNSSet
always takes O(1) time and space. When the set'sElement
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).Bridging from
NSSet
toSet
first calls thecopy(with:)
method (**copyWithZone:**
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 ofNSSet
that are already immutable,copy(with:)
returns the same set in constant time; otherwise, the copying performance is unspecified. The instances ofNSSet
andSet
share buffer using the same copy-on-write optimization that is used when two instances ofSet
share buffer.See Also:
Hashable