Instance Method (Default implementation)swift 6.0.1Swift
index(_:offsetBy:)
Returns an index that is the specified distance from the given index.
func index(_ i: Self.Index, offsetBy distance: Self.Index.Stride) -> Self.Index
Parameters
Returns
An index offset by distance
from the index i
. If distance
is positive, this is the same value as the result of distance
calls to index(after:)
. If distance
is negative, this is the same value as the result of abs(distance)
calls to index(before:)
.
The following example obtains an index advanced four positions from an array’s starting index and then prints the element at that position.
let numbers = [10, 20, 30, 40, 50]
let i = numbers.index(numbers.startIndex, offsetBy: 4)
print(numbers[i])
// Prints "50"
The value passed as distance
must not offset i
beyond the bounds of the collection.
Implements
func index(Self.Index, offsetBy: Int
) -> Self.Index Returns an index that is the specified distance from the given index.
func index(Self.Index, offsetBy: Int
) -> Self.Index Returns an index that is the specified distance from the given index.
func index(Self.Index, offsetBy: Int
) -> Self.Index Returns an index that is the specified distance from the given index.
Other members in extension
Instance members
var indices: Range<Self.Index>
The indices that are valid for subscripting the collection, in ascending order.
func distance(from: Self.Index, to: Self.Index
) -> Self.Index.Stride Returns the distance between two indices.
func index(after: Self.Index
) -> Self.Index Returns the position immediately after the given index.
func index(before: Self.Index
) -> Self.Index Returns the position immediately after the given index.