File: OrderedSet%2BReserveCapacity.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 (129 lines) | stat: -rw-r--r-- 5,263 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
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

extension OrderedSet {
  /// Creates an empty set with preallocated space for at least the
  /// specified number of elements.
  ///
  /// Use this initializer to avoid intermediate reallocations of a
  /// set's storage buffer when you know in advance how many elements
  /// you'll insert into the set after creation.
  ///
  /// If you have a good idea of the expected working size of the set, calling
  /// this initializer with `persistent` set to true can sometimes improve
  /// performance by eliminating churn due to repeated rehashings when the set
  /// temporarily shrinks below its regular size.
  ///
  /// - Parameter minimumCapacity: The minimum number of elements that the newly
  ///   created set should be able to store without reallocating its storage.
  ///
  /// - Parameter persistent: If set to true, prevent removals from shrinking
  ///   storage below the specified capacity. By default, removals are allowed
  ///   to shrink storage below any previously reserved capacity.
  ///
  /// - Complexity: O(`minimumCapacity`)
  @inlinable
  public init(minimumCapacity: Int, persistent: Bool = false) {
    self.init()
    self._reserveCapacity(minimumCapacity, persistent: persistent)
  }
}

extension OrderedSet {
  /// Reserves enough space to store the specified number of elements.
  ///
  /// This method ensures that the set has unique mutable storage, with space
  /// allocated for at least the requested number of elements.
  ///
  /// If you are adding a known number of elements to a set, call this method
  /// once before the first insertion to avoid multiple reallocations.
  ///
  /// Do not call this method in a loop -- it does not use an exponential
  /// allocation strategy, so doing that can result in quadratic instead of
  /// linear performance.
  ///
  /// - Parameter minimumCapacity: The minimum number of elements that the set
  ///   should be able to store without reallocating its storage.
  ///
  /// - Complexity: O(`max(count, minimumCapacity)`)
  @inlinable
  public mutating func reserveCapacity(_ minimumCapacity: Int) {
    self._reserveCapacity(minimumCapacity, persistent: false)
  }
}

extension OrderedSet {
  /// Reserves enough space to store the specified number of elements.
  ///
  /// This method ensures that the set has unique mutable storage, with space
  /// allocated for at least the requested number of elements.
  ///
  /// If you are adding a known number of elements to a set, call this method
  /// once before the first insertion to avoid multiple reallocations.
  ///
  /// Do not call this method in a loop -- it does not use an exponential
  /// allocation strategy, so doing that can result in quadratic instead of
  /// linear performance.
  ///
  /// If you have a good idea of the expected working size of the set, calling
  /// this method with `persistent` set to true can sometimes improve
  /// performance by eliminating churn due to repeated rehashings when the set
  /// temporarily shrinks below its regular size. You can cancel any capacity
  /// you've previously reserved by persistently reserving a capacity of zero.
  /// (This also shrinks the hash table to the ideal size for its current number
  /// elements.)
  ///
  /// - Parameter minimumCapacity: The minimum number of elements that the set
  ///   should be able to store without reallocating its storage.
  ///
  /// - Parameter persistent: If set to true, prevent removals from shrinking
  ///   storage below the specified capacity. By default, removals are allowed
  ///   to shrink storage below any previously reserved capacity.
  ///
  /// - Complexity: O(`max(count, minimumCapacity)`)
  @inlinable
  internal mutating func _reserveCapacity(
    _ minimumCapacity: Int,
    persistent: Bool
  ) {
    precondition(minimumCapacity >= 0, "Minimum capacity cannot be negative")
    defer { _checkInvariants() }

    _elements.reserveCapacity(minimumCapacity)

    let currentScale = _scale
    let newScale = _HashTable.scale(forCapacity: minimumCapacity)

    let reservedScale = persistent ? newScale : _reservedScale

    if currentScale < newScale {
      // Grow the table.
      _regenerateHashTable(scale: newScale, reservedScale: reservedScale)
      return
    }

    let requiredScale = _HashTable.scale(forCapacity: self.count)
    let minScale = Swift.max(Swift.max(newScale, reservedScale), requiredScale)
    if minScale < currentScale {
      // Shrink the table.
      _regenerateHashTable(scale: minScale, reservedScale: reservedScale)
      return
    }

    // When we have the right size table, ensure it's unique and it has the
    // right persisted reservation.
    _ensureUnique()
    if _reservedScale != reservedScale {
      // Remember reserved scale.
      __storage!.header.reservedScale = reservedScale
    }
  }
}