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

formIndex(_:offsetBy:limitedBy:)

Offsets the given index by the specified distance, or so that it equals the given limiting index. 与えられたインデックスをこの指定された隔たりで補います、またはそれでそれは与えられた限界インデックスと等しくなります。

Declaration 宣言 

func formIndex(_ i: inout Index, offsetBy distance: Int, limitedBy limit: Index) -> Bool

Parameters パラメータ

i

A valid index of the collection. そのコレクションの有効なインデックス。

distance

The distance to offset i. distance must not be negative unless the collection conforms to the BidirectionalCollection protocol. iを補う間隔。distanceは、そのコレクションがBidirectionalCollectionプロトコルに準拠するのでない限り、負であってはなりません。

limit

A valid index of the collection to use as a limit. If distance > 0, a limit that is less than i has no effect. Likewise, if distance < 0, a limit that is greater than i has no effect. 限度として使うためのそのコレクションの有効なインデックス。distance > 0ならば、iより少ない限度は効果を持ちません。同様に、distance < 0ならば、iより大きい限度は効果を持ちません。

Return Value 戻り値

true if i has been offset by exactly distance steps without going beyond limit; otherwise, false. When the return value is false, the value of i is equal to limit. true、もしiが正確にdistance幅だけlimitを越えていくことなく補われたならば；そうでなければ、falseです。戻り値がfalseの場合、iの値はlimitに等しいです。

Discussion 解説

The value passed as distance must not offset i beyond the bounds of the collection, unless the index passed as limit prevents offsetting beyond those bounds. distanceとして渡される値は、このコレクションの境界を越えてiを補ってはなりません、limitとして渡されるインデックスがそれら境界を越えて補うのを防止するのでない限りは。

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(k), where k is the absolute value of distance. 計算量：もしコレクションがRandomAccessCollectionに準拠するならば、O(1)；そうでなければ、O(k)、そこでkはdistanceの値の絶対値です。

See Also 参照

Manipulating Indices インデックスを操る

var startIndex: String.Index
The position of the first character in a nonempty string. 空でない文字列の中の最初の文字の位置。
var endIndex: String.Index
A string’s “past the end” position—that is, the position one greater than the last valid subscript argument. 文字列の「終わりを過ぎた」位置—すなわち、最後の有効な添え字引数より１つ大きい位置。
func index(after: String.Index) -> String.Index
Returns the position immediately after the given index. 与えられたインデックスの直後の位置を返します。
func formIndex(after: inout Index)
Replaces the given index with its successor. 与えられたインデックスをそれの後に続くものと取り替えます。
func index(before: String.Index) -> String.Index
Returns the position immediately before the given index. 与えられたインデックスの直前の位置を返します。
func formIndex(before: inout Index)
Replaces the given index with its predecessor. 与えられたインデックスをそれの前のものと取り替えます。
func index(String.Index, offsetBy: String.IndexDistance) -> String.Index
Returns an index that is the specified distance from the given index. 与えられたインデックスから指定された隔たりのインデックスを返します。
func index(String.Index, offsetBy: String.IndexDistance, limitedBy: String.Index) -> String.Index?
Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index. 与えられたインデックスから指定された隔たりのインデックスを返します、その隔たりが与えられた限界インデックスを越えない限りは。
func formIndex(inout Index, offsetBy: Int)
Offsets the given index by the specified distance. 与えられたインデックスを指定された間隔で補います。
func distance(from: String.Index, to: String.Index) -> String.IndexDistance
Returns the distance between two indices. ２つのインデックス間の隔たりを返します。
var indices: DefaultIndices<String>
The indices that are valid for subscripting the collection, in ascending order. コレクションの添え字に使うのに有効である、昇順でのインデックス。