File: _HashLevel.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 (101 lines) | stat: -rw-r--r-- 2,948 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

/// Identifies a particular level within the hash tree.
///
/// Hash trees have a maximum depth of ⎡`UInt.bitWidth / _Bucket.bitWidth`⎤, so
/// the level always fits in an `UInt8` value.
@usableFromInline
@frozen
internal struct _HashLevel {
  /// The bit position within a hash value that begins the hash slice that is
  /// associated with this level. For collision nodes, this can be larger than
  /// `UInt.bitWidth`.
  @usableFromInline
  internal var _shift: UInt8

  @inlinable @inline(__always)
  init(_shift: UInt8) {
    self._shift = _shift
  }

  @inlinable @inline(__always)
  init(shift: UInt) {
    assert(shift <= UInt8.max)
    self._shift = UInt8(truncatingIfNeeded: shift)
  }

  @inlinable @inline(__always)
  init(depth: Int) {
    assert(depth > 0 && depth < _HashLevel.limit)
    self.init(shift: UInt(bitPattern: depth * _Bitmap.bitWidth))
  }
}

extension _HashLevel {
  @inlinable @inline(__always)
  internal static var limit: Int {
    (_Hash.bitWidth + _Bitmap.bitWidth - 1) / _Bitmap.bitWidth
  }

  @inlinable @inline(__always)
  internal static var _step: UInt8 {
    UInt8(truncatingIfNeeded: _Bitmap.bitWidth)
  }

  @inlinable @inline(__always)
  internal static var top: _HashLevel {
    _HashLevel(shift: 0)
  }

  /// The bit position within a hash value that begins the hash slice that is
  /// associated with this level. For collision nodes, this can be larger than
  /// `UInt.bitWidth`.
  @inlinable @inline(__always)
  internal var shift: UInt { UInt(truncatingIfNeeded: _shift) }

  @inlinable @inline(__always)
  internal var isAtRoot: Bool { _shift == 0 }

  @inlinable @inline(__always)
  internal var isAtBottom: Bool { _shift >= UInt.bitWidth }

  @inlinable @inline(__always)
  internal var depth: Int {
    (Int(bitPattern: shift) + _Bitmap.bitWidth - 1) / _Bitmap.bitWidth
  }

  @inlinable @inline(__always)
  internal func descend() -> _HashLevel {
    // FIXME: Consider returning nil when we run out of bits
    _HashLevel(_shift: _shift &+ Self._step)
  }

  @inlinable @inline(__always)
  internal func ascend() -> _HashLevel {
    assert(!isAtRoot)
    return _HashLevel(_shift: _shift &- Self._step)
  }
}

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

extension _HashLevel: Comparable {
  @inlinable @inline(__always)
  internal static func <(left: Self, right: Self) -> Bool {
    left._shift < right._shift
  }
}