fritter.boundaries.PriorityQueue

class documentation

class PriorityQueue(Protocol[Prioritized]): (source)

View In Hierarchy

High-level specification of a priority queue.

Method __iter__ Iterate all of the values in the priority queue, in an unspecified order.
Method add Add an item to the priority queue.
Method get Consume the lowest item from the priority queue.
Method peek Examine the lowest item from the priority queue without modifying the queue.
Method remove Remove an item and return whether it was removed or not.
def __iter__(self) -> Iterator[Prioritized]: (source)

Iterate all of the values in the priority queue, in an unspecified order.

def add(self, item: Prioritized): (source)

Add an item to the priority queue.

def get(self) -> Optional[Prioritized]: (source)

Consume the lowest item from the priority queue.

def peek(self) -> Optional[Prioritized]: (source)

Examine the lowest item from the priority queue without modifying the queue.

def remove(self, item: Prioritized) -> bool: (source)

Remove an item and return whether it was removed or not.