Structureswift 6.0.1Swift
ArraySlice
A slice of an Array
, ContiguousArray
, or ArraySlice
instance.
@frozen struct ArraySlice<Element>
The ArraySlice
type makes it fast and efficient for you to perform operations on sections of a larger array. Instead of copying over the elements of a slice to new storage, an ArraySlice
instance presents a view onto the storage of a larger array. And because ArraySlice
presents the same interface as Array
, you can generally perform the same operations on a slice as you could on the original array.
For more information about using arrays, see Array
and ContiguousArray
, with which ArraySlice
shares most properties and methods.
Slices Are Views onto Arrays
For example, suppose you have an array holding the number of absences from each class during a session.
let absences = [0, 2, 0, 4, 0, 3, 1, 0]
You want to compare the absences in the first half of the session with those in the second half. To do so, start by creating two slices of the absences
array.
let midpoint = absences.count / 2
let firstHalf = absences[..<midpoint]
let secondHalf = absences[midpoint...]
Neither the firstHalf
nor secondHalf
slices allocate any new storage of their own. Instead, each presents a view onto the storage of the absences
array.
You can call any method on the slices that you might have called on the absences
array. To learn which half had more absences, use the reduce(_:_:)
method to calculate each sum.
let firstHalfSum = firstHalf.reduce(0, +)
let secondHalfSum = secondHalf.reduce(0, +)
if firstHalfSum > secondHalfSum {
print("More absences in the first half.")
} else {
print("More absences in the second half.")
}
// Prints "More absences in the first half."
Slices Maintain Indices
Unlike Array
and ContiguousArray
, the starting index for an ArraySlice
instance isn’t always zero. Slices maintain the same indices of the larger array for the same elements, so the starting index of a slice depends on how it was created, letting you perform index-based operations on either a full array or a slice.
Sharing indices between collections and their subsequences is an important part of the design of Swift’s collection algorithms. Suppose you are tasked with finding the first two days with absences in the session. To find the indices of the two days in question, follow these steps:
Call
firstIndex(where:)
to find the index of the first element in theabsences
array that is greater than zero.Create a slice of the
absences
array starting after the index found in step 1.Call
firstIndex(where:)
again, this time on the slice created in step 2. Where in some languages you might pass a starting index into anindexOf
method to find the second day, in Swift you perform the same operation on a slice of the original array.Print the results using the indices found in steps 1 and 3 on the original
absences
array.
Here’s an implementation of those steps:
if let i = absences.firstIndex(where: { $0 > 0 }) { // 1
let absencesAfterFirst = absences[(i + 1)...] // 2
if let j = absencesAfterFirst.firstIndex(where: { $0 > 0 }) { // 3
print("The first day with absences had \(absences[i]).") // 4
print("The second day with absences had \(absences[j]).")
}
}
// Prints "The first day with absences had 2."
// Prints "The second day with absences had 4."
In particular, note that j
, the index of the second day with absences, was found in a slice of the original array and then used to access a value in the original absences
array itself.
Citizens in Swift
Typealiases
typealias Index
The index type for arrays,
Int
.typealias Indices
The type that represents the indices that are valid for subscripting an array, in ascending order.
typealias Iterator
The type that allows iteration over an array’s elements.
Type members
init(
) Creates a new, empty array.
init<S>(S
) Creates an array containing the elements of a sequence.
init(arrayLiteral: Element...
) Creates an array from the given array literal.
init(repeating: Element, count: Int
) Creates a new array containing the specified number of a single, repeated value.
Instance members
var capacity: Int
The total number of elements that the array can contain without allocating new storage.
var count: Int
The number of elements in the array.
var customMirror: Mirror
A mirror that reflects the array.
var debugDescription: String
A textual representation of the array and its elements, suitable for debugging.
var description: String
A textual representation of the array and its elements.
var endIndex: Int
The array’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var startIndex: Int
The position of the first element in a nonempty array.
subscript(Range<Int>
) -> ArraySlice<Element> Accesses a contiguous subrange of the array’s elements.
subscript(Int
) -> Element Accesses the element at the specified position.
func append(Element
) Adds a new element at the end of the array.
func append<S>(contentsOf: S
) Adds the elements of a sequence to the end of the array.
func distance(from: Int, to: Int
) -> Int Returns the distance between two indices.
func formIndex(after: inout Int
) func formIndex(before: inout Int
) func index(Int, offsetBy: Int
) -> Int Returns an index that is the specified distance from the given index.
func index(Int, offsetBy: Int, limitedBy: Int
) -> Int? Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func index(after: Int
) -> Int Returns the position immediately after the given index.
func index(before: Int
) -> Int Returns the position immediately before the given index.
func insert(Element, at: Int
) Inserts a new element at the specified position.
func remove(at: Int
) -> Element Removes and returns the element at the specified position.
func removeAll(keepingCapacity: Bool
) Removes all elements from the array.
func replaceSubrange<C>(Range<Int>, with: C
) Replaces a range of elements with the elements in the specified collection.
func reserveCapacity(Int
) Reserves enough space to store the specified number of elements.
func withContiguousMutableStorageIfAvailable<R>((inout UnsafeMutableBufferPointer<Element>) throws -> R
) rethrows -> R? func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Element>) throws -> R
) rethrows -> R? func withUnsafeBufferPointer<R>((UnsafeBufferPointer<Element>) throws -> R
) rethrows -> R Calls a closure with a pointer to the array’s contiguous storage.
func withUnsafeBytes<R>((UnsafeRawBufferPointer) throws -> R
) rethrows -> R Calls the given closure with a pointer to the underlying bytes of the array’s contiguous storage.
func withUnsafeMutableBufferPointer<R>((inout UnsafeMutableBufferPointer<Element>) throws -> R
) rethrows -> R Calls the given closure with a pointer to the array’s mutable contiguous storage.
func withUnsafeMutableBytes<R>((UnsafeMutableRawBufferPointer) throws -> R
) rethrows -> R Calls the given closure with a pointer to the underlying bytes of the array’s mutable contiguous storage.
Citizens in Swift
where Element:Hashable
Conformances
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.
Instance members
func hash(into: inout Hasher
) Hashes the essential components of this value by feeding them into the given hasher.
Citizens in Swift
where Element:Equatable
Conformances
protocol Copyable
A type whose values can be implicitly or explicitly copied.
protocol Equatable
A type that can be compared for value equality.
protocol Escapable
Type members
static func == (lhs: ArraySlice<Element>, rhs: ArraySlice<Element>
) -> Bool Returns a Boolean value indicating whether two arrays contain the same elements in the same order.
Type features
static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.
Citizens in Swift
Conformances
Citizens in Swift
Conformances
protocol BidirectionalCollection<Element>
A collection that supports backward as well as forward traversal.
protocol Collection<Element>
A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectable
A type that explicitly supplies its own mirror.
protocol CustomStringConvertible
A type with a customized textual representation.
protocol ExpressibleByArrayLiteral
A type that can be initialized using an array literal.
protocol MutableCollection<Element>
A collection that supports subscript assignment.
protocol RandomAccessCollection<Element>
A collection that supports efficient random-access index traversal.
protocol RangeReplaceableCollection<Element>
A collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol Sequence<Element>
A type that provides sequential, iterated access to its elements.
Type features
init<S>(S
) Creates a new instance of a collection containing the elements of a sequence.
init(repeating: Self.Element, count: Int
) Creates a new collection containing the specified number of a single, repeated value.
static func + <Other>(lhs: Other, rhs: Self
) -> Self Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(lhs: Self, rhs: Other
) -> Self Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(lhs: Self, rhs: Other
) -> Self Creates a new collection by concatenating the elements of two collections.
static func += <Other>(lhs: inout Self, rhs: Other
) Appends the elements of a sequence to a range-replaceable collection.
Instance features
var first: Self.Element?
The first element of the collection.
var isEmpty: Bool
A Boolean value indicating whether the collection is empty.
var last: Self.Element?
The last element of the collection.
var lazy: LazySequence<Self>
A sequence containing the same elements as this sequence, but on which some operations, such as
map
andfilter
, are implemented lazily.var underestimatedCount: Int
A value less than or equal to the number of elements in the collection.
subscript<R>(R
) -> Self.SubSequence subscript((UnboundedRange_) -> ()
) -> Self.SubSequence subscript<R>(R
) -> Self.SubSequence Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript((UnboundedRange_) -> ()
) -> Self.SubSequence subscript(RangeSet<Self.Index>
) -> DiscontiguousSlice<Self> Accesses a view of this collection with the elements at the given indices.
func allSatisfy((Self.Element) throws -> Bool
) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func append(Self.Element
) Adds an element to the end of the collection.
func append<S>(contentsOf: S
) Adds the elements of a sequence or collection to the end of this collection.
func applying(CollectionDifference<Self.Element>
) -> Self? Applies the given difference to this collection.
func compactMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?
) rethrows -> [ElementOfResult] Returns an array containing the non-
nil
results of calling the given transformation with each element of this sequence.func contains(Self.Element
) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
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 count<E>(where: (Self.Element)
throws Returns the number of elements in the sequence that satisfy the given predicate.
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
predicate
returnstrue
and 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 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 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 forEach((Self.Element) throws -> Void
) rethrows Calls the given closure on each element in the sequence in the same order as a
for
-in
loop.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 indices(of: Self.Element
) -> RangeSet<Self.Index> Returns the indices of all the elements that are equal to the given element.
func indices(where: (Self.Element) throws -> Bool
) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
func insert(Self.Element, at: Self.Index
) Inserts a new element into the collection at the specified position.
func insert<C>(contentsOf: C, at: Self.Index
) Inserts the elements of a sequence into the collection at the specified position.
func joined(
) -> FlattenSequence<Self> Returns the elements of this sequence of sequences, concatenated.
func joined(separator: String
) -> String Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func joined<Separator>(separator: Separator
) -> JoinedSequence<Self> Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
func joined(separator: String
) -> String Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
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 makeIterator(
) -> IndexingIterator<Self> Returns an iterator over the elements of the collection.
func map<T, E>((Self.Element)
throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>((Self.Element)
throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
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 moveSubranges(RangeSet<Self.Index>, to: Self.Index
) -> Range<Self.Index> Moves the elements in the given subranges to just before the element at the specified index.
func partition(by: (Self.Element) throws -> Bool
) rethrows -> Self.Index Reorders the elements of the collection such that all the elements that match the given predicate are after all the elements that don’t match.
func partition(by: (Self.Element) throws -> Bool
) rethrows -> Self.Index Reorders the elements of the collection such that all the elements that match the given predicate are after all the elements that don’t match.
func popFirst(
) -> Self.Element? Removes and returns the first element of the collection.
func popLast(
) -> Self.Element? Removes and returns the last element of the collection.
func popLast(
) -> Self.Element? Removes and returns the last element of the collection.
func popLast(
) -> Self.Element? Removes and returns the last element of the collection.
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
predicate
returnsfalse
and 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 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 remove(at: Self.Index
) -> Self.Element Removes and returns the element at the specified position.
func removeAll(keepingCapacity: Bool
) Removes all elements from the collection.
func removeAll(where: (Self.Element) throws -> Bool
) rethrows Removes all the elements that satisfy the given predicate.
func removeAll(where: (Self.Element) throws -> Bool
) rethrows Removes all the elements that satisfy the given predicate.
func removeFirst(
) -> Self.Element Removes and returns the first element of the collection.
func removeFirst(
) -> Self.Element Removes and returns the first element of the collection.
func removeFirst(
) -> Self.Element Removes and returns the first element of the collection.
func removeFirst(Int
) Removes the specified number of elements from the beginning of the collection.
func removeFirst(Int
) Removes the specified number of elements from the beginning of the collection.
func removeFirst(Int
) Removes the specified number of elements from the beginning of the collection.
func removeLast(
) -> Self.Element Removes and returns the last element of the collection.
func removeLast(
) -> Self.Element Removes and returns the last element of the collection.
func removeLast(
) -> Self.Element Removes and returns the last element of the collection.
func removeLast(Int
) Removes the given number of elements from the end of the collection.
func removeLast(Int
) Removes the specified number of elements from the end of the collection.
func removeLast(Int
) Removes the specified number of elements from the end of the collection.
func removeSubrange(Range<Self.Index>
) Removes the elements in the specified subrange from the collection.
func removeSubrange<R>(R
) Removes the elements in the specified subrange from the collection.
func removeSubranges(RangeSet<Self.Index>
) Removes the elements at the given indices.
func removeSubranges(RangeSet<Self.Index>
) Removes the elements at the given indices.
func removingSubranges(RangeSet<Self.Index>
) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
func replaceSubrange<C, R>(R, with: C
) Replaces the specified subrange of elements with the given collection.
func reserveCapacity(Int
) Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.
func reverse(
) Reverses the elements of the collection in place.
func reversed(
) -> ReversedCollection<Self> Returns a view presenting the elements of the collection in reverse order.
func shuffle(
) Shuffles the collection in place.
func shuffle<T>(using: inout T
) Shuffles the collection in place, using the given generator as a source for randomness.
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 sort(
) Sorts the collection in place.
func sort(by: (Self.Element, Self.Element) throws -> Bool
) rethrows Sorts the collection in place, using the given predicate as the comparison between elements.
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(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
) -> [ArraySlice<Self.Element>] Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
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 swapAt(Self.Index, Self.Index
) Exchanges the values at the specified indices of the collection.
func withContiguousMutableStorageIfAvailable<R>((inout UnsafeMutableBufferPointer<Self.Element>) throws -> R
) rethrows -> R? func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R
) rethrows -> R?
Show obsolete interfaces (2)
Hide obsolete interfaces
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.
Available in FoundationEssentials
where Element == UInt8
Conformances
protocol ContiguousBytes
Indicates that the conforming type is a contiguous collection of raw bytes whose underlying storage is directly accessible by withUnsafeBytes.
protocol DataProtocol
Instance members
Instance features
func copyBytes<DestinationType>(to: UnsafeMutableBufferPointer<DestinationType>
) -> Int func copyBytes(to: UnsafeMutableRawBufferPointer
) -> Int func copyBytes<DestinationType>(to: UnsafeMutableBufferPointer<DestinationType>, count: Int
) -> Int func copyBytes(to: UnsafeMutableRawBufferPointer, count: Int
) -> Int func copyBytes<DestinationType, R>(to: UnsafeMutableBufferPointer<DestinationType>, from: R
) func copyBytes<DestinationType, R>(to: UnsafeMutableBufferPointer<DestinationType>, from: R
) -> Int func copyBytes<R>(to: UnsafeMutableRawBufferPointer, from: R
) -> Int func firstRange<D>(of: D
) -> Range<Self.Index>? func firstRange<D, R>(of: D, in: R
) -> Range<Self.Index>? func lastRange<D>(of: D
) -> Range<Self.Index>? func lastRange<D, R>(of: D, in: R
) -> Range<Self.Index>?