StructureFoundation5.9.0
IndexSet
Manages a Set of integer values, which are commonly used as an index type in Cocoa API.
struct IndexSetThe range of valid integer values is 0..<INT_MAX-1. Anything outside this range is an error.
Citizens in Foundation
Conformances
protocol BidirectionalCollectionA collection that supports backward as well as forward traversal.
protocol CollectionA sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol DecodableA type that can decode itself from an external representation.
protocol EncodableA type that can encode itself to an external representation.
protocol EquatableA type that can be compared for value equality.
protocol ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol ReferenceConvertibleDecorates types which are backed by a Foundation reference type.
protocol SequenceA type that provides sequential, iterated access to its elements.
protocol SetAlgebraA type that provides mathematical set operations.
Members
init() Initialize an empty
IndexSet.init(from: Decoder) throws init(integer: IndexSet.Element) Initialize an
IndexSetwith a single integer.init(integersIn: Range<IndexSet.Element>) Initialize an
IndexSetwith a range of integers.init<R>(integersIn: R) Initialize an
IndexSetwith a range of integers.var count: IntReturns the number of integers in
self.var customMirror: Mirrorvar debugDescription: Stringvar description: Stringvar endIndex: IndexSet.Indexvar first: IndexSet.Element?Returns the first integer in
self, or nil ifselfis empty.var isEmpty: BoolReturns
trueif self contains no values.var last: IndexSet.Element?Returns the last integer in
self, or nil ifselfis empty.var rangeView: IndexSet.RangeViewReturns a
Range-based view of the entire contents ofself.var startIndex: IndexSet.Indexsubscript(IndexSet.Index) -> IndexSet.Element subscript(Range<IndexSet.Index>) -> Slice<IndexSet> static func == (IndexSet, IndexSet) -> Bool func contains(IndexSet.Element) -> Bool Returns
trueifselfcontainsinteger.func contains(integersIn: IndexSet) -> Bool Returns
trueifselfcontains all of the integers inindexSet.func contains(integersIn: Range<IndexSet.Element>) -> Bool Returns
trueifselfcontains all of the integers inrange.func contains<R>(integersIn: R) -> Bool Returns
trueifselfcontains all of the integers inrange.func count(in: Range<IndexSet.Element>) -> Int Returns the count of integers in
selfthat intersectrange.func count<R>(in: R) -> Int Returns the count of integers in
selfthat intersectrange.func encode(to: Encoder) throws func filteredIndexSet(in: ClosedRange<IndexSet.Element>, includeInteger: (IndexSet.Element) throws -> Bool) rethrows -> IndexSet Returns an IndexSet filtered according to the result of
includeInteger.func filteredIndexSet(in: Range<IndexSet.Element>, includeInteger: (IndexSet.Element) throws -> Bool) rethrows -> IndexSet Returns an IndexSet filtered according to the result of
includeInteger.func filteredIndexSet(includeInteger: (IndexSet.Element) throws -> Bool) rethrows -> IndexSet Returns an IndexSet filtered according to the result of
includeInteger.func formIndex(after: inout IndexSet.Index) func formIndex(before: inout IndexSet.Index) func formIntersection(IndexSet) Intersect the
IndexSetwithother.func formSymmetricDifference(IndexSet) Exclusive or the
IndexSetwithother.func formUnion(IndexSet) Union the
IndexSetwithother.func hash(into: inout Hasher) func index(after: IndexSet.Index) -> IndexSet.Index func index(before: IndexSet.Index) -> IndexSet.Index func indexRange(in: Range<IndexSet.Element>) -> Range<IndexSet.Index> Return a
Range<IndexSet.Index>which can be used to subscript the index set.func indexRange<R>(in: R) -> Range<IndexSet.Index> Return a
Range<IndexSet.Index>which can be used to subscript the index set.func insert(IndexSet.Element) -> (inserted: Bool, memberAfterInsert: IndexSet.Element) Insert an integer into the
IndexSet.func insert(integersIn: Range<IndexSet.Element>) Insert a range of integers into the
IndexSet.func insert<R>(integersIn: R) Insert a range of integers into the
IndexSet.func integerGreaterThan(IndexSet.Element) -> IndexSet.Element? Returns an integer contained in
selfwhich is greater thaninteger, ornilif a result could not be found.func integerGreaterThanOrEqualTo(IndexSet.Element) -> IndexSet.Element? Returns an integer contained in
selfwhich is greater than or equal tointeger, ornilif a result could not be found.func integerLessThan(IndexSet.Element) -> IndexSet.Element? Returns an integer contained in
selfwhich is less thaninteger, ornilif a result could not be found.func integerLessThanOrEqualTo(IndexSet.Element) -> IndexSet.Element? Returns an integer contained in
selfwhich is less than or equal tointeger, ornilif a result could not be found.func intersection(IndexSet) -> IndexSet Intersect the
IndexSetwithother.func intersects(integersIn: Range<IndexSet.Element>) -> Bool Returns
trueifselfintersects any of the integers inrange.func intersects<R>(integersIn: R) -> Bool Returns
trueifselfintersects any of the integers inrange.func makeIterator() -> IndexingIterator<IndexSet> func rangeView(of: Range<IndexSet.Element>) -> IndexSet.RangeView Returns a
Range-based view ofself.func rangeView<R>(of: R) -> IndexSet.RangeView Returns a
Range-based view ofself.func remove(IndexSet.Element) -> IndexSet.Element? Remove an integer from the
IndexSet.func remove(integersIn: ClosedRange<IndexSet.Element>) Remove a range of integers from the
IndexSet.func remove(integersIn: Range<IndexSet.Element>) Remove a range of integers from the
IndexSet.func removeAll() Remove all values from the
IndexSet.func shift(startingAt: IndexSet.Element, by: Int) For a positive delta, shifts the indexes in [index, INT_MAX] to the right, thereby inserting an “empty space” [index, delta], for a negative delta, shifts the indexes in [index, INT_MAX] to the left, thereby deleting the indexes in the range [index - delta, delta].
func symmetricDifference(IndexSet) -> IndexSet Exclusive or the
IndexSetwithother.func union(IndexSet) -> IndexSet Union the
IndexSetwithother.func update(with: IndexSet.Element) -> IndexSet.Element? Insert an integer into the
IndexSet.struct IndexThe mechanism for accessing the integers stored in an IndexSet.
struct RangeViewAn view of the contents of an IndexSet, organized by range.
typealias Elementtypealias ReferenceType
Features
var halfWidthCornerQuoted: Stringvar lazy: LazySequence<Self>A sequence containing the same elements as this sequence, but on which some operations, such as
mapandfilter, are implemented lazily.static func != (Self, Self) -> Bool func all((Self.Element) -> Bool) -> Bool func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func any((Self.Element) -> Bool) -> Bool func compactMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-
nilresults of calling the given transformation with each element of this sequence.func contains(where: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func convertByOffset<C>(Self.Index, in: C) -> C.Index func convertByOffset<C>(Range<Self.Index>, in: C) -> Range<C.Index> func difference<C>(from: C) -> CollectionDifference<Self.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.
func drop(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while
predicatereturnstrueand returning the remaining elements.func dropFirst(Int) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequence Returns a subsequence containing all but the specified number of final elements.
func elementsEqual<OtherSequence>(OtherSequence) -> Bool Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsEqual<OtherSequence>(OtherSequence, by: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.
func enumerated() -> EnumeratedSequence<Self> Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.
func filter((Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
func firstIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
func flatMap<SegmentOfResult>((Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func flatmapOffsets(Offsets?) -> Range<Self.Index> func forEach((Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a
for-inloop.func formIndex(inout Self.Index, offsetBy: Int) Offsets the given index by the specified distance.
func formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func index(atOffset: Int) -> Self.Index func isStrictSubset(of: Self) -> Bool Returns a Boolean value that indicates whether this set is a strict subset of the given set.
func isStrictSuperset(of: Self) -> Bool Returns a Boolean value that indicates whether this set is a strict superset of the given set.
func last(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of: Self.Element) -> Self.Index? Returns the last index where the specified value appears in the collection.
func lastIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the index of the last element in the collection that matches the given predicate.
func lexicographicallyPrecedes<OtherSequence>(OtherSequence) -> Bool Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (
<) to compare elements.func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func mapOffsets(Offsets) -> Range<Self.Index> func max() -> Self.Element? Returns the maximum element in the sequence.
func max(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> Self.Element? Returns the minimum element in the sequence.
func min(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func none((Self.Element) -> Bool) -> Bool func offset(of: Self.Index) -> Int func offset(ofIndex: Self.Index) -> Int func offsets(of: Range<Self.Index>) -> Range<Int> func prefix(Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until
predicatereturnsfalseand skipping the remaining elements.func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using: inout T) -> Self.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func ranges<C>(of: C) -> [Range<Self.Index>] Finds and returns the ranges of the all occurrences of a given sequence within the collection.
func reduce<Result>(Result, (Result, Self.Element) throws -> Result) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reversed() -> ReversedCollection<Self> Returns a view presenting the elements of the collection in reverse order.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [Self.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [Self.Element] Returns the elements of the sequence, sorted.
func sorted(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(around: Range<Self.Index>) -> (prefix: Self.SubSequence, Self.SubSequence, suffix: Self.SubSequence) func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Self.Element) throws -> Bool) rethrows -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: Self.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func starts<PossiblePrefix>(with: PossiblePrefix) -> Bool Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
func starts<PossiblePrefix>(with: PossiblePrefix, by: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool 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.
func suffix(Int) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
func trimmingPrefix<Prefix>(Prefix) -> Self.SubSequence Returns a new collection of the same type by removing initial elements that satisfy the given predicate from the start.
func trimmingPrefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence func tryDropPrefix<C>(C) -> Self.SubSequence? Attempts to drop a given prefix from the collection.
func tryDropSuffix<C>(C) -> Self.SubSequence? Attempts to drop a given suffix from the collection.
func flatMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] func index(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.