data-structure-typed 1.40.0-rc → 1.41.0

package/src/data-structures/heap/heap.ts

@@ -1,212 +1,589 @@
 /**
  * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
-import {PriorityQueue} from '../priority-queue';
-import type {HeapOptions} from '../../types';
 
-export class HeapItem<V = any> {
+import type {Comparator, DFSOrderPattern} from '../../types';
+
+export class Heap<E = any> {
+  constructor(options: { comparator: Comparator<E>; nodes?: E[] }) {
+    this._comparator = options.comparator;
+    if (options.nodes && options.nodes.length > 0) {
+      this._nodes = options.nodes;
+      this.fix();
+    }
+  }
+
+  protected _nodes: E[] = [];
+
+  get nodes(): E[] {
+    return this._nodes;
+  }
+
+  protected _comparator: Comparator<E>;
+
+  get comparator(): Comparator<E> {
+    return this._comparator;
+  }
+
   /**
-   * The constructor function initializes an instance of a class with a priority and a value.
-   * @param {number} priority - The `priority` parameter is a number that represents the priority of the value. It is
-   * optional and has a default value of `NaN`.
-   * @param {V | null} [val=null] - The `val` parameter is of type `V | null`, which means it can accept a value of type
-   * `V` or `null`.
+   * Get the size (number of elements) of the heap.
    */
-  constructor(priority: number = Number.MAX_SAFE_INTEGER, val: V | null = null) {
-    this._val = val;
-    this._priority = priority;
+  get size(): number {
+    return this.nodes.length;
   }
 
-  private _priority: number;
+  /**
+   * Get the last element in the heap, which is not necessarily a leaf node.
+   * @returns The last element or undefined if the heap is empty.
+   */
+  get leaf(): E | undefined {
+    return this.nodes[this.size - 1] ?? undefined;
+  }
 
-  get priority(): number {
-    return this._priority;
+  /**
+   * Static method that creates a binary heap from an array of nodes and a comparison function.
+   * @returns A new Heap instance.
+   * @param options
+   */
+  static heapify<E>(options: { nodes: E[]; comparator: Comparator<E> }): Heap<E> {
+    return new Heap<E>(options);
+  }
+
+  /**
+   * Insert an element into the heap and maintain the heap properties.
+   * @param element - The element to be inserted.
+   */
+  add(element: E): Heap<E> {
+    return this.push(element);
   }
 
-  set priority(value: number) {
-    this._priority = value;
+  /**
+   * Insert an element into the heap and maintain the heap properties.
+   * @param element - The element to be inserted.
+   */
+  push(element: E): Heap<E> {
+    this.nodes.push(element);
+    this.bubbleUp(this.nodes.length - 1);
+    return this;
   }
 
-  private _val: V | null;
+  /**
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @returns The top element or undefined if the heap is empty.
+   */
+  poll(): E | undefined {
+    if (this.nodes.length === 0) {
+      return undefined;
+    }
+    if (this.nodes.length === 1) {
+      return this.nodes.pop() as E;
+    }
 
-  get val(): V | null {
-    return this._val;
+    const topValue = this.nodes[0];
+    this.nodes[0] = this.nodes.pop() as E;
+    this.sinkDown(0);
+    return topValue;
   }
 
-  set val(value: V | null) {
-    this._val = value;
+  /**
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @returns The top element or undefined if the heap is empty.
+   */
+  pop(): E | undefined {
+    return this.poll();
   }
-}
 
-export abstract class Heap<V = any> {
   /**
-   * The function is a constructor for a class that initializes a priority callback function based on the
-   * options provided.
-   * @param [options] - An optional object that contains configuration options for the Heap.
+   * Peek at the top element of the heap without removing it.
+   * @returns The top element or undefined if the heap is empty.
    */
-  protected constructor(options?: HeapOptions<V>) {
-    if (options) {
-      const {priorityExtractor} = options;
-      if (priorityExtractor !== undefined && typeof priorityExtractor !== 'function') {
-        throw new Error('.constructor expects a valid priority function');
-      }
-      this._priorityExtractor = priorityExtractor || (el => +el);
-    } else {
-      this._priorityExtractor = el => +el;
+  peek(): E | undefined {
+    if (this.nodes.length === 0) {
+      return undefined;
     }
+    return this.nodes[0];
   }
 
-  protected abstract _pq: PriorityQueue<HeapItem<V>>;
+  /**
+   * Check if the heap is empty.
+   * @returns True if the heap is empty, otherwise false.
+   */
+  isEmpty() {
+    return this.size === 0;
+  }
 
-  get pq() {
-    return this._pq;
+  /**
+   * Reset the nodes of the heap. Make the nodes empty.
+   */
+  clear() {
+    this._nodes = [];
   }
 
-  protected _priorityExtractor: (val: V) => number;
-  get priorityExtractor() {
-    return this._priorityExtractor;
+  /**
+   * Clear and add nodes of the heap
+   * @param nodes
+   */
+  refill(nodes: E[]) {
+    this._nodes = nodes;
+    this.fix();
   }
 
   /**
-   * The function returns the size of a priority queue.
-   * @returns The size of the priority queue.
+   * Use a comparison function to check whether a binary heap contains a specific element.
+   * @param element - the element to check.
+   * @returns Returns true if the specified element is contained; otherwise, returns false.
    */
-  get size(): number {
-    return this._pq.size;
+  has(element: E): boolean {
+    return this.nodes.includes(element);
+  }
+
+  /**
+   * Depth-first search (DFS) method, different traversal orders can be selected。
+   * @param order - Traverse order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
+   * @returns An array containing elements traversed in the specified order.
+   */
+  dfs(order: DFSOrderPattern): E[] {
+    const result: E[] = [];
+
+    // Auxiliary recursive function, traverses the binary heap according to the traversal order
+    const dfsHelper = (index: number) => {
+      if (index < this.size) {
+        if (order === 'in') {
+          dfsHelper(2 * index + 1);
+          result.push(this.nodes[index]);
+          dfsHelper(2 * index + 2);
+        } else if (order === 'pre') {
+          result.push(this.nodes[index]);
+          dfsHelper(2 * index + 1);
+          dfsHelper(2 * index + 2);
+        } else if (order === 'post') {
+          dfsHelper(2 * index + 1);
+          dfsHelper(2 * index + 2);
+          result.push(this.nodes[index]);
+        }
+      }
+    };
+
+    dfsHelper(0); // Traverse starting from the root node
+
+    return result;
   }
 
   /**
-   * The function checks if a priority queue is empty.
-   * @returns {boolean} A boolean value indicating whether the size of the priority queue is less than 1.
+   * Convert the heap to an array.
+   * @returns An array containing the elements of the heap.
    */
-  isEmpty(): boolean {
-    return this._pq.size < 1;
+  toArray(): E[] {
+    return [...this.nodes];
   }
 
-  peek(isItem?: undefined): V | undefined;
-  peek(isItem: false): V | undefined;
-  peek(isItem: true): HeapItem<V> | null;
+  getNodes(): E[] {
+    return this.nodes;
+  }
 
   /**
-   * The `peek` function returns the top item in the priority queue without removing it.
-   * @returns The `peek()` method is returning either a `HeapItem<V>` object or `null`.Returns an val with the highest priority in the queue
+   * Clone the heap, creating a new heap with the same elements.
+   * @returns A new Heap instance containing the same elements.
    */
-  peek(isItem?: boolean): HeapItem<V> | null | V | undefined {
-    isItem = isItem ?? false;
-    const peeked = this._pq.peek();
+  clone(): Heap<E> {
+    const clonedHeap = new Heap<E>({comparator: this.comparator});
+    clonedHeap._nodes = [...this.nodes];
+    return clonedHeap;
+  }
 
-    return isItem ? peeked : peeked?.val;
+  /**
+   * Sort the elements in the heap and return them as an array.
+   * @returns An array containing the elements sorted in ascending order.
+   */
+  sort(): E[] {
+    const visitedNode: E[] = [];
+    const cloned = this.clone();
+    while (cloned.size !== 0) {
+      const top = cloned.poll();
+      if (top) visitedNode.push(top);
+    }
+    return visitedNode;
   }
 
-  peekLast(isItem?: undefined): V | undefined;
-  peekLast(isItem: false): V | undefined;
-  peekLast(isItem: true): HeapItem<V> | null;
+  /**
+   * Float operation to maintain heap properties after adding an element.
+   * @param index - The index of the newly added element.
+   */
+  protected bubbleUp(index: number): void {
+    const element = this.nodes[index];
+    while (index > 0) {
+      const parentIndex = Math.floor((index - 1) / 2);
+      const parent = this.nodes[parentIndex];
+      if (this.comparator(element, parent) < 0) {
+        this.nodes[index] = parent;
+        this.nodes[parentIndex] = element;
+        index = parentIndex;
+      } else {
+        break;
+      }
+    }
+  }
 
   /**
-   * The `peekLast` function returns the last item in the heap.
-   * @returns The method `peekLast()` returns either a `HeapItem<V>` object or `null`.Returns an val with the lowest priority in the queue
+   * Sinking operation to maintain heap properties after removing the top element.
+   * @param index - The index from which to start sinking.
    */
-  peekLast(isItem?: boolean): HeapItem<V> | null | V | undefined {
-    isItem = isItem ?? false;
-    const leafItem = this._pq.leaf();
+  protected sinkDown(index: number): void {
+    const leftChildIndex = 2 * index + 1;
+    const rightChildIndex = 2 * index + 2;
+    const length = this.nodes.length;
+    let targetIndex = index;
+
+    if (leftChildIndex < length && this.comparator(this.nodes[leftChildIndex], this.nodes[targetIndex]) < 0) {
+      targetIndex = leftChildIndex;
+    }
+    if (rightChildIndex < length && this.comparator(this.nodes[rightChildIndex], this.nodes[targetIndex]) < 0) {
+      targetIndex = rightChildIndex;
+    }
 
-    return isItem ? leafItem : leafItem?.val;
+    if (targetIndex !== index) {
+      const temp = this.nodes[index];
+      this.nodes[index] = this.nodes[targetIndex];
+      this.nodes[targetIndex] = temp;
+      this.sinkDown(targetIndex);
+    }
   }
 
   /**
-   * The `add` function adds an val to a priority queue with an optional priority value.
-   * @param {V} val - The `val` parameter represents the value that you want to add to the heap. It can be of any
-   * type.
-   * @param {number} [priority] - The `priority` parameter is an optional number that represents the priority of the
-   * val being added to the heap. If the `val` parameter is a number, then the `priority` parameter is set to
-   * the value of `val`. If the `val` parameter is not a number, then the
-   * @returns The `add` method returns the instance of the `Heap` class.
-   * @throws {Error} if priority is not a valid number
+   * Fix the entire heap to maintain heap properties.
    */
-  add(priority: number, val?: V): Heap<V> {
-    val = val === undefined ? (priority as unknown as V) : val;
-    this._pq.add(new HeapItem<V>(priority, val));
+  protected fix() {
+    for (let i = Math.floor(this.size / 2); i >= 0; i--) this.sinkDown(i);
+  }
+}
+
+export class FibonacciHeapNode<E> {
+  element: E;
+  degree: number;
+  left?: FibonacciHeapNode<E>;
+  right?: FibonacciHeapNode<E>;
+  child?: FibonacciHeapNode<E>;
+  parent?: FibonacciHeapNode<E>;
+  marked: boolean;
+
+  constructor(element: E, degree = 0) {
+    this.element = element;
+    this.degree = degree;
+    this.marked = false;
+  }
+}
+
+export class FibonacciHeap<E> {
+  constructor(comparator?: Comparator<E>) {
+    this.clear();
+    this._comparator = comparator || this.defaultComparator;
 
+    if (typeof this.comparator !== 'function') {
+      throw new Error('FibonacciHeap constructor: given comparator should be a function.');
+    }
+  }
+
+  protected _root?: FibonacciHeapNode<E>;
+
+  get root(): FibonacciHeapNode<E> | undefined {
+    return this._root;
+  }
+
+  protected _size = 0;
+
+  get size(): number {
+    return this._size;
+  }
+
+  protected _min?: FibonacciHeapNode<E>;
+
+  get min(): FibonacciHeapNode<E> | undefined {
+    return this._min;
+  }
+
+  protected _comparator: Comparator<E>;
+
+  get comparator(): Comparator<E> {
+    return this._comparator;
+  }
+
+  /**
+   * Get the size (number of elements) of the heap.
+   * @returns {number} The size of the heap.  Returns 0 if the heap is empty. Returns -1 if the heap is invalid.
+   */
+  clear(): void {
+    this._root = undefined;
+    this._min = undefined;
+    this._size = 0;
+  }
+
+  /**
+   * O(1) time operation.
+   * Insert an element into the heap and maintain the heap properties.
+   * @param element
+   * @returns {FibonacciHeap<E>} FibonacciHeap<E> - The heap itself.
+   */
+  add(element: E): FibonacciHeap<E> {
+    return this.push(element);
+  }
+
+  /**
+   * O(1) time operation.
+   * Insert an element into the heap and maintain the heap properties.
+   * @param element
+   * @returns {FibonacciHeap<E>} FibonacciHeap<E> - The heap itself.
+   */
+  push(element: E): FibonacciHeap<E> {
+    const node = this.createNode(element);
+    node.left = node;
+    node.right = node;
+    this.mergeWithRoot(node);
+
+    if (!this.min || this.comparator(node.element, this.min.element) <= 0) {
+      this._min = node;
+    }
+
+    this._size++;
     return this;
   }
 
-  poll(isItem?: undefined): V | undefined;
-  poll(isItem: false): V | undefined;
-  poll(isItem: true): HeapItem<V> | null;
+  /**
+   * O(1) time operation.
+   * Peek at the top element of the heap without removing it.
+   * @returns The top element or undefined if the heap is empty.
+   * @protected
+   */
+  peek(): E | undefined {
+    return this.min ? this.min.element : undefined;
+  }
+
+  /**
+   * O(1) time operation.
+   * Get the size (number of elements) of the heap.
+   * @param {FibonacciHeapNode<E>} head - The head of the linked list.
+   * @protected
+   * @returns FibonacciHeapNode<E>[] - An array containing the nodes of the linked list.
+   */
+  consumeLinkedList(head?: FibonacciHeapNode<E>): FibonacciHeapNode<E>[] {
+    const nodes: FibonacciHeapNode<E>[] = [];
+    if (!head) return nodes;
+
+    let node: FibonacciHeapNode<E> | undefined = head;
+    let flag = false;
+
+    while (true) {
+      if (node === head && flag) break;
+      else if (node === head) flag = true;
+
+      if (node) {
+        nodes.push(node);
+        node = node.right;
+      }
+    }
+
+    return nodes;
+  }
 
   /**
-   * The `poll` function returns the top item from a priority queue or null if the queue is empty.Removes and returns an val with the highest priority in the queue
-   * @returns either a HeapItem<V> object or null.
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @param parent
+   * @param node
    */
-  poll(isItem?: boolean): HeapItem<V> | null | V | undefined {
-    isItem = isItem ?? false;
-    const top = this._pq.poll();
-    if (!top) {
-      return null;
+  mergeWithChild(parent: FibonacciHeapNode<E>, node: FibonacciHeapNode<E>): void {
+    if (!parent.child) {
+      parent.child = node;
+    } else {
+      node.right = parent.child.right;
+      node.left = parent.child;
+      parent.child.right!.left = node;
+      parent.child.right = node;
     }
+  }
 
-    return isItem ? top : top.val;
+  /**
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @returns The top element or undefined if the heap is empty.
+   */
+  poll(): E | undefined {
+    return this.pop();
   }
 
   /**
-   * The function checks if a given node or value exists in the priority queue.
-   * @param {V | HeapItem<V>} node - The parameter `node` can be of type `V` or `HeapItem<V>`.
-   * @returns a boolean value.
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @returns The top element or undefined if the heap is empty.
    */
-  has(node: V | HeapItem<V>): boolean {
-    if (node instanceof HeapItem) {
-      return this.pq.getNodes().includes(node);
+  pop(): E | undefined {
+    if (this.size === 0) return undefined;
+
+    const z = this.min!;
+    if (z.child) {
+      const nodes = this.consumeLinkedList(z.child);
+      for (const node of nodes) {
+        this.mergeWithRoot(node);
+        node.parent = undefined;
+      }
+    }
+
+    this.removeFromRoot(z);
+
+    if (z === z.right) {
+      this._min = undefined;
+      this._root = undefined;
     } else {
-      return (
-        this.pq.getNodes().findIndex(item => {
-          return item.val === node;
-        }) !== -1
-      );
+      this._min = z.right;
+      this.consolidate();
     }
+
+    this._size--;
+
+    return z.element;
   }
 
-  toArray(isItem?: undefined): (V | undefined)[];
-  toArray(isItem: false): (V | undefined)[];
-  toArray(isItem: true): (HeapItem<V> | null)[];
+  /**
+   * O(log n) time operation.
+   * merge two heaps. The heap that is merged will be cleared. The heap that is merged into will remain.
+   * @param heapToMerge
+   */
+  merge(heapToMerge: FibonacciHeap<E>): void {
+    if (heapToMerge.size === 0) {
+      return; // Nothing to merge
+    }
+
+    // Merge the root lists of the two heaps
+    if (this.root && heapToMerge.root) {
+      const thisRoot = this.root;
+      const otherRoot = heapToMerge.root;
+
+      const thisRootRight = thisRoot.right!;
+      const otherRootLeft = otherRoot.left!;
+
+      thisRoot.right = otherRoot;
+      otherRoot.left = thisRoot;
+
+      thisRootRight.left = otherRootLeft;
+      otherRootLeft.right = thisRootRight;
+    }
+
+    // Update the minimum node
+    if (!this.min || (heapToMerge.min && this.comparator(heapToMerge.min.element, this.min.element) < 0)) {
+      this._min = heapToMerge.min;
+    }
+
+    // Update the size
+    this._size += heapToMerge.size;
+
+    // Clear the heap that was merged
+    heapToMerge.clear();
+  }
 
   /**
-   * The `toArray` function returns an array of `HeapItem<V>` objects.
-   * @returns An array of HeapItem<V> objects.Returns a sorted list of vals
+   * Default comparator function used by the heap.
+   * @param {E} a
+   * @param {E} b
+   * @protected
    */
-  toArray(isItem?: boolean): (HeapItem<V> | null | V | undefined)[] {
-    isItem = isItem ?? false;
-    const itemArray = this._pq.toArray();
+  protected defaultComparator(a: E, b: E): number {
+    if (a < b) return -1;
+    if (a > b) return 1;
+    return 0;
+  }
 
-    return isItem ? itemArray : itemArray.map(item => item.val);
+  /**
+   * Create a new node.
+   * @param element
+   * @protected
+   */
+  protected createNode(element: E): FibonacciHeapNode<E> {
+    return new FibonacciHeapNode<E>(element);
   }
 
-  sort(isItem?: undefined): (V | undefined)[];
-  sort(isItem: false): (V | undefined)[];
-  sort(isItem: true): (HeapItem<V> | null)[];
+  /**
+   * Merge the given node with the root list.
+   * @param node - The node to be merged.
+   */
+  protected mergeWithRoot(node: FibonacciHeapNode<E>): void {
+    if (!this.root) {
+      this._root = node;
+    } else {
+      node.right = this.root.right;
+      node.left = this.root;
+      this.root.right!.left = node;
+      this.root.right = node;
+    }
+  }
 
   /**
-   * The function sorts the elements in the priority queue and returns either the sorted items or their values depending
-   * on the value of the isItem parameter.
-   * @param {boolean} [isItem] - The `isItem` parameter is a boolean flag that indicates whether the sorted result should
-   * be an array of `HeapItem<V>` objects or an array of the values (`V`) of those objects. If `isItem` is `true`, the
-   * sorted result will be an array of `HeapItem
-   * @returns an array of either `HeapItem<V>`, `null`, `V`, or `undefined` values.
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @param node - The node to be removed.
+   * @protected
    */
-  sort(isItem?: boolean): (HeapItem<V> | null | V | undefined)[] {
-    isItem = isItem ?? false;
-    const sorted = this._pq.sort();
+  protected removeFromRoot(node: FibonacciHeapNode<E>): void {
+    if (this.root === node) this._root = node.right;
+    if (node.left) node.left.right = node.right;
+    if (node.right) node.right.left = node.left;
+  }
 
-    return isItem ? sorted : sorted.map(item => item.val);
+  /**
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @param y
+   * @param x
+   * @protected
+   */
+  protected link(y: FibonacciHeapNode<E>, x: FibonacciHeapNode<E>): void {
+    this.removeFromRoot(y);
+    y.left = y;
+    y.right = y;
+    this.mergeWithChild(x, y);
+    x.degree++;
+    y.parent = x;
   }
 
   /**
-   * The clear function clears the priority queue.
+   * O(log n) time operation.
+   * Remove and return the top element (smallest or largest element) from the heap.
+   * @protected
    */
-  clear(): void {
-    this._pq.clear();
+  protected consolidate(): void {
+    const A: (FibonacciHeapNode<E> | undefined)[] = new Array(this.size);
+    const nodes = this.consumeLinkedList(this.root);
+    let x: FibonacciHeapNode<E> | undefined,
+      y: FibonacciHeapNode<E> | undefined,
+      d: number,
+      t: FibonacciHeapNode<E> | undefined;
+
+    for (const node of nodes) {
+      x = node;
+      d = x.degree;
+
+      while (A[d]) {
+        y = A[d] as FibonacciHeapNode<E>;
+
+        if (this.comparator(x.element, y.element) > 0) {
+          t = x;
+          x = y;
+          y = t;
+        }
+
+        this.link(y, x);
+        A[d] = undefined;
+        d++;
+      }
+
+      A[d] = x;
+    }
+
+    for (let i = 0; i < this.size; i++) {
+      if (A[i] && this.comparator(A[i]!.element, this.min!.element) <= 0) {
+        this._min = A[i]!;
+      }
+    }
   }
 }