Files
Karoy Lorentey 80878519f2 [doc] Fix most issues reported by docc
DocC keeps changing its link syntax. The latest iteration appears to have trouble dealing with `Self`-taking or `Self`-returning methods, so change our API to replace `Self` with a direct mention of the concrete type. ¯\\\_(ツ)\_/¯

That said, the new compiler also found a large number of mismatching parameter names, and that was really helpful.
2026-03-09 14:14:51 -07:00

83 lines
2.8 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2022 - 2026 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
//
// SPDX-License-Identifier: Apache-2.0 WITH Swift-exception
//
//===----------------------------------------------------------------------===//
#if !COLLECTIONS_SINGLE_MODULE
import InternalCollectionsUtilities
#endif
extension TreeSet {
/// Returns a Boolean value that indicates whether the set has no members in
/// common with the given set.
///
/// let a: TreeSet = [1, 2, 3, 4]
/// let b: TreeSet = [5, 6]
/// a.isDisjoint(with: b) // true
///
/// - Parameter other: Another set.
///
/// - Returns: `true` if `self` has no elements in common with `other`;
/// otherwise, `false`.
///
/// - Complexity: Expected to be O(min(`self.count`, `other.count`)) on
/// average, if `Element` implements high-quality hashing.
@inlinable
public func isDisjoint(with other: TreeSet) -> Bool {
self._root.isDisjoint(.top, with: other._root)
}
/// Returns a Boolean value that indicates whether the set has no members in
/// common with the given set.
///
/// let a: TreeSet = [1, 2, 3, 4]
/// let b: TreeSet = [5, 6]
/// a.isDisjoint(with: b) // true
///
/// - Parameter other: The keys view of a persistent dictionary.
///
/// - Returns: `true` if `self` has no elements in common with `other`;
/// otherwise, `false`.
///
/// - Complexity: Expected to be O(min(`self.count`, `other.count`)) on
/// average, if `Element` implements high-quality hashing.
@inlinable
public func isDisjoint<Value>(
with other: TreeDictionary<Element, Value>.Keys
) -> Bool {
self._root.isDisjoint(.top, with: other._base._root)
}
/// Returns a Boolean value that indicates whether the set has no members in
/// common with the given set.
///
/// let a: TreeSet = [1, 2, 3, 4]
/// let b: TreeSet = [5, 6]
/// a.isDisjoint(with: b) // true
///
/// - Parameter other: A finite sequence of elements, some of which may
/// appear more than once.
///
/// - Returns: `true` if `self` has no elements in common with `other`;
/// otherwise, `false`.
///
/// - Complexity: In the worst case, this makes O(*n*) calls to
/// `self.contains`, where *n* is the length of the sequence.
@inlinable
public func isDisjoint(with other: some Sequence<Element>) -> Bool {
guard !self.isEmpty else { return true }
if let other = _specialize(other, for: Self.self) {
return isDisjoint(with: other)
}
return other.allSatisfy { !self.contains($0) }
}
}