File: BitSet.Index.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 (91 lines) | stat: -rw-r--r-- 2,593 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2021 - 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 BitSet {
  /// An opaque type that represents a position in a bit set.
  ///
  /// The elements of a bit set can be addressed simply by their value,
  /// so the `Index` type could be defined to be `Int`, the same as `Element`.
  /// However, `BitSet` uses an opaque wrapper instead, to prevent confusion:
  /// it would otherwise be all too easy to accidentally use `i + 1` instead of
  /// calling `index(after: i)`, and ending up with an invalid index.
  @frozen
  public struct Index {
    @usableFromInline
    var _value: UInt

    @inlinable
    internal init(_value: UInt) {
      self._value = _value
    }

    @inlinable
    internal init(_position: _UnsafeHandle.Index) {
      self._value = _position.value
    }

    @inline(__always)
    internal var _position: _UnsafeHandle.Index {
      _UnsafeHandle.Index(_value)
    }
  }
}

extension BitSet.Index: Sendable {}

extension BitSet.Index: CustomStringConvertible {
  // A textual representation of this instance.
  public var description: String {
    "\(_value)"
  }
}

extension BitSet.Index: CustomDebugStringConvertible {
  // A textual representation of this instance, suitable for debugging.
  public var debugDescription: String {
    description
  }
}

extension BitSet.Index: Equatable {
  /// Returns a Boolean value indicating whether two values are equal.
  ///
  /// - Complexity: O(1)
  @inlinable @inline(__always)
  public static func ==(left: Self, right: Self) -> Bool {
    left._value == right._value
  }
}

extension BitSet.Index: Comparable {
  /// Returns a Boolean value indicating whether the first value is ordered
  /// before the second.
  ///
  /// - Complexity: O(1)
  @inlinable @inline(__always)
  public static func < (left: Self, right: Self) -> Bool {
    left._value < right._value
  }
}

extension BitSet.Index: Hashable {
  /// Hashes the essential components of this value by feeding them to the given hasher.
  ///
  /// - Complexity: O(1)
  @inlinable @inline(__always)
  public func hash(into hasher: inout Hasher) {
    hasher.combine(_value)
  }
}