インスタンスメソッド

index(_:offsetBy:limitedBy:)

与えられたインデックスから指定された距離にあるインデックスを返します。ただし、その距離が与えられた制限インデックスを超えていない限り。

func index(_ i: Self.Index, offsetBy distance: Int, limitedBy limit: Self.Index) -> Self.Index?

i	コレクションの有効なインデックス。
n	オフセット i までの距離。コレクションが BidirectionalCollection プロトコルに準拠していない限り、n は負であってはいけません。
limit	limit として使用すべきコレクションの有効なインデックス。n > 0 の場合、i より小さい制限 (limit) は効果がありません。同様に、n < 0 の場合、i より大きい制限は効果がありません。

インデックス i から n だけオフセットされたインデックス。ただし、そのインデックスが動作の方向において limit を超えていない限り。その場合 (訳注：そのインデックスが limit を超えた場合)、メソッドは nil を返します。

以下の例では、文字列の開始インデックスから 4 つ進んだインデックスを取得してから、その位置にある文字を印刷します。この操作では、制限された s.endIndex 値を超える必要はないため、成功します。

let s = "Swift"
if let i = s.index(s.startIndex, offsetBy: 4, limitedBy: s.endIndex) {
    print(s[i])
}
// Prints "t"

次の例では、s.startIndex から 6 つの位置のインデックスを取得しようとしますが、失敗します。と言うのも、その距離は limit として渡されたインデックスを超えているためです。

let j = s.index(s.startIndex, offsetBy: 6, limitedBy: s.endIndex)
print(j)
// Prints "nil"

n として渡される値は、コレクションの境界を超えて i をオフセットしてはいけません。limit として渡されたインデックスがこれらの境界を超えてオフセットするのを防げない限り。

複雑さ：コレクションが RandomAccessCollection に準拠している場合は O(1)。それ以外の場合は O(n)、ここで n は n の絶対値です。