data-structure-typed 1.40.0-rc → 1.40.0

package/src/data-structures/priority-queue/priority-queue.ts

@@ -1,359 +1,16 @@
 /**
  * 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 type {PriorityQueueComparator, PriorityQueueDFSOrderPattern, PriorityQueueOptions} from '../../types';
 
-export class PriorityQueue<E = any> {
-  /**
-   * The constructor initializes a priority queue with the given options, including an array of nodes and a comparator
-   * function.
-   * @param options - The `options` parameter is an object that contains the following properties:
-   */
-  constructor(options: PriorityQueueOptions<E>) {
-    const {nodes, comparator, isFix = true} = options;
-    this._comparator = comparator;
+import {Heap} from '../heap';
+import {Comparator} from '../../types';
 
-    if (nodes && Array.isArray(nodes) && nodes.length > 0) {
-      // TODO support distinct
-      this._nodes = [...nodes];
-      isFix && this._fix();
-    }
+export class PriorityQueue<E = any> extends Heap<E> {
+  constructor(options: { comparator: Comparator<E>; nodes?: E[] }) {
+    super(options);
   }
-
-  protected _nodes: E[] = [];
-
-  get nodes(): E[] {
-    return this._nodes;
-  }
-
-  get size(): number {
-    return this.nodes.length;
-  }
-
-  /**
-   * The `heapify` function creates a new PriorityQueue instance and fixes the heap property.
-   * @param options - The "options" parameter is an object that contains the configuration options for the PriorityQueue.
-   * It can include properties such as "comparator" which specifies the comparison function used to order the elements in
-   * the priority queue, and "initialValues" which is an array of initial values to be added to the priority
-   * @returns a new instance of the PriorityQueue class after performing the heapify operation on it.
-   */
-  static heapify<E>(options: PriorityQueueOptions<E>) {
-    const heap = new PriorityQueue(options);
-    heap._fix();
-    return heap;
-  }
-
-  /**
-   * The function checks if a priority queue is valid by creating a new priority queue with a fix option and then calling
-   * the isValid method.
-   * @param options - An object containing options for creating a priority queue. The options object should have the
-   * following properties:
-   * @returns the result of calling the `isValid()` method on a new instance of the `PriorityQueue` class.
-   */
-  static isPriorityQueueified<E>(options: Omit<PriorityQueueOptions<E>, 'isFix'>) {
-    return new PriorityQueue({...options, isFix: false}).isValid();
-  }
-
-  /**
-   * Starting from TypeScript version 5.0 and onwards, the use of distinct access modifiers for Getters and Setters is not permitted. As an alternative, to ensure compatibility, it is necessary to adopt a Java-style approach for Setters (using the same name as the property) while utilizing separate method names for Getters.
-   */
-  getNodes(): E[] {
-    return this._nodes;
-  }
-
-  /**
-   * The "add" function adds a node to the heap and ensures that the heap property is maintained.
-   * @param {E} node - The parameter "node" is of type E, which means it can be any data type. It represents the node
-   * that needs to be added to the heap.
-   */
-  add(node: E) {
-    this.nodes.push(node);
-    this._heapifyUp(this.size - 1);
-  }
-
-  /**
-   * The "has" function checks if a given node is present in the list of nodes.
-   * @param {E} node - The parameter `node` is of type `E`, which means it can be any type. It represents the node that
-   * we want to check if it exists in the `nodes` array.
-   * @returns a boolean value indicating whether the given node is included in the array of nodes.
-   */
-  has(node: E): boolean {
-    return this.nodes.includes(node);
-  }
-
-  /**
-   * The `peek` function returns the first element of the `nodes` array if it exists, otherwise it returns `null`.
-   * @returns The `peek()` function is returning the first element (`E`) of the `nodes` array if the `size` is not zero.
-   * Otherwise, it returns `null`.
-   */
-  peek(): E | null {
-    return this.size ? this.nodes[0] : null;
-  }
-
-  /**
-   * The `poll` function removes and returns the top element from a heap data structure.
-   * @returns The `poll()` method returns a value of type `E` or `null`.
-   */
-  poll(): E | null {
-    let res: E | null = null;
-    if (this.size > 1) {
-      this._swap(0, this.nodes.length - 1);
-      res = this.nodes.pop() ?? null;
-      this._heapifyDown(0);
-    } else if (this.size === 1) {
-      res = this.nodes.pop() ?? null;
-    }
-    return res;
-  }
-
-  /**
-   * The `leaf` function returns the last element in the `nodes` array or `null` if the array is empty.
-   * @returns The method `leaf()` is returning the last element (`E`) in the `nodes` array if it exists. If the array is
-   * empty or the last element is `null`, then it returns `null`.
-   */
-  leaf(): E | null {
-    return this.nodes[this.size - 1] ?? null;
-  }
-
-  /**
-   * The function checks if the size of an object is equal to zero and returns a boolean value indicating whether the
-   * object is empty or not.
-   * @returns The method `isEmpty()` is returning a boolean value indicating whether the size of the object is equal to
-   * 0.
-   */
-  isEmpty() {
-    return this.size === 0;
-  }
-
-  /**
-   * The clear function clears the nodes array.
-   */
-  clear() {
-    this._setNodes([]);
-  }
-
-  /**
-   * The toArray function returns an array containing all the elements in the nodes property.
-   * @returns An array of type E, which is the elements of the nodes property.
-   */
-  toArray(): E[] {
-    return [...this.nodes];
-  }
-
-  /**
-   * The `clone` function returns a new instance of the `PriorityQueue` class with the same nodes and comparator as the
-   * original instance.
-   * @returns The `clone()` method is returning a new instance of the `PriorityQueue` class with the same `nodes` and
-   * `comparator` properties as the original instance.
-   */
-  clone(): PriorityQueue<E> {
-    return new PriorityQueue<E>({
-      nodes: this.nodes,
-      comparator: this._comparator
-    });
-  }
-
-  // --- start additional methods ---
-  /**
-   * The `isValid` function recursively checks if a binary tree satisfies a certain condition.
-   * @returns The function `isValid()` returns a boolean value.
-   */
-  isValid(): boolean {
-    for (let i = 0; i < this.nodes.length; i++) {
-      const leftChildIndex = this._getLeft(i);
-      const rightChildIndex = this._getRight(i);
-      if (this._isValidIndex(leftChildIndex) && !this._compare(leftChildIndex, i)) {
-        return false;
-      }
-      if (this._isValidIndex(rightChildIndex) && !this._compare(rightChildIndex, i)) {
-        return false;
-      }
-    }
-    return true;
-  }
-
-  /**
-   * O(n log n), In scenarios with smaller data sizes, heap sort is generally expected to be slower than QuickSort or MergeSort.
-   */
-
-  /**
-   * The function sorts the elements in a data structure and returns them in an array.
-   * Plan to support sorting of duplicate elements.
-   * @returns The `sort()` method is returning an array of type `E[]`.
-   */
-  sort(): E[] {
-    const visitedNode: E[] = [];
-    while (this.size !== 0) {
-      const top = this.poll();
-      if (top) visitedNode.push(top);
-    }
-    return visitedNode;
-  }
-
-  /**
-   * The dfs function performs a depth-first search traversal on a binary tree and returns an array of visited nodes
-   * based on the specified traversal order.
-   * @param {PriorityQueueDFSOrderPattern} dfsMode - The dfsMode parameter is a string that specifies the order in which
-   * the nodes should be visited during the Depth-First Search (dfs) traversal. It can have one of the following values:
-   * @returns an array of type `(E | null)[]`.
-   */
-  dfs(dfsMode: PriorityQueueDFSOrderPattern): (E | null)[] {
-    const visitedNode: (E | null)[] = [];
-
-    const traverse = (cur: number) => {
-      const leftChildIndex = this._getLeft(cur);
-      const rightChildIndex = this._getRight(cur);
-      switch (dfsMode) {
-        case 'in':
-          this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
-          visitedNode.push(this.nodes[cur] ?? null);
-          this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
-          break;
-        case 'pre':
-          visitedNode.push(this.nodes[cur] ?? null);
-          this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
-          this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
-          break;
-        case 'post':
-          this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
-          this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
-          visitedNode.push(this.nodes[cur] ?? null);
-          break;
-      }
-    };
-
-    this._isValidIndex(0) && traverse(0);
-    return visitedNode;
-  }
-
-  protected _setNodes(value: E[]) {
-    this._nodes = value;
-  }
-
-  protected readonly _comparator: PriorityQueueComparator<E> = (a: E, b: E) => {
-    const aKey = a as unknown as number,
-      bKey = b as unknown as number;
-    return aKey - bKey;
-  };
-
-  /**
-   * The function compares two numbers using a custom comparator function.
-   * @param {number} a - The parameter "a" is a number that represents the index of a node in an array.
-   * @param {number} b - The parameter "b" is a number.
-   * @returns the result of the comparison between the elements at indices `a` and `b` in the `nodes` array. The
-   * comparison is done using the `_comparator` function, and if the result is greater than 0, `true` is returned,
-   * indicating that the element at index `a` is greater than the element at index `b`.
-   */
-  protected _compare(a: number, b: number) {
-    return this._comparator(this.nodes[a], this.nodes[b]) > 0;
-  }
-
-  /**
-   * The function swaps two elements in an array.
-   * @param {number} a - The parameter "a" is a number that represents the index of an element in an array.
-   * @param {number} b - The parameter "b" is a number.
-   */
-  protected _swap(a: number, b: number) {
-    const temp = this.nodes[a];
-    this.nodes[a] = this.nodes[b];
-    this.nodes[b] = temp;
-  }
-
-  /**
-   * The function checks if a given index is valid within an array.
-   * @param {number} index - The parameter "index" is of type number and represents the index value that needs to be
-   * checked for validity.
-   * @returns A boolean value indicating whether the given index is valid or not.
-   */
-  protected _isValidIndex(index: number): boolean {
-    return index > -1 && index < this.nodes.length;
-  }
-
-  /**
-   * The function returns the index of the parent node given the index of a child node in a binary tree.
-   * @param {number} child - The "child" parameter is a number representing the index of a child node in a binary tree.
-   * @returns the parent of the given child node.
-   */
-  protected _getParent(child: number): number {
-    return Math.floor((child - 1) / 2);
-  }
-
-  /**
-   * The function returns the index of the left child node in a binary tree given the index of its parent node.
-   * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
-   * @returns the left child of a given parent node in a binary tree.
-   */
-  protected _getLeft(parent: number): number {
-    return 2 * parent + 1;
-  }
-
-  /**
-   * The function returns the index of the right child node in a binary tree given the index of its parent node.
-   * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
-   * @returns the right child of a given parent node in a binary tree.
-   */
-  protected _getRight(parent: number): number {
-    return 2 * parent + 2;
-  }
-
-  /**
-   * The function returns the index of the smallest child node of a given parent node.
-   * @param {number} parent - The parent parameter is a number that represents the index of the parent node in a binary
-   * tree.
-   * @returns the minimum value between the parent node and its left and right child nodes.
-   */
-  protected _getComparedChild(parent: number) {
-    let min = parent;
-    const left = this._getLeft(parent),
-      right = this._getRight(parent);
-
-    if (left < this.size && this._compare(min, left)) {
-      min = left;
-    }
-    if (right < this.size && this._compare(min, right)) {
-      min = right;
-    }
-    return min;
-  }
-
-  /**
-   * The function `_heapifyUp` is used to maintain the heap property by moving an element up the heap until it is in the
-   * correct position.
-   * @param {number} start - The start parameter is the index of the element that needs to be moved up in the heap.
-   */
-  protected _heapifyUp(start: number) {
-    while (start > 0 && this._compare(this._getParent(start), start)) {
-      const parent = this._getParent(start);
-      this._swap(start, parent);
-      start = parent;
-    }
-  }
-
-  /**
-   * The function performs a heapify operation by comparing and swapping elements in a binary heap.
-   * @param {number} start - The start parameter is the index of the element in the heap from where the heapifyDown
-   * operation should start.
-   */
-  protected _heapifyDown(start: number) {
-    let min = this._getComparedChild(start);
-    while (this._compare(start, min)) {
-      this._swap(min, start);
-      start = min;
-      min = this._getComparedChild(start);
-    }
-  }
-
-  /**
-   * The _fix function performs a heapify operation on the elements of the heap starting from the middle and moving
-   * towards the root.
-   */
-  protected _fix() {
-    for (let i = Math.floor(this.size / 2); i > -1; i--) this._heapifyDown(i);
-  }
-
-  // --- end additional methods ---
 }

package/src/data-structures/queue/deque.ts

@@ -9,7 +9,8 @@ import {DoublyLinkedList} from '../linked-list';
 
 // O(n) time complexity of obtaining the value
 // O(1) time complexity of adding at the beginning and the end
-export class Deque<E = any> extends DoublyLinkedList<E> {}
+export class Deque<E = any> extends DoublyLinkedList<E> {
+}
 
 // O(1) time complexity of obtaining the value
 // O(n) time complexity of adding at the beginning and the end
@@ -19,43 +20,31 @@ export class ObjectDeque<E = number> {
     if (capacity !== undefined) this._capacity = capacity;
   }
 
-  private _nodes: {[key: number]: E} = {};
+  protected _nodes: { [key: number]: E } = {};
 
-  get nodes(): {[p: number]: E} {
+  get nodes(): { [p: number]: E } {
     return this._nodes;
   }
 
-  private _capacity = Number.MAX_SAFE_INTEGER;
+  protected _capacity = Number.MAX_SAFE_INTEGER;
 
   get capacity(): number {
     return this._capacity;
   }
 
-  set capacity(value: number) {
-    this._capacity = value;
-  }
-
-  private _first = -1;
+  protected _first = -1;
 
   get first(): number {
     return this._first;
   }
 
-  set first(value: number) {
-    this._first = value;
-  }
-
-  private _last = -1;
+  protected _last = -1;
 
   get last(): number {
     return this._last;
   }
 
-  set last(value: number) {
-    this._last = value;
-  }
-
-  private _size = 0;
+  protected _size = 0;
 
   get size(): number {
     return this._size;
@@ -67,14 +56,14 @@ export class ObjectDeque<E = number> {
    * structure.
    */
   addFirst(value: E) {
-    if (this._size === 0) {
-      const mid = Math.floor(this._capacity / 2);
+    if (this.size === 0) {
+      const mid = Math.floor(this.capacity / 2);
       this._first = mid;
       this._last = mid;
     } else {
       this._first--;
     }
-    this._nodes[this._first] = value;
+    this.nodes[this.first] = value;
     this._size++;
   }
 
@@ -83,46 +72,46 @@ export class ObjectDeque<E = number> {
    * @param {E} value - The `value` parameter represents the value that you want to add to the end of the data structure.
    */
   addLast(value: E) {
-    if (this._size === 0) {
-      const mid = Math.floor(this._capacity / 2);
+    if (this.size === 0) {
+      const mid = Math.floor(this.capacity / 2);
       this._first = mid;
       this._last = mid;
     } else {
       this._last++;
     }
-    this._nodes[this._last] = value;
+    this.nodes[this.last] = value;
     this._size++;
   }
 
   /**
-   * The function `pollFirst()` removes and returns the first element in a data structure.
+   * The function `popFirst()` removes and returns the first element in a data structure.
    * @returns The value of the first element in the data structure.
    */
-  pollFirst() {
-    if (!this._size) return;
-    const value = this.peekFirst();
-    delete this._nodes[this._first];
+  popFirst() {
+    if (!this.size) return;
+    const value = this.getFirst();
+    delete this.nodes[this.first];
     this._first++;
     this._size--;
     return value;
   }
 
   /**
-   * The `peekFirst` function returns the first element in an array-like data structure if it exists.
+   * The `getFirst` function returns the first element in an array-like data structure if it exists.
    * @returns The element at the first position of the `_nodes` array.
    */
-  peekFirst() {
-    if (this._size) return this._nodes[this._first];
+  getFirst() {
+    if (this.size) return this.nodes[this.first];
   }
 
   /**
-   * The `pollLast()` function removes and returns the last element in a data structure.
+   * The `popLast()` function removes and returns the last element in a data structure.
    * @returns The value that was removed from the data structure.
    */
-  pollLast() {
-    if (!this._size) return;
-    const value = this.peekLast();
-    delete this._nodes[this._last];
+  popLast() {
+    if (!this.size) return;
+    const value = this.getLast();
+    delete this.nodes[this.last];
     this._last--;
     this._size--;
 
@@ -130,11 +119,11 @@ export class ObjectDeque<E = number> {
   }
 
   /**
-   * The `peekLast()` function returns the last element in an array-like data structure.
+   * The `getLast()` function returns the last element in an array-like data structure.
    * @returns The last element in the array "_nodes" is being returned.
    */
-  peekLast() {
-    if (this._size) return this._nodes[this._last];
+  getLast() {
+    if (this.size) return this.nodes[this.last];
   }
 
   /**
@@ -145,7 +134,7 @@ export class ObjectDeque<E = number> {
    * index, `null` is returned.
    */
   get(index: number) {
-    return this._nodes[this._first + index] || null;
+    return this.nodes[this.first + index] || null;
   }
 
   /**
@@ -153,15 +142,7 @@ export class ObjectDeque<E = number> {
    * @returns The method is returning a boolean value indicating whether the size of the object is less than or equal to 0.
    */
   isEmpty() {
-    return this._size <= 0;
-  }
-
-  protected _seNodes(value: {[p: number]: E}) {
-    this._nodes = value;
-  }
-
-  protected _setSize(value: number) {
-    this._size = value;
+    return this.size <= 0;
   }
 }
 
@@ -170,8 +151,12 @@ export class ObjectDeque<E = number> {
 export class ArrayDeque<E> {
   protected _nodes: E[] = [];
 
+  get nodes(): E[] {
+    return this._nodes;
+  }
+
   get size() {
-    return this._nodes.length;
+    return this.nodes.length;
   }
 
   /**
@@ -184,24 +169,24 @@ export class ArrayDeque<E> {
    * @returns The return value is the new length of the array after the value has been added.
    */
   addLast(value: E) {
-    return this._nodes.push(value);
+    return this.nodes.push(value);
   }
 
   /**
-   * The function "pollLast" returns and removes the last element from an array, or returns null if the array is empty.
-   * @returns The method `pollLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+   * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
+   * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
    */
-  pollLast(): E | null {
-    return this._nodes.pop() ?? null;
+  popLast(): E | null {
+    return this.nodes.pop() ?? null;
   }
 
   /**
-   * The `pollFirst` function removes and returns the first element from an array, or returns null if the array is empty.
-   * @returns The `pollFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
+   * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
+   * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
    * empty.
    */
-  pollFirst(): E | null {
-    return this._nodes.shift() ?? null;
+  popFirst(): E | null {
+    return this.nodes.shift() ?? null;
   }
 
   /**
@@ -215,24 +200,24 @@ export class ArrayDeque<E> {
    * `value` at the beginning.
    */
   addFirst(value: E) {
-    return this._nodes.unshift(value);
+    return this.nodes.unshift(value);
   }
 
   /**
-   * The `peekFirst` function returns the first element of an array or null if the array is empty.
-   * @returns The function `peekFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
+   * The `getFirst` function returns the first element of an array or null if the array is empty.
+   * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
    * empty, it will return `null`.
    */
-  peekFirst(): E | null {
-    return this._nodes[0] ?? null;
+  getFirst(): E | null {
+    return this.nodes[0] ?? null;
   }
 
   /**
-   * The `peekLast` function returns the last element of an array or null if the array is empty.
-   * @returns The method `peekLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
+   * The `getLast` function returns the last element of an array or null if the array is empty.
+   * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
    */
-  peekLast(): E | null {
-    return this._nodes[this._nodes.length - 1] ?? null;
+  getLast(): E | null {
+    return this.nodes[this.nodes.length - 1] ?? null;
   }
 
   /**
@@ -247,7 +232,7 @@ export class ArrayDeque<E> {
    * will be returned. If the element does not exist (i.e., the index is out of bounds), `null` will be returned.
    */
   get(index: number): E | null {
-    return this._nodes[index] ?? null;
+    return this.nodes[index] ?? null;
   }
 
   /**
@@ -259,7 +244,7 @@ export class ArrayDeque<E> {
    * @returns The value that is being set at the specified index in the `_nodes` array.
    */
   set(index: number, value: E) {
-    return (this._nodes[index] = value);
+    return (this.nodes[index] = value);
   }
 
   /**
@@ -273,17 +258,17 @@ export class ArrayDeque<E> {
    * are being removed, an empty array will be returned.
    */
   insert(index: number, value: E) {
-    return this._nodes.splice(index, 0, value);
+    return this.nodes.splice(index, 0, value);
   }
 
   /**
-   * The remove function removes an element from an array at a specified index.
+   * The delete function removes an element from an array at a specified index.
    * @param {number} index - The index parameter specifies the position of the element to be removed from the array. It
    * is a number that represents the index of the element to be removed.
    * @returns The method is returning an array containing the removed element.
    */
-  remove(index: number) {
-    return this._nodes.splice(index, 1);
+  delete(index: number) {
+    return this.nodes.splice(index, 1);
   }
 
   /**
@@ -292,6 +277,6 @@ export class ArrayDeque<E> {
    * is 0, indicating that the array is empty. Otherwise, it returns `false`.
    */
   isEmpty() {
-    return this._nodes.length === 0;
+    return this.nodes.length === 0;
   }
 }