File: _HashSlot.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-- 2,975 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
//
//===----------------------------------------------------------------------===//

/// Identifies a position within a contiguous storage region within a hash tree
/// node. Hash tree nodes have two storage regions, one for items and one for
/// children; the same `_HashSlot` type is used to refer to positions within both.
///
/// We use the term "slot" to refer to internal storage entries, to avoid
/// confusion with terms that sometimes appear in public API, such as
/// "index", "position" or "offset".
@usableFromInline
@frozen
internal struct _HashSlot {
  @usableFromInline
  internal var _value: UInt32

  @inlinable @inline(__always)
  internal init(_ value: UInt32) {
    self._value = value
  }

  @inlinable @inline(__always)
  internal init(_ value: UInt) {
    assert(value <= UInt32.max)
    self._value = UInt32(truncatingIfNeeded: value)
  }

  @inlinable @inline(__always)
  internal init(_ value: Int) {
    assert(value >= 0 && value <= UInt32.max)
    self._value = UInt32(truncatingIfNeeded: value)
  }
}

extension _HashSlot {
  @inlinable @inline(__always)
  internal static var zero: _HashSlot { _HashSlot(0) }
}

extension _HashSlot {
  @inlinable @inline(__always)
  internal var value: Int {
    Int(truncatingIfNeeded: _value)
  }
}

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

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

extension _HashSlot: Hashable {
  @inlinable
  internal func hash(into hasher: inout Hasher) {
    hasher.combine(_value)
  }
}

extension _HashSlot: CustomStringConvertible {
  @usableFromInline
  internal var description: String {
    "\(_value)"
  }
}

extension _HashSlot: Strideable {
  @inlinable @inline(__always)
  internal func advanced(by n: Int) -> _HashSlot {
    assert(n >= 0 || value + n >= 0)
    return _HashSlot(_value &+ UInt32(truncatingIfNeeded: n))
  }

  @inlinable @inline(__always)
  internal func distance(to other: _HashSlot) -> Int {
    if self < other {
      return Int(truncatingIfNeeded: other._value - self._value)
    }
    return -Int(truncatingIfNeeded: self._value - other._value)
  }
}

extension _HashSlot {
  @inlinable @inline(__always)
  internal func next() -> _HashSlot {
    assert(_value < .max)
    return _HashSlot(_value &+ 1)
  }

  @inlinable @inline(__always)
  internal func previous() -> _HashSlot {
    assert(_value > 0)
    return _HashSlot(_value &- 1)
  }
}