| Inheritance |
CollectionType, Indexable, SequenceType
View Protocol Hierarchy →
|
|---|---|
| Associated Types |
Type alias inferred.
Type alias inferred.
Type alias inferred.
Type alias inferred. |
| Import |
|
Initializers
Create a view into collection base that allows access within bounds.
Complexity: O(1).
Deprecated: it will be removed in Swift 3. Use the slicing syntax..
Declaration
init(base:Base,bounds:Range<Base.Index>)
Instance Variables
Returns the number of elements.
Complexity: O(1) if Index conforms to RandomAccessIndexType;
O(N) otherwise.
Declaration
varcount:Base.Index.Distance{get}
Declared In
CollectionType
Declaration
varendIndex:Base.Index{get}
Returns the first element of self, or nil if self is empty.
Complexity: O(1)
Declaration
varfirst:Base._Element? {get}
Declared In
CollectionType
Returns the range of valid index values.
The result's endIndex is the same as that of self. Because
Range is half-open, iterating the values of the result produces
all valid subscript arguments for self, omitting its endIndex.
Declaration
varindices:Range<Base.Index>{get}
Declared In
CollectionType
Returns true iff self is empty.
Complexity: O(1)
Declaration
varisEmpty:Bool{get}
Declared In
CollectionType
A collection with contents identical to self, but on which
normally-eager operations such as map and filter are
implemented lazily.
See Also: LazySequenceType, LazyCollectionType.
Declaration
varlazy:LazyCollection<Slice<Base>>{get}
Declared In
CollectionType
Declaration
varstartIndex:Base.Index{get}
5 inherited items hidden. (Show all)
Subscripts
Declaration
subscript(index:Base.Index) ->Base._Element{get}
Instance Methods
Returns true iff an element in self satisfies predicate.
Declaration
Declared In
CollectionType, SequenceType
Returns a subsequence containing all but the first element.
Complexity: O(1)
Declaration
funcdropFirst() ->Slice<Base>
Declared In
CollectionType, SequenceType
Returns a subsequence containing all but the first n elements.
Requires: n >= 0
Complexity: O(n)
Declaration
Declared In
CollectionType, SequenceType
Returns a subsequence containing all but the last element.
Requires: self is a finite sequence.
Complexity: O(self.count)
Declaration
funcdropLast() ->Slice<Base>
Declared In
CollectionType, SequenceType
Returns a subsequence containing all but the last n elements.
Requires: n >= 0
Complexity: O(self.count)
Declaration
Declared In
CollectionType, SequenceType
Returns true iff self and other contain equivalent elements, using
isEquivalent as the equivalence test.
Requires: isEquivalent is an
equivalence relation.
Declaration
funcelementsEqual<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence, @noescapeisEquivalent: (Base._Element,Base._Element)throws->Bool)rethrows->Bool
Declared In
CollectionType, SequenceType
Returns a lazy SequenceType containing pairs (n, x), where
ns are consecutive Ints starting at zero, and xs are
the elements of base:
for (n, c) in "Swift".characters.enumerate() {("\(n): '\(c)'")}0: 'S'1: 'w'2: 'i'3: 'f'4: 't'
Declaration
funcenumerate() ->EnumerateSequence<Slice<Base>>
Declared In
CollectionType, SequenceType
Returns an Array containing the elements of self,
in order, that satisfy the predicate includeElement.
Declaration
funcfilter(@noescapeincludeElement: (Base._Element)throws->Bool)rethrows->[Base._Element]
Declared In
CollectionType, SequenceType
Returns an Array containing the non-nil results of mapping
transform over self.
Complexity: O(M + N), where M is the length of self
and N is the length of the result.
Declaration
funcflatMap<T>(@noescapetransform: (Base._Element)throws->T?)rethrows->[T]
Declared In
CollectionType, SequenceType
Returns an Array containing the concatenated results of mapping
transform over self.
s.flatMap(transform)
is equivalent to
Array(s.map(transform).flatten())
Complexity: O(M + N), where M is the length of self
and N is the length of the result.
Declaration
funcflatMap<S:SequenceType>(transform: (Base._Element)throws->S)rethrows->[S.Generator.Element]
Declared In
CollectionType, SequenceType
Call body on each element in self in the same order as a
for-in loop.
sequence.forEach{// body code}
is similar to:
forelementinsequence{// body code}
Note: You cannot use the break or continue statement to exit the
current call of the body closure or skip subsequent calls.
Note: Using the return statement in the body closure will only
exit from the current call to body, not any outer scope, and won't
skip subsequent calls.
Complexity: O(self.count)
Declaration
funcforEach(@noescapebody: (Base._Element)throws->Void)rethrows
Declared In
CollectionType, SequenceType
Returns the first index where predicate returns true for the
corresponding value, or nil if such value is not found.
Complexity: O(self.count).
Declaration
funcindexOf(@noescapepredicate: (Base._Element)throws->Bool)rethrows->Base.Index?
Declared In
CollectionType
Returns true iff self precedes other in a lexicographical
("dictionary") ordering, using isOrderedBefore as the comparison
between elements.
Note: This method implements the mathematical notion of lexicographical
ordering, which has no connection to Unicode. If you are sorting strings
to present to the end-user, you should use String APIs that perform
localized comparison.
Requires: isOrderedBefore is a
strict weak ordering
over the elements of self and other.
Declaration
funclexicographicalCompare<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence, @noescapeisOrderedBefore: (Base._Element,Base._Element)throws->Bool)rethrows->Bool
Declared In
CollectionType, SequenceType
Returns an Array containing the results of mapping transform
over self.
Complexity: O(N).
Declaration
funcmap<T>(@noescapetransform: (Base._Element)throws->T)rethrows->[T]
Declared In
CollectionType, SequenceType
Returns the maximum element in self or nil if the sequence is empty.
Complexity: O(elements.count).
Requires: isOrderedBefore is a
strict weak ordering
over self.
Declaration
funcmaxElement(@noescapeisOrderedBefore: (Base._Element,Base._Element)throws->Bool)rethrows->Base._Element?
Declared In
CollectionType, SequenceType
Returns the minimum element in self or nil if the sequence is empty.
Complexity: O(elements.count).
Requires: isOrderedBefore is a
strict weak ordering
over self.
Declaration
funcminElement(@noescapeisOrderedBefore: (Base._Element,Base._Element)throws->Bool)rethrows->Base._Element?
Declared In
CollectionType, SequenceType
If !self.isEmpty, remove the first element and return it, otherwise
return nil.
Complexity: O(1)
Declaration
mutatingfuncpopFirst() ->Base._Element?
Declared In
CollectionType
If !self.isEmpty, remove the last element and return it, otherwise
return nil.
Complexity: O(self.count)
Deprecated: it will be removed in Swift 3.
Declaration
mutatingfuncpopLast() ->Base._Element?
Declared In
CollectionType
Returns a subsequence, up to maxLength in length, containing the
initial elements.
If maxLength exceeds self.count, the result contains all
the elements of self.
Requires: maxLength >= 0
Complexity: O(maxLength)
Declaration
Declared In
CollectionType, SequenceType
Returns prefixUpTo(position.successor())
Complexity: O(1)
Declaration
funcprefixThrough(position:Base.Index) ->Slice<Base>
Declared In
CollectionType
Returns self[startIndex..<end]
Complexity: O(1)
Declaration
funcprefixUpTo(end:Base.Index) ->Slice<Base>
Declared In
CollectionType
Returns the result of repeatedly calling combine with an
accumulated value initialized to initial and each element of
self, in turn, i.e. return
combine(combine(...combine(combine(initial, self[0]),
self[1]),...self[count-2]), self[count-1]).
Declaration
funcreduce<T>(initial:T, @noescapecombine: (T,Base._Element)throws->T)rethrows->T
Declared In
CollectionType, SequenceType
Remove the element at startIndex and return it.
Complexity: O(1)
Requires: !self.isEmpty.
Declaration
mutatingfuncremoveFirst() ->Base._Element
Declared In
CollectionType
Remove the first n elements.
Complexity:
- O(1) if Index conforms to RandomAccessIndexType
- O(n) otherwise
Requires: n >= 0 && self.count >= n.
Declaration
mutatingfuncremoveFirst(n:Int)
Declared In
CollectionType
Returns an Array containing the elements of self in reverse
order.
Complexity: O(N), where N is the length of self.
Declaration
funcreverse() ->[Base._Element]
Declared In
CollectionType, SequenceType
Returns an Array containing the sorted elements of source
according to isOrderedBefore.
The sorting algorithm is not stable (can change the relative order of
elements for which isOrderedBefore does not establish an order).
Requires: isOrderedBefore is a
strict weak ordering
over the elements in self.
Declaration
funcsort(@noescapeisOrderedBefore: (Base._Element,Base._Element) ->Bool) ->[Base._Element]
Declared In
CollectionType, SequenceType
Returns the maximal SubSequences of self, in order, that
don't contain elements satisfying the predicate isSeparator.
maxSplit: The maximum number of SubSequences to
return, minus 1.
If maxSplit + 1 SubSequences are returned, the last one is
a suffix of self containing the remaining elements.
The default value is Int.max.
allowEmptySubsequences: If true, an empty SubSequence
is produced in the result for each pair of consecutive elements
satisfying isSeparator.
The default value is false.
Requires: maxSplit >= 0
Declaration
Declared In
CollectionType, SequenceType
Returns true iff self begins with elements equivalent to those of
other, using isEquivalent as the equivalence test. Returns true if
other is empty.
Requires: isEquivalent is an
equivalence relation.
Declaration
funcstartsWith<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence, @noescapeisEquivalent: (Base._Element,Base._Element)throws->Bool)rethrows->Bool
Declared In
CollectionType, SequenceType
Returns a slice, up to maxLength in length, containing the
final elements of s.
If maxLength exceeds s.count, the result contains all
the elements of s.
Requires: maxLength >= 0
Complexity: O(self.count)
Declaration
Declared In
CollectionType, SequenceType
Returns self[start..<endIndex]
Complexity: O(1)
Declaration
funcsuffixFrom(start:Base.Index) ->Slice<Base>
Declared In
CollectionType
Returns a value less than or equal to the number of elements in
self, nondestructively.
Complexity: O(N).
Declaration
funcunderestimateCount() ->Int
Declared In
CollectionType, SequenceType
32 inherited items hidden. (Show all)
Conditionally Inherited Items
The initializers, methods, and properties listed below may be available on this type under certain conditions (such as methods that are available on Array when its elements are Equatable) or may not ever be available if that determination is beyond SwiftDoc.org's capabilities. Please open an issue on GitHub if you see something out of place!
Where Generator.Element : CollectionType
A concatenation of the elements of self.
Declaration
funcflatten() ->FlattenCollection<Slice<Base>>
Declared In
CollectionType
1 inherited item hidden. (Show all)
Where Generator.Element : CollectionType, Index : BidirectionalIndexType, Generator.Element.Index : BidirectionalIndexType
A concatenation of the elements of self.
Declaration
funcflatten() ->FlattenBidirectionalCollection<Slice<Base>>
Declared In
CollectionType
1 inherited item hidden. (Show all)
Where Generator.Element : Comparable
Returns true iff self precedes other in a lexicographical
("dictionary") ordering, using "<" as the comparison between elements.
Note: This method implements the mathematical notion of lexicographical
ordering, which has no connection to Unicode. If you are sorting strings
to present to the end-user, you should use String APIs that perform
localized comparison.
Declaration
funclexicographicalCompare<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence) ->Bool
Declared In
CollectionType, SequenceType
Returns the maximum element in self or nil if the sequence is empty.
Complexity: O(elements.count).
Declaration
funcmaxElement() ->Base._Element?
Declared In
CollectionType, SequenceType
Returns the minimum element in self or nil if the sequence is empty.
Complexity: O(elements.count).
Declaration
funcminElement() ->Base._Element?
Declared In
CollectionType, SequenceType
Returns an Array containing the sorted elements of source.
The sorting algorithm is not stable (can change the relative order of elements that compare equal).
Requires: The less-than operator (func <) defined in
the Comparable conformance is a
strict weak ordering
over the elements in self.
Declaration
funcsort() ->[Base._Element]
Declared In
CollectionType, SequenceType
4 inherited items hidden. (Show all)
Where Generator.Element : Equatable
Returns true iff element is in self.
Declaration
funccontains(element:Base._Element) ->Bool
Declared In
CollectionType, SequenceType
Returns true iff self and other contain the same elements in the
same order.
Declaration
funcelementsEqual<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence) ->Bool
Declared In
CollectionType, SequenceType
Returns the first index where value appears in self or nil if
value is not found.
Complexity: O(self.count).
Declaration
funcindexOf(element:Base._Element) ->Base.Index?
Declared In
CollectionType
Returns the maximal SubSequences of self, in order, around a
separator element.
maxSplit: The maximum number of SubSequences to
return, minus 1.
If maxSplit + 1 SubSequences are returned, the last one is
a suffix of self containing the remaining elements.
The default value is Int.max.
allowEmptySubsequences: If true, an empty SubSequence
is produced in the result for each pair of consecutive elements
satisfying isSeparator.
The default value is false.
Requires: maxSplit >= 0
Declaration
Declared In
CollectionType, SequenceType
Returns true iff the initial elements of self are equal to prefix.
Returns true if other is empty.
Declaration
funcstartsWith<OtherSequence:SequenceTypewhereOtherSequence.Generator.Element==Generator.Element>(other:OtherSequence) ->Bool
Declared In
CollectionType, SequenceType
5 inherited items hidden. (Show all)
Where Generator.Element : SequenceType
A concatenation of the elements of self.
Declaration
funcflatten() ->FlattenSequence<Slice<Base>>
Declared In
CollectionType, SequenceType
Returns a view, whose elements are the result of interposing a given
separator between the elements of the sequence self.
For example,
[[1, 2, 3], [4, 5, 6], [7, 8, 9]].joinWithSeparator([-1, -2])
yields [1, 2, 3, -1, -2, 4, 5, 6, -1, -2, 7, 8, 9].
Declaration
funcjoinWithSeparator<Separator:SequenceTypewhereSeparator.Generator.Element==Generator.Element.Generator.Element>(separator:Separator) ->JoinSequence<Slice<Base>>
Declared In
CollectionType, SequenceType
2 inherited items hidden. (Show all)
Where Generator.Element == String
Interpose the separator between elements of self, then concatenate
the result. For example:
["foo","bar","baz"].joinWithSeparator("-|-")// "foo-|-bar-|-baz"
Declaration
Declared In
CollectionType, SequenceType
1 inherited item hidden. (Show all)
Where Index : BidirectionalIndexType
Returns a subsequence containing all but the last n elements.
Requires: n >= 0
Complexity: O(n)
Declaration
Declared In
CollectionType
Returns the elements of self in reverse order.
Complexity: O(1)
Declaration
funcreverse() ->ReverseCollection<Slice<Base>>
Declared In
CollectionType
Returns a slice, up to maxLength in length, containing the
final elements of s.
If maxLength exceeds s.count, the result contains all
the elements of s.
Requires: maxLength >= 0
Complexity: O(maxLength)
Declaration
Declared In
CollectionType
4 inherited items hidden. (Show all)
Where Index : RandomAccessIndexType
Returns the elements of self in reverse order.
Complexity: O(1)
Declaration
funcreverse() ->ReverseRandomAccessCollection<Slice<Base>>
Declared In
CollectionType
1 inherited item hidden. (Show all)
Where SubSequence == Self, Index : BidirectionalIndexType
If !self.isEmpty, remove the last element and return it, otherwise
return nil.
Complexity: O(1)
Declaration
mutatingfuncpopLast() ->Base._Element?
Declared In
CollectionType
Remove an element from the end.
Complexity: O(1)
Requires: !self.isEmpty
Declaration
mutatingfuncremoveLast() ->Base._Element
Declared In
CollectionType
Remove the last n elements.
Complexity:
- O(1) if Index conforms to RandomAccessIndexType
- O(n) otherwise
Requires: n >= 0 && self.count >= n.
Declaration
mutatingfuncremoveLast(n:Int)
Declared In
CollectionType
3 inherited items hidden. (Show all)
A view into a sub-sequence of elements of another collection.
A
Sliceinstance stores the base collection, the start and end indices of the view. It does not copy the elements from the collection into separate storage. Thus, creating a slice hasO(1)complexity.A
Sliceinstance inherits the value or reference semantics of the base collection. That is, if aSliceinstance is wrapped around a mutable collection that has value semantics (for example,Array), mutating the original collection would not affect the copy stored inside of the slice.An element of a slice is located under the same index in the slice and in the base collection, as long as neither the collection or the slice were mutated. Thus, indices of a slice can be used interchangeably with indices of the base collection.
Warning: Long-term storage of
Sliceinstances is discouraged.Because a
Slicepresents a view onto the storage of some larger collection even after the original collection goes out of scope, storing the slice may prolong the lifetime of elements that are no longer accessible, which can manifest as apparent memory and object leakage. To prevent this effect, use slices only for transient computation.