[Heap] Update docs

This commit is contained in:
Karoy Lorentey committed 2023-11-14 19:10:35 -08:00
1 parent e10396bb20
commit 53831b3a22
2 files changed
+7 -7

No files matched your search

+5 -5
View File
@@ -53,8 +53,8 @@ This works by adding the new element into the end of the backing array and then
You can also insert a sequence of elements into a `Heap`:
```swift
var heap = Heap((0..<10))
heap.insert(contentsOf: (20...100).shuffled())
var heap = Heap(0 ..< 10)
heap.insert(contentsOf: (20 ... 100).shuffled())
heap.insert(contentsOf: [-5, -6, -8, -12, -3])
```
@@ -63,9 +63,9 @@ heap.insert(contentsOf: [-5, -6, -8, -12, -3])
As mentioned earlier, the smallest and largest elements can be queried in constant time:
```swift
var heap = Heap((1...20))
let min = heap.min() // min = 1
let max = heap.max() // max = 20
var heap = Heap(1 ... 20)
let min = heap.min // 1
let max = heap.max // 20
```
In a min-max heap, the smallest element is stored at index 0 in the backing array; the largest element is stored at either index 1 or index 2, the first max level in the heap (so to look up the largest, we compare the two and return the larger one).
+2 -2
View File
@@ -17,9 +17,9 @@
///
/// var queue: Heap<Int> = [3, 4, 1, 2]
/// queue.insert(0)
/// print(queue.min()) // 0
/// print(queue.min) // 0
/// print(queue.popMax()) // 4
/// print(queue.max()) // 3
/// print(queue.max) // 3
///
/// `Heap` implements the min-max heap data structure, based on
/// [Atkinson et al. 1986].