Instance Method

distance(from:to:)

Returns the distance between two indices.

Declaration

func distance(from start: Int, to end: Int) -> Int

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.

Relationships

From Protocol

See Also

Manipulating Indices

var startIndex: Int

The position of the first element in a nonempty array.

var endIndex: Int

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

func index(after: Int) -> Int

Returns the position immediately after the given index.

func formIndex(after: inout Int)

Replaces the given index with its successor.

func index(before: Int) -> Int

Returns the position immediately before the given index.

func formIndex(before: inout Int)

Replaces the given index with its predecessor.

func index(Int, offsetBy: Int) -> Int

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

func formIndex(inout Int, offsetBy: Int)

Offsets the given index by the specified distance.

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

var indices: Range<Int>

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