Instance Method インスタンスメソッド

index(_:offsetBy:)

Returns an index that is the specified distance from the given index. 与えられたインデックスから指定された隔たりのインデックスを返します。

Declaration 宣言 

func index(_ i: Int, offsetBy distance: Int) -> Int

Parameters パラメータ

i

A valid index of the array. この配列の有効なインデックス。

distance

The distance to offset i. iを補う間隔。

Return Value 戻り値

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:). distanceだけインデックスiから補われるインデックス。distanceが正ならば、これはdistanceでindex(after:)を呼び出す結果と同じ値です。distanceが負ならば、これはabs(distance)でindex(before:)を呼び出す結果と同じ値です。

Discussion 解説

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. distanceとして渡される値は、このコレクションの境界を越えてiを補ってはなりません。

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 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. 与えられたインデックスをこの指定された隔たりで補います、またはそれでそれは与えられた限界インデックスと等しくなります。
func distance(from: Int, to: Int) -> Int
Returns the distance between two indices. ２つのインデックス間の隔たりを返します。