File: BitArray%2BShifts.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 (162 lines) | stat: -rw-r--r-- 5,425 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

extension BitArray {
  /// Shift the bits in this array by the specified number of places to the
  /// left (towards the end of the array), by inserting `amount` false values
  /// at the beginning.
  ///
  /// If `amount` is negative, this is equivalent to shifting `-amount`
  /// places to the right.
  ///
  ///     var bits: BitArray = "1110110"
  ///     bits.maskingShiftLeft(by: 2)
  ///     // bits is now 111011000
  ///     bits.maskingShiftLeft(by: -4)
  ///     // bits is now 11101
  ///     bits.maskingShiftLeft(by: 8)
  ///     // bits is now 111010000000
  public mutating func resizingShiftLeft(by amount: Int) {
    guard amount != 0 else { return }
    if amount > 0 {
      _resizingShiftLeft(by: amount)
    } else {
      _resizingShiftRight(by: -amount)
    }
  }

  /// Shift the bits in this array by the specified number of places to the
  /// right (towards the start of the array), by removing `amount` existing
  /// values from the front of the array.
  ///
  /// If `amount` is negative, then this is equivalent to shifting `-amount`
  /// places to the left. If amount is greater than or equal to `count`,
  /// then the resulting bit array will be empty.
  ///
  ///     var bits: BitArray = "1110110"
  ///     bits.maskingShiftRight(by: 2)
  ///     // bits is now 11101
  ///     bits.maskingShiftRight(by: -4)
  ///     // bits is now 111010000
  ///     bits.maskingShiftRight(by: 10)
  ///     // bits is now empty
  ///
  /// If `amount` is between 0 and `count`, then this has the same effect as
  /// `removeFirst(amount)`.
  public mutating func resizingShiftRight(by amount: Int) {
    guard amount != 0 else { return }
    if amount > 0 {
      _resizingShiftRight(by: amount)
    } else {
      _resizingShiftLeft(by: -amount)
    }
  }

  internal mutating func _resizingShiftLeft(by amount: Int) {
    assert(amount > 0)
    _extend(by: amount, with: false)
    maskingShiftLeft(by: amount)
  }

  internal mutating func _resizingShiftRight(by amount: Int) {
    assert(amount > 0)
    guard amount < count else {
      self = .init()
      return
    }
    self._copy(from: Range(uncheckedBounds: (amount, count)), to: 0)
    self._removeLast(count &- amount)
  }
}

extension BitArray {
  // FIXME: Add maskingShiftRight(by:in:) and maskingShiftLeft(by:in:) for shifting slices.

  /// Shift the bits in this array by the specified number of places to the
  /// left (towards the end of the array), without changing
  /// its count.
  ///
  /// Values that are shifted off the array are discarded. Values that are
  /// shifted in are all set to false.
  ///
  /// If `amount` is negative, this is equivalent to shifting `-amount`
  /// places to the right. If `amount` is greater than or equal to `count`,
  /// then all values are set to false.
  ///
  ///     var bits: BitArray = "1110110"
  ///     bits.maskingShiftLeft(by: 2)
  ///     // bits is now 1011000
  ///     bits.maskingShiftLeft(by: -4)
  ///     // bits is now 0000101
  ///     bits.maskingShiftLeft(by: 8)
  ///     // bits is now 0000000
  public mutating func maskingShiftLeft(by amount: Int) {
    guard amount != 0 else { return }
    _update {
      if amount > 0 {
        $0._maskingShiftLeft(by: amount)
      } else {
        $0._maskingShiftRight(by: -amount)
      }
    }
  }

  /// Shift the bits in this array by the specified number of places to the
  /// right (towards the beginning of the array), without changing
  /// its count.
  ///
  /// Values that are shifted off the array are discarded. Values that are
  /// shifted in are all set to false.
  ///
  /// If `amount` is negative, this is equivalent to shifting `-amount`
  /// places to the left. If `amount` is greater than or equal to `count`,
  /// then all values are set to false.
  ///
  ///     var bits: BitArray = "1110110"
  ///     bits.maskingShiftRight(by: 2)
  ///     // bits is now 0011101
  ///     bits.maskingShiftRight(by: -3)
  ///     // bits is now 1101000
  ///     bits.maskingShiftRight(by: 8)
  ///     // bits is now 0000000
  public mutating func maskingShiftRight(by amount: Int) {
    guard amount != 0 else { return }
    _update {
      if amount > 0 {
        $0._maskingShiftRight(by: amount)
      } else {
        $0._maskingShiftLeft(by: -amount)
      }
    }
  }
}

extension BitArray._UnsafeHandle {
  internal mutating func _maskingShiftLeft(by amount: Int) {
    assert(amount > 0)
    let d = Swift.min(amount, self.count)
    if d == amount {
      let range = Range(uncheckedBounds: (0, self.count &- d))
      self.copy(from: range, to: d)
    }
    self.clear(in: Range(uncheckedBounds: (0, d)))
  }

  internal mutating func _maskingShiftRight(by amount: Int) {
    assert(amount > 0)
    let d = Swift.min(amount, self.count)
    if d == amount {
      let range = Range(uncheckedBounds: (d, self.count))
      self.copy(from: range, to: 0)
    }
    self.clear(in: Range(uncheckedBounds: (self.count &- d, self.count)))
  }
}