Skip to main content

a heap with decrease-key and increase-key operations

Project description

heapdict implements the MutableMapping ABC, meaning it works pretty much like a regular Python dict. It’s designed to be used as a priority queue, where items are added and consumed as follows:

hd = heapdict()
hd[obj1] = priority1
hd[obj2] = priority2
# ...
(obj, priority) = hd.popitem()

Compared to an ordinary dict, a heapdict has the following differences:

popitem():

Remove and return the (key, priority) pair with the lowest priority, instead of a random object.

peekitem():

Return the (key, priority) pair with the lowest priority, without removing it.

Unlike the Python standard library’s heapq module, the heapdict supports efficiently changing the priority of an existing object (often called “decrease-key” in textbooks). Altering the priority is important for many algorithms such as Dijkstra’s Algorithm and A*.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

HeapDict-1.0.1.tar.gz (4.3 kB view hashes)

Uploaded source

Built Distribution

HeapDict-1.0.1-py3-none-any.whl (3.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page