Generic Structure

ContiguousArray

A contiguously stored array.

Overview

The ContiguousArray type is a specialized array that always stores its elements in a contiguous region of memory. This contrasts with Array, which can store its elements in either a contiguous region of memory or an NSArray instance if its Element type is a class or @objc protocol.

If your array’s Element type is a class or @objc protocol and you do not need to bridge the array to NSArray or pass the array to Objective-C APIs, using ContiguousArray may be more efficient and have more predictable performance than Array. If the array’s Element type is a struct or enumeration, Array and ContiguousArray should have similar efficiency.

For more information about using arrays, see Array and ArraySlice, with which ContiguousArray shares most properties and methods.

Topics

Type Aliases

typealias ContiguousArray.Index

The index type for arrays, Int.

typealias ContiguousArray.Indices

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

typealias ContiguousArray.Iterator

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

Initializers

init()

Creates a new, empty array.

init<S>(S)

Creates an array containing the elements of a sequence.

init(arrayLiteral: ContiguousArray<Element>.Element...)

Creates an array from the given array literal.

Beta
init(repeating: ContiguousArray<Element>.Element, count: Int)

Creates a new array containing the specified number of a single, repeated value.

Beta
init(repeating: Element, count: Int)

Creates a new collection containing the specified number of a single, repeated value.

Beta

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 count: Int

The number of elements in the collection.

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 indices: Range<Int>

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

Beta
var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

var last: Element?

The last element of the collection.

var lazy: LazySequence<ContiguousArray<Element>>

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

var lazy: LazyCollection<ContiguousArray<Element>>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

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 sequence, calculated nondestructively.

Beta
var underestimatedCount: Int

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

Beta

Instance Methods

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

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

Beta
func append(ContiguousArray<Element>.Element)

Adds a new element at the end of the array.

func append(Element)

Adds an element to the end of the collection.

func append<S>(contentsOf: S)

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

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

Returns a subsequence containing all but the first element of the sequence.

func dropFirst(Int) -> ArraySlice<Element>

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

func dropLast() -> ArraySlice<Element>

Returns a subsequence containing all but the last element of the sequence.

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

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

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

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

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

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

Beta
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(ContiguousArray<Element>.Element, at: Int)

Inserts a new element at the specified position.

func insert(Element, at: Int)

Inserts a new element into the collection 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() -> FlattenCollection<ContiguousArray<Element>>

Returns the elements of this collection of collections, concatenated.

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

Returns the elements of this sequence of sequences, concatenated.

func joined<Separator>(separator: Separator) -> JoinedSequence<ContiguousArray<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.

Beta
func joined(separator: String) -> String

Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.

Beta
func last(where: (Element) -> Bool) -> Element?

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

Beta
func lastIndex(of: Element) -> Int?

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

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

Returns the index of the last element in the collection that matches the given predicate.

Beta
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<ContiguousArray<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.

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

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

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

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

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

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

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

Beta
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) -> ContiguousArray<Element>.Element

Removes and returns the element at the specified position.

Beta
func remove(at: Int) -> Element

Removes and returns the element at the specified position.

Beta
func removeAll(keepingCapacity: Bool)

Removes all elements from the array.

Beta
func removeAll(keepingCapacity: Bool)

Removes all elements from the collection.

Beta
func removeAll(where: (Element) -> Bool)

Removes all the elements that satisfy the given predicate.

Beta
func removeAll(where: (Element) -> Bool)

Removes all the elements that satisfy the given predicate.

Beta
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>(Range<Int>, with: C)

Replaces a range of elements with the elements in the specified collection.

func replaceSubrange<C, R>(R, with: C)

Replaces the specified subrange of elements with the given collection.

func reserveCapacity(Int)

Reserves enough space to store the specified number of elements.

Beta
func reserveCapacity(Int)

Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.

Beta
func reverse()

Reverses the elements of the collection in place.

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

Returns a view presenting the elements of the collection in reverse order.

func shuffle()

Shuffles the collection in place.

Beta
func shuffle<T>(using: inout T)

Shuffles the collection in place, using the given generator as a source for randomness.

Beta
func shuffled() -> [Element]

Returns the elements of the sequence, shuffled.

Beta
func shuffled<T>(using: inout T) -> [Element]

Returns the elements of the sequence, shuffled using the given generator as a source for randomness.

Beta
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 sequence, in order, around elements equal to the given element.

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

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

Beta
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 withUnsafeBufferPointer<R>((UnsafeBufferPointer<ContiguousArray<Element>.Element>) -> R) -> R

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

Beta
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<ContiguousArray<Element>.Element>) -> R) -> R

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

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

Beta
subscript(Range<Int>) -> Slice<ContiguousArray<Element>>

Accesses a contiguous subrange of the collection’s elements.

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

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

Beta

Operator Functions

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

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

Beta
static func + <Other>(Other, ContiguousArray<Element>) -> ContiguousArray<Element>

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

Beta
static func + <Other>(ContiguousArray<Element>, Other) -> ContiguousArray<Element>

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

Beta
static func + <Other>(ContiguousArray<Element>, Other) -> ContiguousArray<Element>

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

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

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

Beta
static func == (ContiguousArray<ContiguousArray<Element>.Element>, ContiguousArray<ContiguousArray<Element>.Element>) -> Bool

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

See Also

Related Array Types

struct ArraySlice

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

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software