struct Set<Element : Hashable> A collection of unique Element instances with no defined ordering. Inheritance ArrayLiteralConvertible, CollectionType, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, Indexable, SequenceType, _ObjectiveCBridgeable, _Reflectable View Protocol Hierarchy → Associated Types Index = SetIndex<Element> Generator = SetGenerator<Element> Type alias inferred. Element = Element Type alias inferred. Index = SetIndex<Element> Type alias inferred. SubSequence = Slice<Set<Element>> Type alias inferred. Import import Swift Initializers init() Create an empty Set. Declaration init() init(_:) Create a Set from a finite sequence of items. Declaration init<S : SequenceType where S.Generator.Element == Element>(_ sequence: S) init(arrayLiteral:) Declaration init(arrayLiteral elements: Element...) init(minimumCapacity:) Create an empty set with at least the given number of elements worth of storage. The actual capacity will be the smallest power of 2 that's >= minimumCapacity. Declaration init(minimumCapacity: Int) Instance Variables var count: Int The number of members in the set. Complexity: O(1). Declaration var count: Int { get } var debugDescription: String A textual representation of self, suitable for debugging. Declaration var debugDescription: String { get } var description: String A textual representation of self. Declaration var description: String { get } var endIndex: SetIndex<Element> The collection's "past the end" position. endIndex is not a valid argument to subscript, and is always reachable from startIndex by zero or more applications of successor(). Complexity: Amortized O(1) if self does not wrap a bridged NSSet, O(N) otherwise. Declaration var endIndex: SetIndex<Element> { get } var first: Element? The first element obtained when iterating, or nil if self is empty. Equivalent to self.generate().next(). Declaration var first: Element? { get } Declared In Set , CollectionType var hashValue: Int Declaration var hashValue: Int { get } var indices: Range<SetIndex<Element>> Return the range of valid index values. The result's endIndex is the same as that of self. Because Range is half-open, iterating the values of the result produces all valid subscript arguments for self, omitting its endIndex. Declaration var indices: Range<SetIndex<Element>> { get } Declared In CollectionType var isEmpty: Bool true if the set is empty. Declaration var isEmpty: Bool { get } Declared In Set , CollectionType var lazy: LazyCollection<Set<Element>> A collection with contents identical to self, but on which normally-eager operations such as map and filter are implemented lazily. See Also: LazySequenceType, LazyCollectionType. Declaration var lazy: LazyCollection<Set<Element>> { get } Declared In CollectionType var startIndex: SetIndex<Element> The position of the first element in a non-empty set. This is identical to endIndex in an empty set. Complexity: Amortized O(1) if self does not wrap a bridged NSSet, O(N) otherwise. Declaration var startIndex: SetIndex<Element> { get } Subscripts subscript(_: Range<SetIndex<Element>>) Declaration subscript(bounds: Range<SetIndex<Element>>) -> Slice<Set<Element>> { get } Declared In CollectionType subscript(_: SetIndex<Element>) Declaration subscript(position: SetIndex<Element>) -> Element { get } Instance Methods func contains(_:) Returns true if the set contains a member. Declaration func contains(member: Element) -> Bool Declared In Set, CollectionType, SequenceType func dropFirst() Returns a subsequence containing all but the first element. Requires: n >= 0 Complexity: O(n) Declaration func dropFirst() -> Slice<Set<Element>> Declared In CollectionType, SequenceType func dropFirst(_:) Returns a subsequence containing all but the first n elements. Requires: n >= 0 Complexity: O(n) Declaration func dropFirst(n: Int) -> Slice<Set<Element>> Declared In CollectionType, SequenceType func dropLast() Returns a subsequence containing all but the last element. Requires: self is a finite sequence. Requires: n >= 0 Complexity: O(self.count) Declaration func dropLast() -> Slice<Set<Element>> Declared In CollectionType, SequenceType func dropLast(_:) Returns a subsequence containing all but the last n elements. Requires: n >= 0 Complexity: O(self.count) Declaration func dropLast(n: Int) -> Slice<Set<Element>> Declared In CollectionType, SequenceType func elementsEqual(_:) Return true iff self and other contain the same elements in the same order. Declaration func elementsEqual<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence) -> Bool Declared In CollectionType, SequenceType func elementsEqual(_:isEquivalent:) Return true iff self and other contain equivalent elements, using isEquivalent as the equivalence test. Requires: isEquivalent is an equivalence relation. Declaration func elementsEqual<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: (Element, Element) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func enumerate() Return a lazy SequenceType containing pairs (n, x), where ns are consecutive Ints starting at zero, and xs are the elements of base: > for (n, c) in "Swift".characters.enumerate() { print("\(n): '\(c)'") } 0: 'S' 1: 'w' 2: 'i' 3: 'f' 4: 't' Declaration func enumerate() -> EnumerateSequence<Set<Element>> Declared In CollectionType, SequenceType func exclusiveOr(_:) Return a new set with elements that are either in the set or a finite sequence but do not occur in both. Declaration func exclusiveOr<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Set<Element> mutating func exclusiveOrInPlace(_:) For each element of a finite sequence, remove it from the set if it is a common element, otherwise add it to the set. Repeated elements of the sequence will be ignored. Declaration mutating func exclusiveOrInPlace<S : SequenceType where S.Generator.Element == Element>(sequence: S) func filter(_:) Return an Array containing the elements of self, in order, that satisfy the predicate includeElement. Declaration func filter(@noescape includeElement: (Element) throws -> Bool) rethrows -> [Element] Declared In CollectionType, SequenceType func flatMap<T>(_: (Element) throws -> T?) Return an Array containing the non-nil results of mapping transform over self. Complexity: O(M + N), where M is the length of self and N is the length of the result. Declaration func flatMap<T>(@noescape transform: (Element) throws -> T?) rethrows -> [T] Declared In CollectionType, SequenceType func flatMap<S : SequenceType>(_: (Element) throws -> S) Return an Array containing the concatenated results of mapping transform over self. s.flatMap(transform) is equivalent to Array(s.map(transform).flatten()) Complexity: O(M + N), where M is the length of self and N is the length of the result. Declaration func flatMap<S : SequenceType>(transform: (Element) throws -> S) rethrows -> [S.Generator.Element] Declared In CollectionType, SequenceType func forEach(_:) Call body on each element in self in the same order as a for-in loop. sequence.forEach { // body code } is similar to: for element in sequence { // body code } Note: You cannot use the break or continue statement to exit the current call of the body closure or skip subsequent calls. Note: Using the return statement in the body closure will only exit from the current call to body, not any outer scope, and won't skip subsequent calls. Complexity: O(self.count) Declaration func forEach(@noescape body: (Element) throws -> ()) rethrows Declared In CollectionType, SequenceType func generate() Return a generator over the members. Complexity: O(1). Declaration func generate() -> SetGenerator<Element> func indexOf(_:) Returns the Index of a given member, or nil if the member is not present in the set. Declaration func indexOf(member: Element) -> SetIndex<Element>? Declared In Set, CollectionType mutating func insert(_:) Insert a member into the set. Declaration mutating func insert(member: Element) func intersect(_:) Return a new set with elements common to this set and a finite sequence. Declaration func intersect<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Set<Element> mutating func intersectInPlace(_:) Remove any members of this set that aren't also in a finite sequence. Declaration mutating func intersectInPlace<S : SequenceType where S.Generator.Element == Element>(sequence: S) func isDisjointWith(_:) Returns true if no members in the set are in a finite sequence as a Set. Declaration func isDisjointWith<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Bool func isStrictSubsetOf(_:) Returns true if the set is a subset of a finite sequence as a Set but not equal. Declaration func isStrictSubsetOf<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Bool func isStrictSupersetOf(_:) Returns true if the set is a superset of a finite sequence as a Set but not equal. Declaration func isStrictSupersetOf<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Bool func isSubsetOf(_:) Returns true if the set is a subset of a finite sequence as a Set. Declaration func isSubsetOf<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Bool func isSupersetOf(_:) Returns true if the set is a superset of a finite sequence as a Set. Declaration func isSupersetOf<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Bool func lexicographicalCompare(_:isOrderedBefore:) Return true iff self precedes other in a lexicographical ("dictionary") ordering, using isOrderedBefore as the comparison between elements. 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, you should use String APIs that perform localized comparison. Requires: isOrderedBefore is a strict weak ordering over the elements of self and other. Declaration func lexicographicalCompare<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isOrderedBefore: (Element, Element) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func map(_:) Return an Array containing the results of mapping transform over self. Complexity: O(N). Declaration func map<T>(@noescape transform: (Element) throws -> T) rethrows -> [T] Declared In CollectionType, SequenceType func maxElement(_:) Returns the maximum element in self or nil if the sequence is empty. Complexity: O(elements.count). Requires: isOrderedBefore is a strict weak ordering. over self. Declaration func maxElement(@noescape isOrderedBefore: (Element, Element) throws -> Bool) rethrows -> Element? Declared In CollectionType, SequenceType func minElement(_:) Returns the minimum element in self or nil if the sequence is empty. Complexity: O(elements.count). Requires: isOrderedBefore is a strict weak ordering. over self. Declaration func minElement(@noescape isOrderedBefore: (Element, Element) throws -> Bool) rethrows -> Element? Declared In CollectionType, SequenceType mutating func popFirst() If !self.isEmpty, return the first key-value pair in the sequence of elements, otherwise return nil. Complexity: Amortized O(1) Declaration mutating func popFirst() -> Element? func prefix(_:) Returns a subsequence, up to maxLength in length, containing the initial elements. If maxLength exceeds self.count, the result contains all the elements of self. Requires: maxLength >= 0 Complexity: O(maxLength) Declaration func prefix(maxLength: Int) -> Slice<Set<Element>> Declared In CollectionType, SequenceType func prefixThrough(_:) Returns prefixUpTo(position.successor()) Complexity: O(1) Declaration func prefixThrough(position: SetIndex<Element>) -> Slice<Set<Element>> Declared In CollectionType func prefixUpTo(_:) Returns self[startIndex..<end] Complexity: O(1) Declaration func prefixUpTo(end: SetIndex<Element>) -> Slice<Set<Element>> Declared In CollectionType func reduce(_:combine:) Return the result of repeatedly calling combine with an accumulated value initialized to initial and each element of self, in turn, i.e. return combine(combine(...combine(combine(initial, self[0]), self[1]),...self[count-2]), self[count-1]). Declaration func reduce<T>(initial: T, @noescape combine: (T, Element) throws -> T) rethrows -> T Declared In CollectionType, SequenceType mutating func remove(_:) Remove the member from the set and return it if it was present. Declaration mutating func remove(member: Element) -> Element? mutating func removeAll(keepCapacity:) Erase all the elements. If keepCapacity is true, capacity will not decrease. Declaration mutating func removeAll(keepCapacity keepCapacity: Bool = default) mutating func removeAtIndex(_:) Remove the member referenced by the given index. Declaration mutating func removeAtIndex(index: SetIndex<Element>) -> Element mutating func removeFirst() Remove a member from the set and return it. Requires: count > 0. Declaration mutating func removeFirst() -> Element func reverse() Return an Array containing the elements of self in reverse order. Complexity: O(N), where N is the length of self. Declaration func reverse() -> [Element] Declared In CollectionType, SequenceType func sort(_:) Return an Array containing the sorted elements of source according to isOrderedBefore. The sorting algorithm is not stable (can change the relative order of elements for which isOrderedBefore does not establish an order). Requires: isOrderedBefore is a strict weak ordering over the elements in self. Declaration func sort(@noescape isOrderedBefore: (Element, Element) -> Bool) -> [Element] Declared In CollectionType, SequenceType func split(_:allowEmptySlices:isSeparator:) Returns the maximal SubSequences of self, in order, that don't contain elements satisfying the predicate isSeparator. maxSplit: The maximum number of SubSequences to return, minus 1. If maxSplit + 1 SubSequences are returned, the last one is a suffix of self containing the remaining elements. The default value is Int.max. allowEmptySubsequences: If true, an empty SubSequence is produced in the result for each pair of consecutive elements satisfying isSeparator. The default value is false. Requires: maxSplit >= 0 Declaration func split(maxSplit: Int = default, allowEmptySlices: Bool = default, @noescape isSeparator: (Element) throws -> Bool) rethrows -> [Slice<Set<Element>>] Declared In CollectionType, SequenceType func split(_:maxSplit:allowEmptySlices:) Returns the maximal SubSequences of self, in order, around a separator element. maxSplit: The maximum number of SubSequences to return, minus 1. If maxSplit + 1 SubSequences are returned, the last one is a suffix of self containing the remaining elements. The default value is Int.max. allowEmptySubsequences: If true, an empty SubSequence is produced in the result for each pair of consecutive elements satisfying isSeparator. The default value is false. Requires: maxSplit >= 0 Declaration func split(separator: Element, maxSplit: Int = default, allowEmptySlices: Bool = default) -> [Slice<Set<Element>>] Declared In CollectionType, SequenceType func startsWith(_:) Return true iff the the initial elements of self are equal to prefix. Return true if other is empty. Declaration func startsWith<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence) -> Bool Declared In CollectionType, SequenceType func startsWith(_:isEquivalent:) Return true iff self begins with elements equivalent to those of other, using isEquivalent as the equivalence test. Return true if other is empty. Requires: isEquivalent is an equivalence relation. Declaration func startsWith<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: (Element, Element) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func subtract(_:) Return a new set with elements in this set that do not occur in a finite sequence. Declaration func subtract<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Set<Element> mutating func subtractInPlace(_:) Remove all members in the set that occur in a finite sequence. Declaration mutating func subtractInPlace<S : SequenceType where S.Generator.Element == Element>(sequence: S) func suffix(_:) Returns a slice, up to maxLength in length, containing the final elements of s. If maxLength exceeds s.count, the result contains all the elements of s. Requires: maxLength >= 0 Complexity: O(self.count) Declaration func suffix(maxLength: Int) -> Slice<Set<Element>> Declared In CollectionType, SequenceType func suffixFrom(_:) Returns self[start..<endIndex] Complexity: O(1) Declaration func suffixFrom(start: SetIndex<Element>) -> Slice<Set<Element>> Declared In CollectionType func underestimateCount() Returns a value less than or equal to the number of elements in self, nondestructively. Complexity: O(N). Declaration func underestimateCount() -> Int Declared In CollectionType, SequenceType func union(_:) Return a new Set with items in both this set and a finite sequence. Declaration func union<S : SequenceType where S.Generator.Element == Element>(sequence: S) -> Set<Element> mutating func unionInPlace(_:) Insert elements of a finite sequence into this Set. Declaration mutating func unionInPlace<S : SequenceType where S.Generator.Element == Element>(sequence: S) 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 Generator.Element == String func joinWithSeparator(_:) Interpose the separator between elements of self, then concatenate the result. For example: ["foo", "bar", "baz"].joinWithSeparator("-|-") // "foo-|-bar-|-baz" Declaration func joinWithSeparator(separator: String) -> String Declared In CollectionType, SequenceType