A collection of insertions and removals that describe the difference between two ordered collection states.
SDK
- Xcode 11.0+
Framework
- Swift Standard Library
Declaration
struct CollectionDifference<ChangeElement>
Generic StructureCollection
Collection
Topics
Type Aliases
typealias CollectionA type representing the sequence’s elements.
typealias CollectionA type that represents the indices that are valid for subscripting the collection, in ascending order.
typealias CollectionA type that provides the collection’s iteration interface and encapsulates its iteration state.
typealias CollectionA sequence that represents a contiguous subrange of the collection’s elements.
Initializers
init?<Changes>(Changes)Creates a new collection difference from a collection of changes.
init(from: Decoder)Creates a new instance by decoding from the given decoder.
Instance Properties
var count: IntThe number of elements in the collection.
var endThe collection’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var first: CollectionThe first element of the collection.
var hashThe hash value.
var indices: DefaultThe indices that are valid for subscripting the collection, in ascending order.
let insertions: [CollectionThe insertions contained by this difference, from lowest offset to highest.
var isA Boolean value indicating whether the collection is empty.
var lazy: LazyA sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
let removals: [CollectionThe removals contained by this difference, from lowest offset to highest.
var startThe position of the first element in a nonempty collection.
var underestimatedA value less than or equal to the number of elements in the collection.
Instance Methods
func allReturns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactReturns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func contains(CollectionReturns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (CollectionReturns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func distance(from: CollectionReturns the distance between two indices.
func drop(while: (CollectionReturns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropReturns a subsequence containing all but the given number of initial elements.
func dropReturns a subsequence containing all but the specified number of final elements.
func elementsReturns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsReturns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.
func encode(to: Encoder)Encodes this value into the given encoder.
func enumerated() -> EnumeratedReturns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.
func filter((CollectionReturns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (CollectionReturns the first element of the sequence that satisfies the given predicate.
func firstReturns the first index where the specified value appears in the collection.
func firstReturns the first index in which an element of the collection satisfies the given predicate.
func flatReturns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forCalls the given closure on each element in the sequence in the same order as a for-in loop.
func formOffsets the given index by the specified distance, or so that it equals the given limiting index.
func formReplaces the given index with its successor.
func hash(into: inout Hasher)Hashes the essential components of this value by feeding them into the given hasher.
func index(CollectionReturns an index that is the specified distance from the given index.
func index(CollectionReturns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func index(after: CollectionReturns the position immediately after the given index.
func index(of: CollectionReturns the first index where the specified value appears in the collection.
func index(where: (CollectionReturns the first index in which an element of the collection satisfies the given predicate.
func inferringReturns a new collection difference with associations between individual elements that have been removed and inserted only once.
func lexicographicallyReturns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func makeReturns an iterator over the elements of the collection.
func map<T>((CollectionReturns an array containing the results of mapping the given closure over the sequence’s elements.
func max(by: (CollectionReturns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min(by: (CollectionReturns the minimum element in the sequence, using the given predicate as the comparison between elements.
func prefix(Int) -> Slice<CollectionReturns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: CollectionReturns a subsequence from the start of the collection through the specified position.
func prefix(upReturns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (CollectionReturns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomReturns a random element of the collection.
func randomReturns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, CollectionReturns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, CollectionReturns the result of combining the elements of the sequence using the given closure.
func reversed() -> [CollectionReturns an array containing the elements of this sequence in reverse order.
func shuffled() -> [CollectionReturns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [CollectionReturns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted(by: (CollectionReturns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxReturns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: CollectionReturns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
func split(separator: CollectionReturns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func starts<PossibleReturns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
func starts<PossibleReturns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.
func suffix(Int) -> Slice<CollectionReturns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: CollectionReturns a subsequence from the specified position to the end of the collection.
func withCall body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.
Subscripts
subscript<R>(R) -> Slice<CollectionAccesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(Range<CollectionAccesses a contiguous subrange of the collection’s elements.
subscript(CollectionAccesses the element at the specified position.
Operator Functions
static func == (CollectionReturns a Boolean value indicating whether two values are equal.
Structures
struct CollectionThe position of a collection difference.
Enumerations
enum CollectionA single change to a collection.