structFlattenCollectionIndex<BaseElements:CollectionTypewhereBaseElements.Generator.Element:CollectionType>
| Inheritance |
Equatable, ForwardIndexType, _Incrementable
View Protocol Hierarchy →
|
|---|---|
| Import |
|
Instance Methods
Returns the result of advancing self by n positions.
Returns:
- If n > 0, the result of applying successor to self n times.
- If n < 0, the result of applying predecessor to self -n times.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:FlattenCollectionIndex<BaseElements>.Distance) ->FlattenCollectionIndex<BaseElements>
Declared In
ForwardIndexType
Returns the result of advancing self by n positions, or until it
equals limit.
Returns:
- If n > 0, the result of applying successor to self n times
but not past limit.
- If n < 0, the result of applying predecessor to self -n times
but not past limit.
- Otherwise, self.
Requires: n >= 0 if only conforming to ForwardIndexType.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(abs(n)) otherwise
Declaration
funcadvancedBy(n:FlattenCollectionIndex<BaseElements>.Distance,limit:FlattenCollectionIndex<BaseElements>) ->FlattenCollectionIndex<BaseElements>
Declared In
ForwardIndexType
Measure the distance between self and end.
Requires:
- start and end are part of the same sequence when conforming to
RandomAccessSequenceType.
- end is reachable from self by incrementation otherwise.
Complexity:
- O(1) if conforming to RandomAccessIndexType
- O(n) otherwise, where n is the function's result.
Declaration
funcdistanceTo(end:FlattenCollectionIndex<BaseElements>) ->FlattenCollectionIndex<BaseElements>.Distance
Declared In
ForwardIndexType
Returns the next consecutive value after self.
Requires: The next value is representable.
Declaration
funcsuccessor() ->FlattenCollectionIndex<BaseElements>
3 inherited items hidden. (Show all)
A position in a
FlattenCollection.