1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2021 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//
// `OrderedSet` does not directly conform to `SetAlgebra` because its definition
// of equality conflicts with `SetAlgebra` requirements. However, it still
// implements most `SetAlgebra` requirements (except `insert`, which is replaced
// by `append`).
//
// `OrderedSet` also provides an `unordered` view that explicitly conforms to
// `SetAlgebra`. That view implements `Equatable` by ignoring element order,
// so it can satisfy `SetAlgebra` requirements.
extension OrderedSet {
/// Returns a new set with the elements of both this and the given set.
///
/// Members of `other` that aren't already in `self` get appended to the end
/// of the result, in the order they appear in `other`.
///
/// let a: OrderedSet = [1, 2, 3, 4]
/// let b: OrderedSet = [0, 2, 4, 6]
/// a.union(b) // [1, 2, 3, 4, 0, 6]
///
/// - Parameter other: The set of elements to add.
///
/// - Complexity: Expected to be O(`self.count` + `other.count`) on average,
/// if `Element` implements high-quality hashing.
@inlinable
public __consuming func union(_ other: __owned Self) -> Self {
var result = self
result.formUnion(other)
return result
}
// Generalizations
/// Returns a new set with the elements of both this and the given set.
///
/// Members of `other` that aren't already in `self` get appended to the end
/// of the result, in the order they appear in `other`.
///
/// let a: OrderedSet = [1, 2, 3, 4]
/// let b: OrderedSet = [0, 2, 4, 6]
/// a.union(b.unordered) // [1, 2, 3, 4, 0, 6]
///
/// - Parameter other: The set of elements to add.
///
/// - Complexity: Expected to be O(`self.count` + `other.count`) on average,
/// if `Element` implements high-quality hashing.
@inlinable
@inline(__always)
public __consuming func union(_ other: __owned UnorderedView) -> Self {
union(other._base)
}
/// Returns a new set with the elements of both this and the given set.
///
/// Members of `other` that aren't already in `self` get appended to the end
/// of the result, in the order they appear in `other`.
///
/// let a: OrderedSet = [1, 2, 3, 4]
/// let b: Array = [0, 2, 4, 6]
/// a.union(b) // [1, 2, 3, 4, 0, 6]
///
/// - Parameter other: A finite sequence of elements.
///
/// - Complexity: Expected to be O(`self.count` + `other.count`) on average,
/// if `Element` implements high-quality hashing.
@inlinable
public __consuming func union(
_ other: __owned some Sequence<Element>
) -> Self {
var result = self
result.formUnion(other)
return result
}
}
|