Generic Structure

ArraySlice

A slice of an Array, ContiguousArray, or ArraySlice instance.

Declaration

@frozen struct ArraySlice<Element>

Overview

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:

  1. Call firstIndex(where:) to find the index of the first element in the absences array that is greater than zero.

  2. Create a slice of the absences array starting after the index found in step 1.

  3. Call firstIndex(where:) again, this time on the slice created in step 2. Where in some languages you might pass a starting index into an indexOf method to find the second day, in Swift you perform the same operation on a slice of the original array.

  4. 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.

Topics

Type Aliases

typealias ArraySlice.ArrayLiteralElement

The type of the elements of an array literal.

typealias ArraySlice.Regions
typealias ArraySlice.SubSequence

A sequence that represents a contiguous subrange of the collection’s elements.

typealias ArraySlice.Index

The index type for arrays, Int.

typealias ArraySlice.Indices

The type that represents the indices that are valid for subscripting an array, in ascending order.

typealias ArraySlice.Iterator

The type that allows iteration over an array’s elements.

Initializers

init()

Creates a new, empty array.

init<S>(S)

Creates a new instance of a collection containing the elements of a sequence.

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 Properties

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 first: Element?

The first element of the collection.

var hashValue: Int

The hash value.

var indices: Range<Int>

The indices that are valid for subscripting the collection, in ascending order.

var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

var last: Element?

The last element of the collection.

var lazy: LazySequence<ArraySlice<Element>>

A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.

var regions: CollectionOfOne<ArraySlice<UInt8>>
var startIndex: Int

The position of the first element in a nonempty array.

var underestimatedCount: Int

A value less than or equal to the number of elements in the collection.

Instance Methods

func allSatisfy((Element) -> Bool) -> Bool

Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.

func append(Element)

Adds a new element at the end of the array.

func append<S>(contentsOf: S)

Adds the elements of a sequence or collection to the end of this collection.

func append<S>(contentsOf: S)

Adds the elements of a sequence to the end of the array.

func applying(CollectionDifference<Element>) -> ArraySlice<Element>?

Applies the given difference to this collection.

func compactMap<ElementOfResult>((Element) -> ElementOfResult?) -> [ElementOfResult]

Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.

func contains(Element) -> Bool

Returns a Boolean value indicating whether the sequence contains the given element.

func contains(where: (Element) -> Bool) -> Bool

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

func difference<C>(from: C) -> CollectionDifference<Element>

Returns the difference needed to produce this collection’s ordered elements from the given collection.

func difference<C>(from: C, by: (C.Element, Element) -> Bool) -> CollectionDifference<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 distance(from: Int, to: Int) -> Int

Returns the distance between two indices.

func drop(while: (Element) -> Bool) -> ArraySlice<Element>

Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.

func dropFirst(Int) -> ArraySlice<Element>

Returns a subsequence containing all but the given number of initial elements.

func dropLast(Int) -> ArraySlice<Element>

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: (Element, OtherSequence.Element) -> Bool) -> 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<ArraySlice<Element>>

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: (Element) -> Bool) -> Element?

Returns the first element of the sequence that satisfies the given predicate.

func firstIndex(of: Element) -> Int?

Returns the first index where the specified value appears in the collection.

func firstIndex(where: (Element) -> Bool) -> Int?

Returns the first index in which an element of the collection satisfies the given predicate.

func flatMap<SegmentOfResult>((Element) -> SegmentOfResult) -> [SegmentOfResult.Element]

Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.

func forEach((Element) -> Void)

Calls the given closure on each element in the sequence in the same order as a for-in loop.

func formIndex(inout Int, offsetBy: Int)

Offsets the given index by the specified distance.

func formIndex(inout Int, offsetBy: Int, limitedBy: Int) -> Bool

Offsets the given index by the specified distance, or so that it equals the given limiting index.

func formIndex(after: inout Int)

Replaces the given index with its successor.

func formIndex(before: inout Int)

Replaces the given index with its predecessor.

func hash(into: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

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 index(of: Element) -> Int?

Returns the first index where the specified value appears in the collection.

Deprecated
func index(where: (Element) -> Bool) -> Int?

Returns the first index in which an element of the collection satisfies the given predicate.

Deprecated
func insert(Element, at: Int)

Inserts a new element at the specified position.

func insert<C>(contentsOf: C, at: Int)

Inserts the elements of a sequence into the collection at the specified position.

func joined() -> FlattenSequence<ArraySlice<Element>>

Returns the elements of this sequence of sequences, concatenated.

func joined<Separator>(separator: Separator) -> JoinedSequence<ArraySlice<Element>>

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 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: (Element) -> Bool) -> Element?

Returns the last element of the sequence that satisfies the given predicate.

func lastIndex(of: Element) -> Int?

Returns the last index where the specified value appears in the collection.

func lastIndex(where: (Element) -> Bool) -> Int?

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: (Element, Element) -> Bool) -> 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<ArraySlice<Element>>

Returns an iterator over the elements of the collection.

func map<T>((Element) -> T) -> [T]

Returns an array containing the results of mapping the given closure over the sequence’s elements.

func max() -> Element?

Returns the maximum element in the sequence.

func max(by: (Element, Element) -> Bool) -> Element?

Returns the maximum element in the sequence, using the given predicate as the comparison between elements.

func min() -> Element?

Returns the minimum element in the sequence.

func min(by: (Element, Element) -> Bool) -> Element?

Returns the minimum element in the sequence, using the given predicate as the comparison between elements.

func partition(by: (Element) -> Bool) -> Int

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() -> Element?

Removes and returns the first element of the collection.

func popLast() -> Element?

Removes and returns the last element of the collection.

func prefix(Int) -> ArraySlice<Element>

Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.

func prefix(through: Int) -> ArraySlice<Element>

Returns a subsequence from the start of the collection through the specified position.

func prefix(upTo: Int) -> ArraySlice<Element>

Returns a subsequence from the start of the collection up to, but not including, the specified position.

func prefix(while: (Element) -> Bool) -> ArraySlice<Element>

Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.

func randomElement() -> Element?

Returns a random element of the collection.

func randomElement<T>(using: inout T) -> Element?

Returns a random element of the collection, using the given generator as a source for randomness.

func reduce<Result>(Result, (Result, Element) -> Result) -> Result

Returns the result of combining the elements of the sequence using the given closure.

func reduce<Result>(into: Result, (inout Result, Element) -> ()) -> Result

Returns the result of combining the elements of the sequence using the given closure.

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 removeAll(where: (Element) -> Bool)

Removes all the elements that satisfy the given predicate.

func removeFirst() -> 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 removeLast() -> Element

Removes and returns the last element of the collection.

func removeLast(Int)

Removes the specified number of elements from the end of the collection.

func removeSubrange(Range<Int>)

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 replaceSubrange<C, R>(R, with: C)

Replaces the specified subrange of elements with the given collection.

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 reverse()

Reverses the elements of the collection in place.

func reversed() -> ReversedCollection<ArraySlice<Element>>

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() -> [Element]

Returns the elements of the sequence, shuffled.

func shuffled<T>(using: inout T) -> [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: (Element, Element) -> Bool)

Sorts the collection in place, using the given predicate as the comparison between elements.

func sorted() -> [Element]

Returns the elements of the sequence, sorted.

func sorted(by: (Element, Element) -> Bool) -> [Element]

Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.

func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Element) -> Bool) -> [ArraySlice<Element>]

Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.

func split(separator: Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [ArraySlice<Element>]

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: (Element, PossiblePrefix.Element) -> Bool) -> 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) -> ArraySlice<Element>

Returns a subsequence, up to the given maximum length, containing the final elements of the collection.

func suffix(from: Int) -> ArraySlice<Element>

Returns a subsequence from the specified position to the end of the collection.

func swapAt(Int, Int)

Exchanges the values at the specified indices of the collection.

func withContiguousMutableStorageIfAvailable<R>((inout UnsafeMutableBufferPointer<Element>) -> R) -> R?

Call body(p), where p is a pointer to the collection’s mutable contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of mutable contiguous storage, body is not called and nil is returned.

func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Element>) -> R) -> R?

Call body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.

func withUnsafeBufferPointer<R>((UnsafeBufferPointer<Element>) -> R) -> R

Calls a closure with a pointer to the array’s contiguous storage.

func withUnsafeBytes<R>((UnsafeRawBufferPointer) -> R) -> R

Calls the given closure with a pointer to the underlying bytes of the array’s contiguous storage.

func withUnsafeMutableBufferPointer<R>((inout UnsafeMutableBufferPointer<Element>) -> R) -> R

Calls the given closure with a pointer to the array’s mutable contiguous storage.

func withUnsafeMutableBytes<R>((UnsafeMutableRawBufferPointer) -> R) -> R

Calls the given closure with a pointer to the underlying bytes of the array’s mutable contiguous storage.

Subscripts

subscript(Int) -> Element

Accesses the element at the specified position.

subscript(Range<Int>) -> ArraySlice<Element>

Accesses a contiguous subrange of the array’s elements.

subscript(Range<Int>) -> Slice<ArraySlice<Element>>

Accesses a contiguous subrange of the collection’s elements.

subscript<R>(R) -> ArraySlice<Element>

Accesses the contiguous subrange of the collection’s elements specified by a range expression.

Operator Functions

static func != (ArraySlice<Element>, ArraySlice<Element>) -> Bool

Returns a Boolean value indicating whether two values are not equal.

static func + <Other>(Other, ArraySlice<Element>) -> ArraySlice<Element>

Creates a new collection by concatenating the elements of a sequence and a collection.

static func + <Other>(ArraySlice<Element>, Other) -> ArraySlice<Element>

Creates a new collection by concatenating the elements of a collection and a sequence.

static func + <Other>(ArraySlice<Element>, Other) -> ArraySlice<Element>

Creates a new collection by concatenating the elements of two collections.

static func += <Other>(inout ArraySlice<Element>, Other)

Appends the elements of a sequence to a range-replaceable collection.

static func == (ArraySlice<Element>, ArraySlice<Element>) -> Bool

Returns a Boolean value indicating whether two arrays contain the same elements in the same order.

Relationships

Conforms To

See Also

Related Array Types

struct ContiguousArray

A contiguously stored array.