インスタンスメソッド

index(_:offsetBy:limitedBy:)

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

func index(_ i: Int, offsetBy n: Int, limitedBy limit: Int) -> Int?

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

インデックス i からの distance によるインデックスのオフセット。ただしそのインデックスが動きの方向で 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"

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

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

注意

この文書のコメントは、Collection から継承されました。

RandomAccessCollection

トップへ

トップへ

トップへ

トップへ

トップへ