|
| 1 | +""" A Queue using a Linked List like structure """ |
| 2 | +from typing import Any, Optional |
| 3 | + |
| 4 | + |
| 5 | +class Node: |
| 6 | + def __init__(self, data: Any, next: Optional["Node"] = None): |
| 7 | + self.data: Any = data |
| 8 | + self.next: Optional["Node"] = next |
| 9 | + |
| 10 | + |
| 11 | +class LinkedQueue: |
| 12 | + """ |
| 13 | + Linked List Queue implementing put (to end of queue), |
| 14 | + get (from front of queue) and is_empty |
| 15 | +
|
| 16 | + >>> queue = LinkedQueue() |
| 17 | + >>> queue.is_empty() |
| 18 | + True |
| 19 | + >>> queue.put(5) |
| 20 | + >>> queue.put(9) |
| 21 | + >>> queue.put('python') |
| 22 | + >>> queue.is_empty(); |
| 23 | + False |
| 24 | + >>> queue.get() |
| 25 | + 5 |
| 26 | + >>> queue.put('algorithms') |
| 27 | + >>> queue.get() |
| 28 | + 9 |
| 29 | + >>> queue.get() |
| 30 | + 'python' |
| 31 | + >>> queue.get() |
| 32 | + 'algorithms' |
| 33 | + >>> queue.is_empty() |
| 34 | + True |
| 35 | + >>> queue.get() |
| 36 | + Traceback (most recent call last): |
| 37 | + ... |
| 38 | + IndexError: get from empty queue |
| 39 | + """ |
| 40 | + |
| 41 | + def __init__(self) -> None: |
| 42 | + self.front: Optional[Node] = None |
| 43 | + self.rear: Optional[Node] = None |
| 44 | + |
| 45 | + def is_empty(self) -> bool: |
| 46 | + """ returns boolean describing if queue is empty """ |
| 47 | + return self.front is None |
| 48 | + |
| 49 | + def put(self, item: Any) -> None: |
| 50 | + """ append item to rear of queue """ |
| 51 | + node: Node = Node(item) |
| 52 | + if self.is_empty(): |
| 53 | + # the queue contains just the single element |
| 54 | + self.front = node |
| 55 | + self.rear = node |
| 56 | + else: |
| 57 | + # not empty, so we add it to the rear of the queue |
| 58 | + assert isinstance(self.rear, Node) |
| 59 | + self.rear.next = node |
| 60 | + self.rear = node |
| 61 | + |
| 62 | + def get(self) -> Any: |
| 63 | + """ returns and removes item at front of queue """ |
| 64 | + if self.is_empty(): |
| 65 | + raise IndexError("get from empty queue") |
| 66 | + else: |
| 67 | + # "remove" element by having front point to the next one |
| 68 | + assert isinstance(self.front, Node) |
| 69 | + node: Node = self.front |
| 70 | + self.front = node.next |
| 71 | + if self.front is None: |
| 72 | + self.rear = None |
| 73 | + |
| 74 | + return node.data |
0 commit comments