Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
- iOS 7.0+
- macOS 10.9+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
- Xcode 9.3+
A valid index of the collection.
The distance to offset
nmust not be negative unless the collection conforms to the
A valid index of the collection to use as a limit. If
n > 0, a limit that is less than
ihas no effect. Likewise, if
n < 0, a limit that is greater than
ihas no effect.
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
The following example obtains an index advanced four positions from a string’s starting index and then prints the character at that position. The operation doesn’t require going beyond the limiting
s value, so it succeeds.
The next example attempts to retrieve an index six positions from
s but fails, because that distance is beyond the index passed as
The value passed as
n must not offset
i beyond the bounds of the collection, unless the index passed as
limit prevents offsetting beyond those bounds.
Complexity: O(1) if the collection conforms to
Random; otherwise, O(n), where n is the absolute value of