## CountableClosedRange

`struct CountableClosedRange<Bound where Bound : _Strideable & Comparable, Bound.Stride : SignedInteger>`

A closed range that forms a collection of consecutive values.

You create a `CountableClosedRange` instance by using the closed range operator (`...`).

``let throughFive = 0...5``

A `CountableClosedRange` instance contains both its lower bound and its upper bound.

``````print(throughFive.contains(3))      // Prints "true"
print(throughFive.contains(10))     // Prints "false"
print(throughFive.contains(5))      // Prints "true"``````

Because a closed range includes its upper bound, a closed range whose lower bound is equal to the upper bound contains one element. Therefore, a `CountableClosedRange` instance cannot represent an empty range.

``````let zeroInclusive = 0...0
print(zeroInclusive.isEmpty)
// Prints "false"
print(zeroInclusive.count)
// Prints "1"``````

You can use a `for`-`in` loop or any sequence or collection method with a countable range. The elements of the range are the consecutive values from its lower bound up to, and including, its upper bound.

``````for n in throughFive.suffix(3) {
print(n)
}
// Prints "3"
// Prints "4"
// Prints "5"``````

You can create a countable range over any type that conforms to the `Strideable` protocol and uses an integer as its associated `Stride` type. By default, Swift's integer and pointer types are usable as the bounds of a countable range.

Because floating-point types such as `Float` and `Double` are their own `Stride` types, they cannot be used as the bounds of a countable range. If you need to test whether values are contained within a closed interval bound by floating-point values, see the `ClosedRange` type. If you need to iterate over consecutive floating-point values, see the `stride(from:through:by:)` function.

See Also: `CountableRange`, `ClosedRange`, `Range`

Inheritance `BidirectionalCollection, BidirectionalIndexable, Collection, CustomDebugStringConvertible, CustomReflectable, CustomStringConvertible, Equatable, Indexable, IndexableBase, RandomAccessCollection, RandomAccessIndexable, Sequence` View Protocol Hierarchy → `Element = Bound` The element type of the range; the same type as the range's bounds. `Index = ClosedRangeIndex` A type that represents a position in the range. `IndexDistance = Bound.Stride` A type used to represent the number of steps between two indices, where one value is reachable from the other. In Swift, reachability refers to the ability to produce one value from the other through zero or more applications of `index(after:)`. `Iterator = ClosedRangeIterator` A type that provides the collection's iteration interface and encapsulates its iteration state. By default, a collection conforms to the `Sequence` protocol by supplying a `IndexingIterator` as its associated `Iterator` type. `SubSequence = RandomAccessSlice>` Type alias inferred. `import Swift`

### Initializers

init(_: ClosedRange<Bound>)

Creates an instance equivalent to the given range.

`other`: A range to convert to a `CountableClosedRange` instance.

#### Declaration

`init(_ other: ClosedRange<Bound>)`
init(_: CountableClosedRange<Bound>)

Creates an instance equivalent to the given range.

`other`: A range to convert to a `CountableClosedRange` instance.

#### Declaration

`init(_ other: CountableClosedRange<Bound>)`
init(_: CountableRange<Bound>)

Creates an instance equivalent to the given range.

An equivalent range must be representable as an instance of `CountableClosedRange`. For example, passing an empty range as `other` triggers a runtime error, because an empty range cannot be represented by a `CountableClosedRange` instance.

`other`: A range to convert to a `CountableClosedRange` instance.

#### Declaration

`init(_ other: CountableRange<Bound>)`
init(_: Range<Bound>)

Creates an instance equivalent to the given range.

An equivalent range must be representable as an instance of `CountableClosedRange`. For example, passing an empty range as `other` triggers a runtime error, because an empty range cannot be represented by a `CountableClosedRange` instance.

`other`: A range to convert to a `CountableClosedRange` instance.

#### Declaration

`init(_ other: Range<Bound>)`
init(uncheckedBounds bounds: (lower: Bound,:)

Creates an instance with the given bounds.

Because this initializer does not perform any checks, it should be used as an optimization only when you are absolutely certain that `lower` is less than or equal to `upper`. Using the closed range operator (`...`) to form `CountableClosedRange` instances is preferred.

`bounds`: A tuple of the lower and upper bounds of the range.

#### Declaration

`init(uncheckedBounds bounds: (lower: Bound, upper: Bound))`

### Instance Variables

var count: ClosedRangeIndex<Bound>Distance

The number of elements in the collection.

Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the length of the collection.

#### Declaration

`var count: ClosedRangeIndex<Bound>Distance { get }`

#### Declared In

`BidirectionalCollection` , `Collection`
var customMirror: Mirror

The custom mirror for this instance.

If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.

#### Declaration

`var customMirror: Mirror { get }`
var debugDescription: String

A textual representation of the range, suitable for debugging.

#### Declaration

`var debugDescription: String { get }`
var description: String

A textual representation of the range.

#### Declaration

`var description: String { get }`
var endIndex: ClosedRangeIndex<Bound>

The range's "past the end" position---that is, the position one greater than the last valid subscript argument.

#### Declaration

`var endIndex: ClosedRangeIndex<Bound> { get }`
var first: Bound?

The first element of the collection.

If the collection is empty, the value of this property is `nil`.

``````let numbers = [10, 20, 30, 40, 50]
if let firstNumber = numbers.first {
print(firstNumber)
}
// Prints "10"``````

#### Declaration

`var first: Bound? { get }`

#### Declared In

`BidirectionalCollection` , `Collection`
var indices: DefaultRandomAccessIndices<CountableClosedRange<Bound>>

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

A collection's `indices` property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the `index(after:)` method starting with `startIndex` to produce indices instead.

``````var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
c[i] /= 5
i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])``````

#### Declaration

`var indices: DefaultRandomAccessIndices<CountableClosedRange<Bound>> { get }`
var isEmpty: Bool

A Boolean value indicating whether the range contains no elements.

Because a closed range cannot represent an empty range, this property is always `false`.

#### Declaration

`var isEmpty: Bool { get }`

#### Declared In

`CountableClosedRange` , `BidirectionalCollection` , `Collection`
var last: Bound?

The last element of the collection.

If the collection is empty, the value of this property is `nil`.

``````let numbers = [10, 20, 30, 40, 50]
if let lastNumber = numbers.last {
print(lastNumber)
}
// Prints "50"``````

#### Declaration

`var last: Bound? { get }`

#### Declared In

`BidirectionalCollection`
var lazy: LazyRandomAccessCollection<CountableClosedRange<Bound>>

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

Use the `lazy` property when chaining operations to prevent intermediate operations from allocating storage, or when you only need a part of the final collection to avoid unnecessary computation.

See Also: `LazySequenceProtocol`, `LazyCollectionProtocol`.

#### Declaration

`var lazy: LazyRandomAccessCollection<CountableClosedRange<Bound>> { get }`

#### Declared In

`RandomAccessCollection`
var lowerBound: Bound

The range's lower bound.

#### Declaration

`var lowerBound: Bound { get }`
var startIndex: ClosedRangeIndex<Bound>

The position of the first element in the range.

#### Declaration

`var startIndex: ClosedRangeIndex<Bound> { get }`
var underestimatedCount: Int

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

Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the length of the collection.

#### Declaration

`var underestimatedCount: Int { get }`

#### Declared In

`BidirectionalCollection` , `Collection` , `Sequence`
var upperBound: Bound

The range's upper bound.

`upperBound` is always reachable from `lowerBound` by zero or more applications of `index(after:)`.

#### Declaration

`var upperBound: Bound { get }`

### Subscripts

subscript(_: ClosedRange<ClosedRangeIndex<Bound>>)

Accesses a contiguous subrange of the collection's elements.

The accessed slice uses the same indices for the same elements as the original collection. Always use the slice's `startIndex` property instead of assuming that its indices start at a particular value.

This example demonstrates getting a slice of an array of strings, finding the index of one of the strings in the slice, and then using that index in the original array.

``````let streets = ["Adams", "Bryant", "Channing", "Douglas", "Evarts"]
let streetsSlice = streets[2 ..< streets.endIndex]
print(streetsSlice)
// Prints "["Channing", "Douglas", "Evarts"]"

let index = streetsSlice.index(of: "Evarts")    // 4
print(streets[index!])
// Prints "Evarts"``````

`bounds`: A range of the collection's indices. The bounds of the range must be valid indices of the collection.

#### Declaration

`subscript(bounds: ClosedRange<ClosedRangeIndex<Bound>>) -> RandomAccessSlice<CountableClosedRange<Bound>> { get }`

#### Declared In

`BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
subscript(_: ClosedRangeIndex<Bound>)

Accesses the element at specified position.

You can subscript a collection with any valid index other than the collection's end index. The end index refers to the position one past the last element of a collection, so it doesn't correspond with an element.

`position`: The position of the element to access. `position` must be a valid index of the range, and must not equal the range's end index.

#### Declaration

`subscript(position: ClosedRangeIndex<Bound>) -> Bound { get }`
subscript(_: Range<ClosedRangeIndex<Bound>>)

Accesses the subsequence bounded by the given range.

`bounds`: A range of the collection's indices. The upper and lower bounds of the `bounds` range must be valid indices of the collection.

#### Declaration

`subscript(bounds: Range<ClosedRangeIndex<Bound>>) -> RandomAccessSlice<CountableClosedRange<Bound>> { get }`

#### Declared In

`CountableClosedRange`, `RandomAccessCollection`

### Instance Methods

func ==(_:rhs:)

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values `a` and `b`, `a == b` implies that `a != b` is `false`.

Parameters: lhs: A value to compare. rhs: Another value to compare.

#### Declaration

`func ==(lhs: CountableClosedRange<Bound>, rhs: CountableClosedRange<Bound>) -> Bool`
func ~=(_:value:)

#### Declaration

`func ~=(pattern: CountableClosedRange<Bound>, value: Bound) -> Bool`
func clamped(to:)

Returns a copy of this range clamped to the given limiting range.

The bounds of the result are always limited to the bounds of `limits`. For example:

``````let x: CountableClosedRange = 0...20
print(x.clamped(to: 10...1000))
// Prints "10...20"``````

If the two ranges do not overlap, the result is a single-element range at the upper or lower bound of `limits`.

``````let y: CountableClosedRange = 0...5
print(y.clamped(to: 10...1000))
// Prints "10...10"``````

`limits`: The range to clamp the bounds of this range. Returns: A new range clamped to the bounds of `limits`.

#### Declaration

`func clamped(to limits: CountableClosedRange<Bound>) -> CountableClosedRange<Bound>`
func contains(where:)

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

You can use the predicate to check for an element of a type that doesn't conform to the `Equatable` protocol, such as the `HTTPResponse` enumeration in this example.

``````enum HTTPResponse {
case ok
case error(Int)
}

let lastThreeResponses: [HTTPResponse] = [.ok, .ok, .error(404)]
let hadError = lastThreeResponses.contains { element in
if case .error = element {
return true
} else {
return false
}
}

Alternatively, a predicate can be satisfied by a range of `Equatable` elements or a general condition. This example shows how you can check an array for an expense greater than \$100.

``````let expenses = [21.37, 55.21, 9.32, 10.18, 388.77, 11.41]
let hasBigPurchase = expenses.contains { \$0 > 100 }
// 'hasBigPurchase' == true``````

`predicate`: A closure that takes an element of the sequence as its argument and returns a Boolean value that indicates whether the passed element represents a match. Returns: `true` if the sequence contains an element that satisfies `predicate`; otherwise, `false`.

#### Declaration

`func contains(where predicate: (Bound) throws -> Bool) rethrows -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func distance(from:to:)

Returns the distance between two indices.

Unless the collection conforms to the `BidirectionalCollection` protocol, `start` must be less than or equal to `end`.

Parameters: start: A valid index of the collection. end: Another valid index of the collection. If `end` is equal to `start`, the result is zero. Returns: The distance between `start` and `end`. The result can be negative only if the collection conforms to the `BidirectionalCollection` protocol.

Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the resulting distance.

#### Declaration

`func distance(from start: ClosedRangeIndex<Bound>, to end: ClosedRangeIndex<Bound>) -> Bound.Stride`

#### Declared In

`CountableClosedRange`, `BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func dropFirst()

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

The following example drops the first element from an array of integers.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.dropFirst())
// Prints "[2, 3, 4, 5]"``````

If the sequence has no elements, the result is an empty subsequence.

``````let empty: [Int] = []
print(empty.dropFirst())
// Prints "[]"``````

Returns: A subsequence starting after the first element of the sequence.

Complexity: O(1)

#### Declaration

`func dropFirst() -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func dropFirst(_:)

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

If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.dropFirst(2))
// Prints "[3, 4, 5]"
print(numbers.dropFirst(10))
// Prints "[]"``````

`n`: The number of elements to drop from the beginning of the collection. `n` must be greater than or equal to zero. Returns: A subsequence starting after the specified number of elements.

Complexity: O(n), where n is the number of elements to drop from the beginning of the collection.

#### Declaration

`func dropFirst(_ n: Int) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func dropLast()

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

The sequence must be finite. If the sequence has no elements, the result is an empty subsequence.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.dropLast())
// Prints "[1, 2, 3, 4]"``````

If the sequence has no elements, the result is an empty subsequence.

``````let empty: [Int] = []
print(empty.dropLast())
// Prints "[]"``````

Returns: A subsequence leaving off the last element of the sequence.

Complexity: O(n), where n is the length of the sequence.

#### Declaration

`func dropLast() -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func dropLast(_:)

Returns a subsequence containing all but the specified number of final elements.

If the number of elements to drop exceeds the number of elements in the collection, the result is an empty subsequence.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.dropLast(2))
// Prints "[1, 2, 3]"
print(numbers.dropLast(10))
// Prints "[]"``````

`n`: The number of elements to drop off the end of the collection. `n` must be greater than or equal to zero. Returns: A subsequence that leaves off `n` elements from the end.

Complexity: O(n), where n is the number of elements to drop.

#### Declaration

`func dropLast(_ n: Int) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func elementsEqual(_:by:)

Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements, using the given predicate as the equivalence test.

At least one of the sequences must be finite.

The predicate must be a equivalence relation over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areEquivalent(a, a)` is always `true`. (Reflexivity)
• `areEquivalent(a, b)` implies `areEquivalent(b, a)`. (Symmetry)
• If `areEquivalent(a, b)` and `areEquivalent(b, c)` are both `true`, then `areEquivalent(a, c)` is also `true`. (Transitivity)

Parameters: other: A sequence to compare to this sequence. areEquivalent: A predicate that returns `true` if its two arguments are equivalent; otherwise, `false`. Returns: `true` if this sequence and `other` contain equivalent items, using `areEquivalent` as the equivalence test; otherwise, `false.`

See Also: `elementsEqual(_:)`

#### Declaration

`func elementsEqual<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == Iterator.Element>(_ other: OtherSequence, by areEquivalent: (Bound, Bound) throws -> Bool) rethrows -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func enumerated()

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero, and x represents an element of the sequence.

This example enumerates the characters of the string "Swift" and prints each character along with its place in the string.

``````for (n, c) in "Swift".characters.enumerated() {
print("\(n): '\(c)'")
}
// Prints "0: 'S'"
// Prints "1: 'w'"
// Prints "2: 'i'"
// Prints "3: 'f'"
// Prints "4: 't'"``````

When enumerating a collection, the integer part of each pair is a counter for the enumeration, not necessarily the index of the paired value. These counters can only be used as indices in instances of zero-based, integer-indexed collections, such as `Array` and `ContiguousArray`. For other collections the counters may be out of range or of the wrong type to use as an index. To iterate over the elements of a collection with its indices, use the `zip(_:_:)` function.

This example iterates over the indices and elements of a set, building a list of indices of names with five or fewer letters.

``````let names: Set = ["Sofia", "Camilla", "Martina", "Mateo", "Nicolás"]
var shorterIndices: [SetIndex<String>] = []
for (i, name) in zip(names.indices, names) {
if name.characters.count <= 5 {
shorterIndices.append(i)
}
}``````

Now that the `shorterIndices` array holds the indices of the shorter names in the `names` set, you can use those indices to access elements in the set.

``````for i in shorterIndices {
print(names[i])
}
// Prints "Sofia"
// Prints "Mateo"``````

Returns: A sequence of pairs enumerating the sequence.

#### Declaration

`func enumerated() -> EnumeratedSequence<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func filter(_:)

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

In this example, `filter` is used to include only names shorter than five characters.

``````let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let shortNames = cast.filter { \$0.characters.count < 5 }
print(shortNames)
// Prints "["Kim", "Karl"]"``````

`shouldInclude`: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element should be included in the returned array. Returns: An array of the elements that `includeElement` allowed.

#### Declaration

`func filter(_ isIncluded: (Bound) throws -> Bool) rethrows -> [Bound]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func first(where:)

Returns the first element of the sequence that satisfies the given predicate or nil if no such element is found.

`predicate`: A closure that takes an element of the sequence as its argument and returns a Boolean value indicating whether the element is a match. Returns: The first match or `nil` if there was no match.

#### Declaration

`func first(where predicate: (Bound) throws -> Bool) rethrows -> Bound?`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func flatMap<ElementOfResult>(_: (Bound) throws -> ElementOfResult?)

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

Use this method to receive an array of nonoptional values when your transformation produces an optional value.

In this example, note the difference in the result of using `map` and `flatMap` with a transformation that returns an optional `Int` value.

``````let possibleNumbers = ["1", "2", "three", "///4///", "5"]

let mapped: [Int?] = numbers.map { str in Int(str) }
// [1, 2, nil, nil, 5]

let flatMapped: [Int] = numbers.flatMap { str in Int(str) }
// [1, 2, 5]``````

`transform`: A closure that accepts an element of this sequence as its argument and returns an optional value. Returns: An array of the non-`nil` results of calling `transform` with each element of the sequence.

Complexity: O(m + n), where m is the length of this sequence and n is the length of the result.

#### Declaration

`func flatMap<ElementOfResult>(_ transform: (Bound) throws -> ElementOfResult?) rethrows -> [ElementOfResult]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func flatMap<SegmentOfResult : Sequence>(_: (Bound) throws -> SegmentOfResult)

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

Use this method to receive a single-level collection when your transformation produces a sequence or collection for each element.

In this example, note the difference in the result of using `map` and `flatMap` with a transformation that returns an array.

``````let numbers = [1, 2, 3, 4]

let mapped = numbers.map { Array(count: \$0, repeatedValue: \$0) }
// [[1], [2, 2], [3, 3, 3], [4, 4, 4, 4]]

let flatMapped = numbers.flatMap { Array(count: \$0, repeatedValue: \$0) }
// [1, 2, 2, 3, 3, 3, 4, 4, 4, 4]``````

In fact, `s.flatMap(transform)` is equivalent to `Array(s.map(transform).joined())`.

`transform`: A closure that accepts an element of this sequence as its argument and returns a sequence or collection. Returns: The resulting flattened array.

Complexity: O(m + n), where m is the length of this sequence and n is the length of the result. See Also: `joined()`, `map(_:)`

#### Declaration

`func flatMap<SegmentOfResult : Sequence>(_ transform: (Bound) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Iterator.Element]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func forEach(_:)

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

The two loops in the following example produce the same output:

``````let numberWords = ["one", "two", "three"]
for word in numberWords {
print(word)
}
// Prints "one"
// Prints "two"
// Prints "three"

numberWords.forEach { word in
print(word)
}
// Same as above``````

Using the `forEach` method is distinct from a `for`-`in` loop in two important ways:

1. You cannot use a `break` or `continue` statement to exit the current call of the `body` closure or skip subsequent calls.
2. Using the `return` statement in the `body` closure will exit only from the current call to `body`, not from any outer scope, and won't skip subsequent calls.

`body`: A closure that takes an element of the sequence as a parameter.

#### Declaration

`func forEach(_ body: (Bound) throws -> Swift.Void) rethrows`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func formIndex(_:offsetBy:)

Offsets the given index by the specified distance.

The value passed as `n` must not offset `i` beyond the `endIndex` or before the `startIndex` of this collection.

Parameters: i: A valid index of the collection. n: The distance to offset `i`. `n` must not be negative unless the collection conforms to the `BidirectionalCollection` protocol.

See Also: `index(_:offsetBy:)`, `formIndex(_:offsetBy:limitedBy:)` Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the absolute value of `n`.

#### Declaration

`func formIndex(_ i: inout ClosedRangeIndex<Bound>, offsetBy n: ClosedRangeIndex<Bound>Distance)`

#### Declared In

`BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func formIndex(_:offsetBy:limitedBy:)

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

The value passed as `n` must not offset `i` beyond the `endIndex` or before the `startIndex` of this collection, unless the index passed as `limit` prevents offsetting beyond those bounds.

Parameters: i: A valid index of the collection. n: The distance to offset `i`. `n` must not be negative unless the collection conforms to the `BidirectionalCollection` protocol. Returns: `true` if `i` has been offset by exactly `n` steps without going beyond `limit`; otherwise, `false`. When the return value is `false`, the value of `i` is equal to `limit`.

See Also: `index(_:offsetBy:)`, `formIndex(_:offsetBy:limitedBy:)` Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the absolute value of `n`.

#### Declaration

`func formIndex(_ i: inout ClosedRangeIndex<Bound>, offsetBy n: ClosedRangeIndex<Bound>Distance, limitedBy limit: ClosedRangeIndex<Bound>) -> Bool`

#### Declared In

`BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func formIndex(after:)

Replaces the given index with its successor.

`i`: A valid index of the collection. `i` must be less than `endIndex`.

#### Declaration

`func formIndex(after i: inout ClosedRangeIndex<Bound>)`

#### Declared In

`BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func formIndex(before:)

Replaces the given index with its predecessor.

`i`: A valid index of the collection. `i` must be greater than `startIndex`.

#### Declaration

`func formIndex(before i: inout ClosedRangeIndex<Bound>)`

#### Declared In

`BidirectionalCollection`, `BidirectionalIndexable`
func index(_:offsetBy:)

Returns an index that is the specified distance from the given index.

The following example obtains an index advanced four positions from a string's starting index and then prints the character at that position.

``````let s = "Swift"
let i = s.index(s.startIndex, offsetBy: 4)
print(s[i])
// Prints "t"``````

The value passed as `n` must not offset `i` beyond the `endIndex` or before the `startIndex` of this collection.

Parameters: i: A valid index of the collection. n: The distance to offset `i`. `n` must not be negative unless the collection conforms to the `BidirectionalCollection` protocol. Returns: An index offset by `n` from the index `i`. If `n` is positive, this is the same value as the result of `n` calls to `index(after:)`. If `n` is negative, this is the same value as the result of `-n` calls to `index(before:)`.

See Also: `index(_:offsetBy:limitedBy:)`, `formIndex(_:offsetBy:)` Complexity: O(1) if the collection conforms to `RandomAccessCollection`; otherwise, O(n), where n is the absolute value of `n`.

#### Declaration

`func index(_ i: ClosedRangeIndex<Bound>, offsetBy n: Bound.Stride) -> ClosedRangeIndex<Bound>`

#### Declared In

`CountableClosedRange`, `BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func index(_:offsetBy:limitedBy:)

Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.

The following example obtains an index advanced four positions from an array's starting index and then prints the element at that position. The operation doesn't require going beyond the limiting `numbers.endIndex` value, so it succeeds.

``````let numbers = [10, 20, 30, 40, 50]
let i = numbers.index(numbers.startIndex, offsetBy: 4)
print(numbers[i])
// Prints "50"``````

The next example attempts to retrieve an index ten positions from `numbers.startIndex`, but fails, because that distance is beyond the index passed as `limit`.

``````let j = numbers.index(numbers.startIndex,
offsetBy: 10,
limitedBy: numbers.endIndex)
print(j)
// Prints "nil"``````

The value passed as `n` must not offset `i` beyond the `endIndex` or before the `startIndex` of this collection, unless the index passed as `limit` prevents offsetting beyond those bounds.

Parameters: i: A valid index of the array. n: The distance to offset `i`. limit: A valid index of the collection to use as a limit. If `n > 0`, `limit` should be greater than `i` to have any effect. Likewise, if `n < 0`, `limit` should be less than `i` to have any effect. Returns: An index offset by `n` from the index `i`, unless that index would be beyond `limit` in the direction of movement. In that case, the method returns `nil`.

Complexity: O(1)

#### Declaration

`func index(_ i: ClosedRangeIndex<Bound>, offsetBy n: ClosedRangeIndex<Bound>Distance, limitedBy limit: ClosedRangeIndex<Bound>) -> ClosedRangeIndex<Bound>?`

#### Declared In

`RandomAccessIndexable`, `BidirectionalCollection`, `BidirectionalIndexable`, `Collection`, `Indexable`
func index(after:)

Returns the position immediately after the given index.

`i`: A valid index of the collection. `i` must be less than `endIndex`. Returns: The index value immediately after `i`.

#### Declaration

`func index(after i: ClosedRangeIndex<Bound>) -> ClosedRangeIndex<Bound>`
func index(before:)

Returns the position immediately before the given index.

`i`: A valid index of the collection. `i` must be greater than `startIndex`. Returns: The index value immediately before `i`.

#### Declaration

`func index(before i: ClosedRangeIndex<Bound>) -> ClosedRangeIndex<Bound>`
func index(where:)

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

You can use the predicate to find an element of a type that doesn't conform to the `Equatable` protocol or to find an element that matches particular criteria. Here's an example that finds a student name that begins with the letter "A":

``````let students = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
if let i = students.index(where: { \$0.hasPrefix("A") }) {
print("\(students[i]) starts with 'A'!")
}
// Prints "Abena starts with 'A'!"``````

`predicate`: A closure that takes an element as its argument and returns a Boolean value that indicates whether the passed element represents a match. Returns: The index of the first element for which `predicate` returns `true`. If no elements in the collection satisfy the given predicate, returns `nil`.

See Also: `index(of:)`

#### Declaration

`func index(where predicate: (Bound) throws -> Bool) rethrows -> ClosedRangeIndex<Bound>?`

#### Declared In

`BidirectionalCollection`, `Collection`
func lexicographicallyPrecedes(_:by:)

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.

The predicate must be a strict weak ordering over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areInIncreasingOrder(a, a)` is always `false`. (Irreflexivity)
• If `areInIncreasingOrder(a, b)` and `areInIncreasingOrder(b, c)` are both `true`, then `areInIncreasingOrder(a, c)` is also `true`. (Transitive comparability)
• Two elements are incomparable if neither is ordered before the other according to the predicate. If `a` and `b` are incomparable, and `b` and `c` are incomparable, then `a` and `c` are also incomparable. (Transitive incomparability)

Parameters: other: A sequence to compare to this sequence. areInIncreasingOrder: A predicate that returns `true` if its first argument should be ordered before its second argument; otherwise, `false`. Returns: `true` if this sequence precedes `other` in a dictionary ordering as ordered by `areInIncreasingOrder`; otherwise, `false`.

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, use `String` APIs that perform localized comparison instead. See Also: `lexicographicallyPrecedes(_:)`

#### Declaration

`func lexicographicallyPrecedes<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == Iterator.Element>(_ other: OtherSequence, by areInIncreasingOrder: (Bound, Bound) throws -> Bool) rethrows -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func makeIterator()

Returns an iterator over the elements of the collection.

#### Declaration

`func makeIterator() -> ClosedRangeIterator<Bound>`
func map(_:)

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

In this example, `map` is used first to convert the names in the array to lowercase strings and then to count their characters.

``````let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let lowercaseNames = cast.map { \$0.lowercaseString }
// 'lowercaseNames' == ["vivien", "marlon", "kim", "karl"]
let letterCounts = cast.map { \$0.characters.count }
// 'letterCounts' == [6, 6, 3, 4]``````

`transform`: A mapping closure. `transform` accepts an element of this sequence as its parameter and returns a transformed value of the same or of a different type. Returns: An array containing the transformed elements of this sequence.

#### Declaration

`func map<T>(_ transform: (Bound) throws -> T) rethrows -> [T]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
@warn_unqualified_access func max(by:)

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

The predicate must be a strict weak ordering over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areInIncreasingOrder(a, a)` is always `false`. (Irreflexivity)
• If `areInIncreasingOrder(a, b)` and `areInIncreasingOrder(b, c)` are both `true`, then `areInIncreasingOrder(a, c)` is also `true`. (Transitive comparability)
• Two elements are incomparable if neither is ordered before the other according to the predicate. If `a` and `b` are incomparable, and `b` and `c` are incomparable, then `a` and `c` are also incomparable. (Transitive incomparability)

This example shows how to use the `max(by:)` method on a dictionary to find the key-value pair with the highest value.

``````let hues = ["Heliotrope": 296, "Coral": 16, "Aquamarine": 156]
let greatestHue = hues.max { a, b in a.value < b.value }
print(greatestHue)
// Prints "Optional(("Heliotrope", 296))"``````

`areInIncreasingOrder`: A predicate that returns `true` if its first argument should be ordered before its second argument; otherwise, `false`. Returns: The sequence's maximum element if the sequence is not empty; otherwise, `nil`.

See Also: `max()`

#### Declaration

```@warn_unqualified_access func max(by areInIncreasingOrder: (Bound, Bound) throws -> Bool) rethrows -> Bound?```

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
@warn_unqualified_access func min(by:)

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

The predicate must be a strict weak ordering over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areInIncreasingOrder(a, a)` is always `false`. (Irreflexivity)
• If `areInIncreasingOrder(a, b)` and `areInIncreasingOrder(b, c)` are both `true`, then `areInIncreasingOrder(a, c)` is also `true`. (Transitive comparability)
• Two elements are incomparable if neither is ordered before the other according to the predicate. If `a` and `b` are incomparable, and `b` and `c` are incomparable, then `a` and `c` are also incomparable. (Transitive incomparability)

This example shows how to use the `min(by:)` method on a dictionary to find the key-value pair with the lowest value.

``````let hues = ["Heliotrope": 296, "Coral": 16, "Aquamarine": 156]
let leastHue = hues.min { a, b in a.value < b.value }
print(leastHue)
// Prints "Optional(("Coral", 16))"``````

`areInIncreasingOrder`: A predicate that returns `true` if its first argument should be ordered before its second argument; otherwise, `false`. Returns: The sequence's minimum element, according to `areInIncreasingOrder`. If the sequence has no elements, returns `nil`.

See Also: `min()`

#### Declaration

```@warn_unqualified_access func min(by areInIncreasingOrder: (Bound, Bound) throws -> Bool) rethrows -> Bound?```

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func overlaps(_: ClosedRange<Bound>)

Returns a Boolean value indicating whether this range and the given range contain an element in common.

This example shows two overlapping ranges:

``````let x: CountableClosedRange = 0...20
print(x.overlaps(10...1000 as ClosedRange))
// Prints "true"``````

Because a closed range includes its upper bound, the ranges in the following example also overlap:

``````let y: ClosedRange = 20...30
print(x.overlaps(y))
// Prints "true"``````

`other`: A range to check for elements in common. Returns: `true` if this range and `other` have at least one element in common; otherwise, `false`.

#### Declaration

`func overlaps(_ other: ClosedRange<Bound>) -> Bool`
func overlaps(_: CountableClosedRange<Bound>)

Returns a Boolean value indicating whether this range and the given range contain an element in common.

This example shows two overlapping ranges:

``````let x: CountableClosedRange = 0...20
print(x.overlaps(10...1000 as CountableClosedRange))
// Prints "true"``````

Because a closed range includes its upper bound, the ranges in the following example also overlap:

``````let y: CountableClosedRange = 20...30
print(x.overlaps(y))
// Prints "true"``````

`other`: A range to check for elements in common. Returns: `true` if this range and `other` have at least one element in common; otherwise, `false`.

#### Declaration

`func overlaps(_ other: CountableClosedRange<Bound>) -> Bool`
func overlaps(_: CountableRange<Bound>)

Returns a Boolean value indicating whether this range and the given range contain an element in common.

This example shows two overlapping ranges:

``````let x: CountableClosedRange = 0...20
print(x.overlaps(10..<1000 as CountableRange))
// Prints "true"``````

Because a closed range includes its upper bound, the ranges in the following example also overlap:

``````let y: CountableRange = 20...30
print(x.overlaps(y))
// Prints "true"``````

`other`: A range to check for elements in common. Returns: `true` if this range and `other` have at least one element in common; otherwise, `false`.

#### Declaration

`func overlaps(_ other: CountableRange<Bound>) -> Bool`
func overlaps(_: Range<Bound>)

Returns a Boolean value indicating whether this range and the given range contain an element in common.

This example shows two overlapping ranges:

``````let x: CountableClosedRange = 0...20
print(x.overlaps(10..<1000 as Range))
// Prints "true"``````

Because a closed range includes its upper bound, the ranges in the following example also overlap:

``````let y: Range = 20...30
print(x.overlaps(y))
// Prints "true"``````

`other`: A range to check for elements in common. Returns: `true` if this range and `other` have at least one element in common; otherwise, `false`.

#### Declaration

`func overlaps(_ other: Range<Bound>) -> Bool`
func prefix(_:)

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

If the maximum length exceeds the number of elements in the collection, the result contains all the elements in the collection.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.prefix(2))
// Prints "[1, 2]"
print(numbers.prefix(10))
// Prints "[1, 2, 3, 4, 5]"``````

`maxLength`: The maximum number of elements to return. `maxLength` must be greater than or equal to zero. Returns: A subsequence starting at the beginning of this collection with at most `maxLength` elements.

#### Declaration

`func prefix(_ maxLength: Int) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func prefix(through:)

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

The resulting subsequence includes the element at the position `end`. The following example searches for the index of the number `40` in an array of integers, and then prints the prefix of the array up to, and including, that index:

``````let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
print(numbers.prefix(through: i))
}
// Prints "[10, 20, 30, 40]"``````

`end`: The index of the last element to include in the resulting subsequence. `end` must be a valid index of the collection that is not equal to the `endIndex` property. Returns: A subsequence up to, and including, the `end` position.

Complexity: O(1) See Also: `prefix(upTo:)`

#### Declaration

`func prefix(through position: ClosedRangeIndex<Bound>) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`
func prefix(upTo:)

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

The resulting subsequence does not include the element at the position `end`. The following example searches for the index of the number `40` in an array of integers, and then prints the prefix of the array up to, but not including, that index:

``````let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
print(numbers.prefix(upTo: i))
}
// Prints "[10, 20, 30]"``````

Passing the collection's starting index as the `end` parameter results in an empty subsequence.

``````print(numbers.prefix(upTo: numbers.startIndex))
// Prints "[]"``````

`end`: The "past the end" index of the resulting subsequence. `end` must be a valid index of the collection. Returns: A subsequence up to, but not including, the `end` position.

Complexity: O(1) See Also: `prefix(through:)`

#### Declaration

`func prefix(upTo end: ClosedRangeIndex<Bound>) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`
func reduce(_:_:)

Returns the result of calling the given combining closure with each element of this sequence and an accumulating value.

The `nextPartialResult` closure is called sequentially with an accumulating value initialized to `initialResult` and each element of the sequence. This example shows how to find the sum of an array of numbers.

``````let numbers = [1, 2, 3, 4]
let addTwo: (Int, Int) -> Int = { x, y in x + y }
// 'numberSum' == 10``````

When `numbers.reduce(_:_:)` is called, the following steps occur:

1. The `nextPartialResult` closure is called with the initial result and the first element of `numbers`, returning the sum: `1`.
2. The closure is called again repeatedly with the previous call's return value and each element of the sequence.
3. When the sequence is exhausted, the last value returned from the closure is returned to the caller.

Parameters: initialResult: the initial accumulating value. nextPartialResult: A closure that combines an accumulating value and an element of the sequence into a new accumulating value, to be used in the next call of the `nextPartialResult` closure or returned to the caller. Returns: The final accumulated value.

#### Declaration

`func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (Result, Bound) throws -> Result) rethrows -> Result`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func reversed()

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

You can reverse a collection without allocating new space for its elements by calling this `reversed()` method. A `ReversedRandomAccessCollection` instance wraps an underlying collection and provides access to its elements in reverse order. This example prints the elements of an array in reverse order:

``````let numbers = [3, 5, 7]
for number in numbers.reversed() {
print(number)
}
// Prints "7"
// Prints "5"
// Prints "3"``````

If you need a reversed collection of the same type, you may be able to use the collection's sequence-based or collection-based initializer. For example, to get the reversed version of an array, initialize a new `Array` instance from the result of this `reversed()` method.

``````let reversedNumbers = Array(numbers.reversed())
print(reversedNumbers)
// Prints "[7, 5, 3]"``````

Complexity: O(1)

#### Declaration

`func reversed() -> ReversedRandomAccessCollection<CountableClosedRange<Bound>>`

#### Declared In

`RandomAccessCollection`, `BidirectionalCollection`, `Collection`, `Sequence`
func sorted(by:)

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

When you want to sort a sequence of elements that don't conform to the `Comparable` protocol, pass a predicate to this method that returns `true` when the first element passed should be ordered before the second. The elements of the resulting array are ordered according to the given predicate.

The predicate must be a strict weak ordering over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areInIncreasingOrder(a, a)` is always `false`. (Irreflexivity)
• If `areInIncreasingOrder(a, b)` and `areInIncreasingOrder(b, c)` are both `true`, then `areInIncreasingOrder(a, c)` is also `true`. (Transitive comparability)
• Two elements are incomparable if neither is ordered before the other according to the predicate. If `a` and `b` are incomparable, and `b` and `c` are incomparable, then `a` and `c` are also incomparable. (Transitive incomparability)

The sorting algorithm is not stable. A nonstable sort may change the relative order of elements for which `areInIncreasingOrder` does not establish an order.

In the following example, the predicate provides an ordering for an array of a custom `HTTPResponse` type. The predicate orders errors before successes and sorts the error responses by their error code.

``````enum HTTPResponse {
case ok
case error(Int)
}

let responses: [HTTPResponse] = [.error(500), .ok, .ok, .error(404), .error(403)]
let sortedResponses = responses.sorted {
switch (\$0, \$1) {
// Order errors by code
case let (.error(aCode), .error(bCode)):
return aCode < bCode

// All successes are equivalent, so none is before any other
case (.ok, .ok): return false

// Order errors before successes
case (.error, .ok): return true
case (.ok, .error): return false
}
}
print(sortedResponses)
// Prints "[.error(403), .error(404), .error(500), .ok, .ok]"``````

You also use this method to sort elements that conform to the `Comparable` protocol in descending order. To sort your sequence in descending order, pass the greater-than operator (`>`) as the `areInIncreasingOrder` parameter.

``````let students: Set = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
let descendingStudents = students.sorted(by: >)
print(descendingStudents)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"``````

Calling the related `sorted()` method is equivalent to calling this method and passing the less-than operator (`<`) as the predicate.

``````print(students.sorted())
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"
print(students.sorted(by: <))
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"``````

`areInIncreasingOrder`: A predicate that returns `true` if its first argument should be ordered before its second argument; otherwise, `false`. Returns: A sorted array of the sequence's elements.

See Also: `sorted()`

#### Declaration

`func sorted(by areInIncreasingOrder: (Bound, Bound) -> Bool) -> [Bound]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func split(_:omittingEmptySubsequences:whereSeparator:)

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

The resulting array consists of at most `maxSplits + 1` subsequences. Elements that are used to split the sequence are not returned as part of any subsequence.

The following examples show the effects of the `maxSplits` and `omittingEmptySubsequences` parameters when splitting a string using a closure that matches spaces. The first use of `split` returns each word that was originally separated by one or more spaces.

``````let line = "BLANCHE:   I don't want realism. I want magic!"
print(line.characters.split(whereSeparator: { \$0 == " " })
.map(String.init))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"``````

The second example passes `1` for the `maxSplits` parameter, so the original string is split just once, into two new strings.

``````print(
line.characters.split(
maxSplits: 1, whereSeparator: { \$0 == " " }
).map(String.init))
// Prints "["BLANCHE:", "  I don\'t want realism. I want magic!"]"``````

The final example passes `false` for the `omittingEmptySubsequences` parameter, so the returned array contains empty strings where spaces were repeated.

``````print(line.characters.split(omittingEmptySubsequences: false, whereSeparator: { \$0 == " " })
.map(String.init))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"``````

Parameters: maxSplits: The maximum number of times to split the collection, or one less than the number of subsequences to return. If `maxSplits + 1` subsequences are returned, the last one is a suffix of the original collection containing the remaining elements. `maxSplits` must be greater than or equal to zero. The default value is `Int.max`. omittingEmptySubsequences: If `false`, an empty subsequence is returned in the result for each pair of consecutive elements satisfying the `isSeparator` predicate and for each element at the start or end of the collection satisfying the `isSeparator` predicate. The default value is `true`. isSeparator: A closure that takes an element as an argument and returns a Boolean value indicating whether the collection should be split at that element. Returns: An array of subsequences, split from this collection's elements.

#### Declaration

`func split(maxSplits: Int = default, omittingEmptySubsequences: Bool = default, whereSeparator isSeparator: (Bound) throws -> Bool) rethrows -> [RandomAccessSlice<CountableClosedRange<Bound>>]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func starts(with:by:)

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.

The predicate must be a equivalence relation over the elements. That is, for any elements `a`, `b`, and `c`, the following conditions must hold:

• `areEquivalent(a, a)` is always `true`. (Reflexivity)
• `areEquivalent(a, b)` implies `areEquivalent(b, a)`. (Symmetry)
• If `areEquivalent(a, b)` and `areEquivalent(b, c)` are both `true`, then `areEquivalent(a, c)` is also `true`. (Transitivity)

Parameters: possiblePrefix: A sequence to compare to this sequence. areEquivalent: A predicate that returns `true` if its two arguments are equivalent; otherwise, `false`. Returns: `true` if the initial elements of the sequence are equivalent to the elements of `possiblePrefix`; otherwise, `false`. If `possiblePrefix` has no elements, the return value is `true`.

See Also: `starts(with:)`

#### Declaration

`func starts<PossiblePrefix where PossiblePrefix : Sequence, PossiblePrefix.Iterator.Element == Iterator.Element>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Bound, Bound) throws -> Bool) rethrows -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func suffix(_:)

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

If the maximum length exceeds the number of elements in the collection, the result contains the entire collection.

``````let numbers = [1, 2, 3, 4, 5]
print(numbers.suffix(2))
// Prints "[4, 5]"
print(numbers.suffix(10))
// Prints "[1, 2, 3, 4, 5]"``````

`maxLength`: The maximum number of elements to return. `maxLength` must be greater than or equal to zero. Returns: A subsequence terminating at the end of the collection with at most `maxLength` elements.

Complexity: O(n), where n is equal to `maxLength`.

#### Declaration

`func suffix(_ maxLength: Int) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func suffix(from:)

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

The following example searches for the index of the number `40` in an array of integers, and then prints the suffix of the array starting at that index:

``````let numbers = [10, 20, 30, 40, 50, 60]
if let i = numbers.index(of: 40) {
print(numbers.suffix(from: i))
}
// Prints "[40, 50, 60]"``````

Passing the collection's `endIndex` as the `start` parameter results in an empty subsequence.

``````print(numbers.suffix(from: numbers.endIndex))
// Prints "[]"``````

`start`: The index at which to start the resulting subsequence. `start` must be a valid index of the collection. Returns: A subsequence starting at the `start` position.

Complexity: O(1)

#### Declaration

`func suffix(from start: ClosedRangeIndex<Bound>) -> RandomAccessSlice<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`

### 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 Indices == DefaultBidirectionalIndices

var indices: DefaultBidirectionalIndices<CountableClosedRange<Bound>>

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

A collection's `indices` property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the `index(after:)` method starting with `startIndex` to produce indices instead.

``````var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
c[i] /= 5
i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])``````

#### Declaration

`var indices: DefaultBidirectionalIndices<CountableClosedRange<Bound>> { get }`

#### Declared In

`BidirectionalCollection`

#### Where Indices == DefaultIndices

var indices: DefaultIndices<CountableClosedRange<Bound>>

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

A collection's `indices` property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the `index(after:)` method starting with `startIndex` to produce indices instead.

``````var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
c[i] /= 5
i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])``````

#### Declaration

`var indices: DefaultIndices<CountableClosedRange<Bound>> { get }`

#### Declared In

`BidirectionalCollection` , `Collection`

#### Where Indices == DefaultRandomAccessIndices

var indices: DefaultRandomAccessIndices<CountableClosedRange<Bound>>

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

A collection's `indices` property can hold a strong reference to the collection itself, causing the collection to be non-uniquely referenced. If you mutate the collection while iterating over its indices, a strong reference can cause an unexpected copy of the collection. To avoid the unexpected copy, use the `index(after:)` method starting with `startIndex` to produce indices instead.

``````var c = MyFancyCollection([10, 20, 30, 40, 50])
var i = c.startIndex
while i != c.endIndex {
c[i] /= 5
i = c.index(after: i)
}
// c == MyFancyCollection([2, 4, 6, 8, 10])``````

#### Declaration

`var indices: DefaultRandomAccessIndices<CountableClosedRange<Bound>> { get }`

#### Declared In

`RandomAccessCollection`

#### Where Iterator == IndexingIterator

func makeIterator()

Returns an iterator over the elements of the collection.

#### Declaration

`func makeIterator() -> IndexingIterator<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`

#### Where Iterator == Self, Self : IteratorProtocol

func makeIterator()

Returns an iterator over the elements of this sequence.

#### Declaration

`func makeIterator() -> CountableClosedRange<Bound>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`

#### Where Iterator.Element : BidirectionalCollection

func joined()

Returns the elements of this collection of collections, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

``````let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"``````

Returns: A flattened view of the elements of this collection of collections.

See Also: `flatMap(_:)`, `joined(separator:)`

#### Declaration

`func joined() -> FlattenBidirectionalCollection<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`

#### Where Iterator.Element : Collection

func joined()

Returns the elements of this collection of collections, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

``````let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"``````

Returns: A flattened view of the elements of this collection of collections.

See Also: `flatMap(_:)`, `joined(separator:)`

#### Declaration

`func joined() -> FlattenCollection<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`

#### Where Iterator.Element : Comparable

func lexicographicallyPrecedes(_:)

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (`<`) to compare elements.

This example uses the `lexicographicallyPrecedes` method to test which array of integers comes first in a lexicographical ordering.

``````let a = [1, 2, 2, 2]
let b = [1, 2, 3, 4]

print(a.lexicographicallyPrecedes(b))
// Prints "true"
print(b.lexicographicallyPrecedes(b))
// Prints "false"``````

`other`: A sequence to compare to this sequence. Returns: `true` if this sequence precedes `other` in a dictionary ordering; otherwise, `false`.

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, use `String` APIs that perform localized comparison. See Also: `lexicographicallyPrecedes(_:by:)`

#### Declaration

`func lexicographicallyPrecedes<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == Iterator.Element>(_ other: OtherSequence) -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
@warn_unqualified_access func max()

Returns the maximum element in the sequence.

This example finds the smallest value in an array of height measurements.

``````let heights = [67.5, 65.7, 64.3, 61.1, 58.5, 60.3, 64.9]
let greatestHeight = heights.max()
print(greatestHeight)
// Prints "Optional(67.5)"``````

Returns: The sequence's maximum element. If the sequence has no elements, returns `nil`.

See Also: `max(by:)`

#### Declaration

```@warn_unqualified_access func max() -> Bound?```

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
@warn_unqualified_access func min()

Returns the minimum element in the sequence.

This example finds the smallest value in an array of height measurements.

``````let heights = [67.5, 65.7, 64.3, 61.1, 58.5, 60.3, 64.9]
let lowestHeight = heights.min()
print(lowestHeight)
// Prints "Optional(58.5)"``````

Returns: The sequence's minimum element. If the sequence has no elements, returns `nil`.

See Also: `min(by:)`

#### Declaration

```@warn_unqualified_access func min() -> Bound?```

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func sorted()

Returns the elements of the sequence, sorted.

You can sort any sequence of elements that conform to the `Comparable` protocol by calling this method. Elements are sorted in ascending order.

The sorting algorithm is not stable. A nonstable sort may change the relative order of elements that compare equal.

Here's an example of sorting a list of students' names. Strings in Swift conform to the `Comparable` protocol, so the names are sorted in ascending order according to the less-than operator (`<`).

``````let students: Set = ["Kofi", "Abena", "Peter", "Kweku", "Akosua"]
let sortedStudents = students.sorted()
print(sortedStudents)
// Prints "["Abena", "Akosua", "Kofi", "Kweku", "Peter"]"``````

To sort the elements of your sequence in descending order, pass the greater-than operator (`>`) to the `sorted(by:)` method.

``````let descendingStudents = students.sorted(by: >)
print(descendingStudents)
// Prints "["Peter", "Kweku", "Kofi", "Akosua", "Abena"]"``````

Returns: A sorted array of the sequence's elements.

See Also: `sorted(by:)`

#### Declaration

`func sorted() -> [Bound]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`

#### Where Iterator.Element : Equatable

func contains(_:)

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

This example checks to see whether a favorite actor is in an array storing a movie's cast.

``````let cast = ["Vivien", "Marlon", "Kim", "Karl"]
print(cast.contains("Marlon"))
// Prints "true"
print(cast.contains("James"))
// Prints "false"``````

`element`: The element to find in the sequence. Returns: `true` if the element was found in the sequence; otherwise, `false`.

#### Declaration

`func contains(_ element: Bound) -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func elementsEqual(_:)

Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.

At least one of the sequences must be finite.

This example tests whether one countable range shares the same elements as another countable range and an array.

``````let a = 1...3
let b = 1...10

print(a.elementsEqual(b))
// Prints "false"
print(a.elementsEqual([1, 2, 3]))
// Prints "true"``````

`other`: A sequence to compare to this sequence. Returns: `true` if this sequence and `other` contain the same elements in the same order.

See Also: `elementsEqual(_:by:)`

#### Declaration

`func elementsEqual<OtherSequence where OtherSequence : Sequence, OtherSequence.Iterator.Element == Iterator.Element>(_ other: OtherSequence) -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func index(of:)

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

After using `index(of:)` to find the position of a particular element in a collection, you can use it to access the element by subscripting. This example shows how you can modify one of the names in an array of students.

``````var students = ["Ben", "Ivy", "Jordell", "Maxime"]
if let i = students.index(of: "Maxime") {
students[i] = "Max"
}
print(students)
// Prints "["Ben", "Ivy", "Jordell", "Max"]"``````

`element`: An element to search for in the collection. Returns: The first index where `element` is found. If `element` is not found in the collection, returns `nil`.

See Also: `index(where:)`

#### Declaration

`func index(of element: Bound) -> ClosedRangeIndex<Bound>?`

#### Declared In

`BidirectionalCollection`, `Collection`
func split(_:maxSplits:omittingEmptySubsequences:)

Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.

The resulting array consists of at most `maxSplits + 1` subsequences. Elements that are used to split the collection are not returned as part of any subsequence.

The following examples show the effects of the `maxSplits` and `omittingEmptySubsequences` parameters when splitting a string at each space character (" "). The first use of `split` returns each word that was originally separated by one or more spaces.

``````let line = "BLANCHE:   I don't want realism. I want magic!"
print(line.characters.split(separator: " ")
.map(String.init))
// Prints "["BLANCHE:", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"``````

The second example passes `1` for the `maxSplits` parameter, so the original string is split just once, into two new strings.

``````print(line.characters.split(separator: " ", maxSplits: 1)
.map(String.init))
// Prints "["BLANCHE:", "  I don\'t want realism. I want magic!"]"``````

The final example passes `false` for the `omittingEmptySubsequences` parameter, so the returned array contains empty strings where spaces were repeated.

``````print(line.characters.split(separator: " ", omittingEmptySubsequences: false)
.map(String.init))
// Prints "["BLANCHE:", "", "", "I", "don\'t", "want", "realism.", "I", "want", "magic!"]"``````

Parameters: separator: The element that should be split upon. maxSplits: The maximum number of times to split the collection, or one less than the number of subsequences to return. If `maxSplits + 1` subsequences are returned, the last one is a suffix of the original collection containing the remaining elements. `maxSplits` must be greater than or equal to zero. The default value is `Int.max`. omittingEmptySubsequences: If `false`, an empty subsequence is returned in the result for each consecutive pair of `separator` elements in the collection and for each instance of `separator` at the start or end of the collection. If `true`, only nonempty subsequences are returned. The default value is `true`. Returns: An array of subsequences, split from this collection's elements.

#### Declaration

`func split(separator: Bound, maxSplits: Int = default, omittingEmptySubsequences: Bool = default) -> [RandomAccessSlice<CountableClosedRange<Bound>>]`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func starts(with:)

Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.

This example tests whether one countable range begins with the elements of another countable range.

``````let a = 1...3
let b = 1...10

print(b.starts(with: a))
// Prints "true"``````

Passing an sequence with no elements or an empty collection as `possiblePrefix` always results in `true`.

``````print(b.starts(with: []))
// Prints "true"``````

`possiblePrefix`: A sequence to compare to this sequence. Returns: `true` if the initial elements of the sequence are the same as the elements of `possiblePrefix`; otherwise, `false`. If `possiblePrefix` has no elements, the return value is `true`.

See Also: `starts(with:by:)`

#### Declaration

`func starts<PossiblePrefix where PossiblePrefix : Sequence, PossiblePrefix.Iterator.Element == Iterator.Element>(with possiblePrefix: PossiblePrefix) -> Bool`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`

#### Where Iterator.Element : Sequence

func joined()

Returns the elements of this sequence of sequences, concatenated.

In this example, an array of three ranges is flattened so that the elements of each range can be iterated in turn.

``````let ranges = [0..<3, 8..<10, 15..<17]

// A for-in loop over 'ranges' accesses each range:
for range in ranges {
print(range)
}
// Prints "0..<3"
// Prints "8..<10"
// Prints "15..<17"

// Use 'joined()' to access each element of each range:
for index in ranges.joined() {
print(index, terminator: " ")
}
// Prints: "0 1 2 8 9 15 16"``````

Returns: A flattened view of the elements of this sequence of sequences.

See Also: `flatMap(_:)`, `joined(separator:)`

#### Declaration

`func joined() -> FlattenSequence<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`
func joined(_:)

Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.

This example shows how an array of `[Int]` instances can be joined, using another `[Int]` instance as the separator:

``````let nestedNumbers = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
let joined = nestedNumbers.joined(separator: [-1, -2])
print(Array(joined))
// Prints "[1, 2, 3, -1, -2, 4, 5, 6, -1, -2, 7, 8, 9]"``````

`separator`: A sequence to insert between each of this sequence's elements. Returns: The joined sequence of elements.

See Also: `joined()`

#### Declaration

`func joined<Separator : Sequence where Separator.Iterator.Element == Iterator.Element.Iterator.Element>(separator: Separator) -> JoinedSequence<CountableClosedRange<Bound>>`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`

#### Where Iterator.Element == String

func joined(_:)

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

The following example shows how an array of strings can be joined to a single, comma-separated string:

``````let cast = ["Vivien", "Marlon", "Kim", "Karl"]
let list = cast.joined(separator: ", ")
print(list)
// Prints "Vivien, Marlon, Kim, Karl"``````

`separator`: A string to insert between each of the elements in this sequence. The default separator is an empty string. Returns: A single, concatenated string.

#### Declaration

`func joined(separator: String = default) -> String`

#### Declared In

`BidirectionalCollection`, `Collection`, `Sequence`