File: _AncestorHashSlots.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 (111 lines) | stat: -rw-r--r-- 3,839 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// A collection of slot values logically addressing a particular node in a
/// hash tree. The collection is (logically) extended with zero slots up to
/// the maximum depth of the tree -- to unambiguously address a single node,
/// this therefore needs to be augmented with a `_HashLevel` value.
///
/// This construct can only be used to identify a particular node in the tree;
/// it does not necessarily have room to include an item offset in the addressed
/// node. (See `_Path` if you need to address a particular item.)
@usableFromInline
@frozen
struct _AncestorHashSlots {
  @usableFromInline
  internal var path: UInt

  @inlinable @inline(__always)
  internal init(_ path: UInt) {
    self.path = path
  }
}

extension _AncestorHashSlots: Equatable {
  @inlinable @inline(__always)
  internal static func ==(left: Self, right: Self) -> Bool {
    left.path == right.path
  }
}

extension _AncestorHashSlots {
  @inlinable @inline(__always)
  internal static var empty: Self { Self(0) }
}

extension _AncestorHashSlots {
  /// Return or set the slot value at the specified level.
  /// If this is used to mutate the collection, then the original value
  /// on the given level must be zero.
  @inlinable @inline(__always)
  internal subscript(_ level: _HashLevel) -> _HashSlot {
    get {
      assert(level.shift < UInt.bitWidth)
      return _HashSlot((path &>> level.shift) & _Bucket.bitMask)
    }
    set {
      assert(newValue._value < _Bitmap.capacity)
      assert(self[level] == .zero)
      path |= (UInt(truncatingIfNeeded: newValue._value) &<< level.shift)
    }
  }

  @inlinable @inline(__always)
  internal func appending(_ slot: _HashSlot, at level: _HashLevel) -> Self {
    var result = self
    result[level] = slot
    return result
  }

  /// Clear the slot at the specified level, by setting it to zero.
  @inlinable
  internal mutating func clear(_ level: _HashLevel) {
    guard level.shift < UInt.bitWidth else { return }
    path &= ~(_Bucket.bitMask &<< level.shift)
  }

  /// Clear all slots at or below the specified level, by setting them to zero.
  @inlinable
  internal mutating func clear(atOrBelow level: _HashLevel) {
    guard level.shift < UInt.bitWidth else { return }
    path &= ~(UInt.max &<< level.shift)
  }

  /// Truncate this path to the specified level.
  /// Slots at or beyond the specified level are cleared.
  @inlinable
  internal func truncating(to level: _HashLevel) -> _AncestorHashSlots {
    assert(level.shift <= UInt.bitWidth)
    guard level.shift < UInt.bitWidth else { return self }
    return _AncestorHashSlots(path & ((1 &<< level.shift) &- 1))
  }

  /// Returns true if this path contains non-zero slots at or beyond the
  /// specified level, otherwise returns false.
  @inlinable
  internal func hasDataBelow(_ level: _HashLevel) -> Bool {
    guard level.shift < UInt.bitWidth else { return false }
    return (path &>> level.shift) != 0
  }

  /// Compares this path to `other` up to but not including the specified level.
  /// Returns true if the path prefixes compare equal, otherwise returns false.
  @inlinable
  internal func isEqual(to other: Self, upTo level: _HashLevel) -> Bool {
    if level.isAtRoot { return true }
    if level.isAtBottom { return self == other }
    let s = UInt(UInt.bitWidth) - level.shift
    let v1 = self.path &<< s
    let v2 = other.path &<< s
    return v1 == v2
  }
}