File: TreeSet%2BExtras.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (71 lines) | stat: -rw-r--r-- 2,655 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2022 - 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
//
//===----------------------------------------------------------------------===//

#if !COLLECTIONS_SINGLE_MODULE
import InternalCollectionsUtilities
#endif

extension TreeSet: _UniqueCollection {}

extension TreeSet {
  /// Removes the element at the given valid index.
  ///
  /// Calling this method invalidates all existing indices of the collection.
  ///
  /// - Parameter position: The index of the member to remove. `position` must
  ///    be a valid index of the set, and it must not be equal to the set’s
  ///    end index.
  /// - Returns: The element that was removed from the set.
  /// - Complexity: O(log(`count`)) if set storage might be shared; O(1)
  ///    otherwise.
  @discardableResult
  public mutating func remove(at position: Index) -> Element {
    precondition(_isValid(position))
    _invalidateIndices()
    let r = _root.remove(.top, at: position._path)
    precondition(r.remainder == nil)
    return r.removed.key
  }

  /// Replace the member at the given index with a new value that compares equal
  /// to it.
  ///
  /// This is useful when equal elements can be distinguished by identity
  /// comparison or some other means. Updating a member through this method
  /// does not require any hashing operations.
  ///
  /// Calling this method invalidates all existing indices of the collection.
  ///
  /// - Parameter item: The new value that should replace the original element.
  ///     `item` must compare equal to the original value.
  ///
  /// - Parameter index: The index of the element to be replaced.
  ///
  /// - Returns: The original element that was replaced.
  ///
  /// - Complexity: O(log(`count`)) if set storage might be shared; O(1)
  ///    otherwise.
  public mutating func update(_ member: Element, at index: Index) -> Element {
    defer { _fixLifetime(self) }
    precondition(_isValid(index), "Invalid index")
    precondition(index._path.isOnItem, "Can't get element at endIndex")
    _invalidateIndices()
    return _UnsafeHandle.update(index._path.node) {
      let p = $0.itemPtr(at: index._path.currentItemSlot)
      var old = member
      precondition(
        member == p.pointee.key,
        "The replacement item must compare equal to the original")
      swap(&p.pointee.key, &old)
      return old
    }
  }
}