Instance Method

distance(from:to:)

Returns the distance between two indices.

Declaration

func distance(from start: ClosedRange<Bound>.Index, to end: ClosedRange<Bound>.Index) -> Int
Available when Bound conforms to Strideable and Bound.Stride conforms to SignedInteger.

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.

Return Value

The distance between start and end. The result can be negative only if the collection conforms to the BidirectionalCollection protocol.

Discussion

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

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

See Also

Manipulating Indices

var startIndex: ClosedRange<Bound>.Index

The position of the first element in the range.

var endIndex: ClosedRange<Bound>.Index

The range’s “past the end” position—that is, the position one greater than the last valid subscript argument.

func index(after: ClosedRange<Bound>.Index) -> ClosedRange<Bound>.Index

Returns the position immediately after the given index.

func formIndex(after: inout Index)

Replaces the given index with its successor.

func index(before: ClosedRange<Bound>.Index) -> ClosedRange<Bound>.Index

Returns the position immediately before the given index.

func formIndex(before: inout Index)

Replaces the given index with its predecessor.

func index(ClosedRange<Bound>.Index, offsetBy: Int) -> ClosedRange<Bound>.Index

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

func formIndex(inout Index, offsetBy: Int)

Offsets the given index by the specified distance.

func index(Index, offsetBy: Int, limitedBy: Index) -> Index?

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

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

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

func hash(into: inout Hasher)

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