# Heapify ✌️

- Intro

## Content

When you have a sequence of candidates to process, then you build a queue to organize them. In the classical queue, the time of adding an item to the queue defines when it’s going to be processed.

What if we need to change this principle and use some **relative importance score** to determine the item processing sequence?

Well, then we would reinvent ~~bicycle~~ the priority queue.

**The priority queue or heap** is a data structure that efficiently allows the retrieval of the next queued item with min or max importance score.

## Nearly Complete Binary Tree

The heap can be represented as an array or a list that is visualized as a nearly complete binary tree:

Since it’s a binary tree, **all parent nodes** have **at max 2 children**. The binary tree is filled level by level from top to bottom, from left incomplete parent nodes (with none or one child) to right ones.

With such a node positioning, we can come up with formulas for finding parent/children nodes:

- $element\_idx / 2$ is the node parent index
- $2 * element\_idx$ is an index of the left child
- $2 * element\_idx + 1$ is an index of the right child

where $element\_idx$ is some node index.

Additionally, the binary tree has the following useful properties:

- Heigh of the tree is $ln(N) + 1$

The “nearly complete” means that **not all tree levels** may be **filled out** by leaf nodes (nodes without children). In other words, we can have a heap with any number of items.

The heap has a distinct property that actually makes it helpful:

- all children node values should be
**less or equal**to the parent node value (**the max-heap property**) - or all children node values should be
**greater or equal**to the parent node value (**the min-heap property**)

To explain how all of this can be useful, we are going to implement the main heap functions from scratch.

## Heap Building

There is going to be a custom `PriorityQueue`

`PriorityQueue`

class which takes an arbitrary array of integers, makes a heap from it and sustains the heap property during all operations.

The first thing we need to do is to build a max heap from an unsorted array. We can already visualize the array as a heap, but it would **luck the max heap property**.

Notice that **leaf nodes can’t violate the heap property** since they don’t have any child nodes. Hence, we can start looking at possible violations from the second-to-last level. The index of the last parent element on that level we can get via `n // 2`

where `n`

is the size of the array.

We start moving from right to left, from the bottom to the top of the heap. For each parent node, we need to make sure that the property of the heap holds true. If there is any violations, we just switch the current parent node with a child node that is greater than it (which violates the heap property).

However, this switching of the nodes may create a new violation on the levels below. So we need to perform the same procedure again for a node that became a child.

Here is how this can be implemented:

```
from typing import List
class PriorityQueue:
"""
Represents the heap and preserves the heap property during adding/removing elements
"""
items: List[int]
def __init__(self, items: List[int]):
self.items = self.build_heap(items)
def build_heap(self, items: List[int]) -> List[int]:
"""
Turn an unsorted array into a heap
"""
items_count = len(items)
for i in range(items_count // 2, -1, -1):
items = self.heapify(items, i)
return items
def heapify(self, items: List[int], node_idx: int, root_idx: int = 0) -> List[int]:
"""
Check and fix violations of the heap property recursively
"""
items_count = len(items)
largest_idx = node_idx
# formulas for zero-indexed arrays
left_child_idx = 2 * (node_idx - root_idx) + 1 + root_idx
right_child_idx = 2 * (node_idx - root_idx) + 2 + root_idx
# is the left child node bigger than parent node?
if left_child_idx < items_count and items[left_child_idx] > items[largest_idx]:
largest_idx = left_child_idx
# is the right child node bigger than parent or left node?
if right_child_idx < items_count and items[right_child_idx] > items[largest_idx]:
largest_idx = right_child_idx
# let's fix a violation of the heap property
if largest_idx != node_idx:
items[node_idx], items[largest_idx] = items[largest_idx], items[node_idx]
return self.heapify(items, largest_idx, root_idx=root_idx)
return items
def size(self) -> int:
return len(self.items)
```

```
from typing import List
class PriorityQueue:
"""
Represents the heap and preserves the heap property during adding/removing elements
"""
items: List[int]
def __init__(self, items: List[int]):
self.items = self.build_heap(items)
def build_heap(self, items: List[int]) -> List[int]:
"""
Turn an unsorted array into a heap
"""
items_count = len(items)
for i in range(items_count // 2, -1, -1):
items = self.heapify(items, i)
return items
def heapify(self, items: List[int], node_idx: int, root_idx: int = 0) -> List[int]:
"""
Check and fix violations of the heap property recursively
"""
items_count = len(items)
largest_idx = node_idx
# formulas for zero-indexed arrays
left_child_idx = 2 * (node_idx - root_idx) + 1 + root_idx
right_child_idx = 2 * (node_idx - root_idx) + 2 + root_idx
# is the left child node bigger than parent node?
if left_child_idx < items_count and items[left_child_idx] > items[largest_idx]:
largest_idx = left_child_idx
# is the right child node bigger than parent or left node?
if right_child_idx < items_count and items[right_child_idx] > items[largest_idx]:
largest_idx = right_child_idx
# let's fix a violation of the heap property
if largest_idx != node_idx:
items[node_idx], items[largest_idx] = items[largest_idx], items[node_idx]
return self.heapify(items, largest_idx, root_idx=root_idx)
return items
def size(self) -> int:
return len(self.items)
```

Complexity of this algorithm is $\Theta(n)$. This is because we check each position only once making our way up the heap. All levels below the current one at each point of time are already satisfying the heap property. So there is no need to back them up.

## Adding a New Element

Another useful method to have is adding a new item to the heap. In this case, it’s convenient to add a new item as a leaf node in the end of the heap array. This makes sure there are no violations below it. However, there may be some going upward. That’s why we need to go all the way up and check whenever parent nodes are greater than the new item. If they are not, we will switch their positions.

Since the max heap property had stayed true before we add the new item, it’s sufficient for us to check only parent nodes as we know that all child nodes should be less or equal to the parent value.

Now we can take a look at the implementation:

```
def push(self, item: int):
"""
Add a new item to the heap preserving the heap property
"""
self.items.append(item)
idx = len(self.items) - 1
parent_idx = idx // 2
if idx % 2 == 0:
# calculating parents in zero-indexed array
parent_idx -= 1
while idx > 0 and self.items[idx] > self.items[parent_idx]:
tmp = self.items[parent_idx]
self.items[parent_idx] = self.items[idx]
self.items[idx] = tmp
idx = parent_idx
parent_idx = idx // 2
if idx % 2 == 0:
# calculating parents in zero-indexed array
parent_idx -= 1
```

```
def push(self, item: int):
"""
Add a new item to the heap preserving the heap property
"""
self.items.append(item)
idx = len(self.items) - 1
parent_idx = idx // 2
if idx % 2 == 0:
# calculating parents in zero-indexed array
parent_idx -= 1
while idx > 0 and self.items[idx] > self.items[parent_idx]:
tmp = self.items[parent_idx]
self.items[parent_idx] = self.items[idx]
self.items[idx] = tmp
idx = parent_idx
parent_idx = idx // 2
if idx % 2 == 0:
# calculating parents in zero-indexed array
parent_idx -= 1
```

The complexity of heap inserting algorithm is $\Theta(log(n))$ since at each interaction we traversal another tree level.

## Extracting The Max Element

The key method of the heap is extracting the max element. Because of the heap property, the max element should always stay that the top of the heap. So it’s as simple as call `self.items[0]`

`self.items[0]`

to get it.

That’s not all. The extraction would remove the element from the heap and we can not just leave it with a “hole”. Instead, we need to put the next max element there.

Like before, the safest way is to **replace the hole with the last leaf node** (not to change the heap property in other branches of the heap). The last item is just handy to use, but it’s not necessarily the next needed candidate to be at the top of the heap. To make sure, we need to run the `heapify()`

`heapify()`

method which recursively fixes all violations.

The implementation is straightforward:

```
def pop(self):
"""
Extract the next item from the heap according to priority (the next biggest element in our max heap case)
"""
item = self.items[0]
items_count = len(self.items)
self.items[0] = self.items[items_count - 1] # replace extracted max element with one of the balanced leaves
del self.items[items_count - 1]
self.items = self.heapify(self.items, 0)
return item
```

```
def pop(self):
"""
Extract the next item from the heap according to priority (the next biggest element in our max heap case)
"""
item = self.items[0]
items_count = len(self.items)
self.items[0] = self.items[items_count - 1] # replace extracted max element with one of the balanced leaves
del self.items[items_count - 1]
self.items = self.heapify(self.items, 0)
return item
```

The complexity of heap items extracting algorithm is $\Theta(log(n))$. Nevertheless, we can get access to the current max element in $\Theta(1)$.

## Heap Sort

Now we have all components to implement one of the most frequent applications of the priority queue - the heap sorting.

Heap sort is just the extraction of `n`

elements from the heap.

The simplest implementation of the heap source may look like this in Python:

```
def heap_sort(heap: PriorityQueue) -> List[int]:
items_count = heap.size()
result = []
for i in range(items_count):
result.append(heap.pop())
return result
```

```
def heap_sort(heap: PriorityQueue) -> List[int]:
items_count = heap.size()
result = []
for i in range(items_count):
result.append(heap.pop())
return result
```

The complexity of heap sorting is $\Theta(nlog(n))$.

It takes the additional memory to store another sorted copy of the array. However, we can do in-place sorting as well:

```
def sort(self) -> List[int]:
"""
In-place version of the heap sort.
It breaks the heap property, so be aware of that.
"""
items_count = self.size()
for i in range(1, items_count - 1):
# find the next max element/restore the heap property
items = self.heapify(self.items, i, root_idx=i)
return self.items
```

```
def sort(self) -> List[int]:
"""
In-place version of the heap sort.
It breaks the heap property, so be aware of that.
"""
items_count = self.size()
for i in range(1, items_count - 1):
# find the next max element/restore the heap property
items = self.heapify(self.items, i, root_idx=i)
return self.items
```

In this approach, we use the root node offset trick that helps us to change the position of the root node and move from the left to right sorting the `self.items`

`self.items`

array. The `root_idx`

`root_idx`

param is just tweaks the child calculation formula for that.

The cost of being in-place solution is breaking the heap property in `self.items`

`self.items`

array. I would prefer the first version of the heap sort in order to avoid such a mutations to `self.items`

`self.items`

array.

## Applications

Heap sorting is not the only application of the priority queue. Here are a few more cases where heaps are being applied:

- access to a limited resource like making sure your Zoom application has a high network bandwidth priority, hence, lower latency
- device interruption handling like pressing a key on the keyboard triggers a specific interruption handler that rads a key value and send it to the OS. There is an interruption latency associated with this process and interruptions from some devices we wish to be processed as soon as possible
- the heap can be used during searching for K-Nearest Neighbors

Broadly speaking, the heap may be used everywhere where we need to keep track of the list of min or max elements that may be changed during the runtime.

## heapq

Thankfully, it’s not required to implement the heap yourself everytime you need it. Python provides a library called heapq which is a set of functions that operates on the “heapified” array preserving the min-heap property.

The min-heap sort can be implemented this way:

```
import heapq
heap = [2, 7, 26, 25, 19, 17, 1, 90, 3, 36]
heapq.heapify(heap)
result = []
n = len(heap)
for i in range(n):
result.append(heapq.heappop(heap))
```

```
import heapq
heap = [2, 7, 26, 25, 19, 17, 1, 90, 3, 36]
heapq.heapify(heap)
result = []
n = len(heap)
for i in range(n):
result.append(heapq.heappop(heap))
```

## Practice

- [Leetcode] 1046. Last Stone Weight
- [Leetcode] 1834. Single-Threaded CPU
- [Leetcode] 719. Find K-th Smallest Pair Distance

## Summary

In this article, we have reviewed how to implement a priority queue, what properties it has and how it can be helpful.

If the heap concept was new for you, try to do a few problems from the practice section.

Finally, let me know in the comments what unusual applications of heaps you have seen in your practice.