red-black-tree-typed 1.47.3

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

@@ -0,0 +1,2 @@
+export * from './queue';
+export * from './deque';

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

@@ -0,0 +1,308 @@
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+import { SinglyLinkedList } from '../linked-list';
+
+export class LinkedListQueue<E = any> extends SinglyLinkedList<E> {
+  /**
+   * The enqueue function adds a value to the end of an array.
+   * @param {E} value - The value parameter represents the value that you want to add to the queue.
+   */
+  enqueue(value: E) {
+    this.push(value);
+  }
+
+  /**
+   * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+   * @returns The method is returning the element at the front of the queue, or null if the queue is empty.
+   */
+  dequeue(): E | undefined {
+    return this.shift();
+  }
+
+  /**
+   * The `getFirst` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
+   * @returns The `getFirst()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
+   */
+  getFirst(): E | undefined {
+    return this.head?.value;
+  }
+
+  /**
+   * The `peek` function returns the value of the head node in a linked list, or `undefined` if the list is empty.
+   * @returns The `peek()` method is returning the value of the `head` node if it exists, otherwise it returns `undefined`.
+   */
+  peek(): E | undefined {
+    return this.getFirst();
+  }
+}
+
+export class Queue<E = any> {
+  /**
+   * The constructor initializes an instance of a class with an optional array of elements and sets the offset to 0.
+   * @param {E[]} [elements] - The `elements` parameter is an optional array of elements of type `E`. If provided, it
+   * will be used to initialize the `_nodes` property of the class. If not provided, the `_nodes` property will be
+   * initialized as an empty array.
+   */
+  constructor(elements?: E[]) {
+    this._nodes = elements || [];
+    this._offset = 0;
+  }
+
+  protected _nodes: E[];
+
+  get nodes(): E[] {
+    return this._nodes;
+  }
+
+  protected _offset: number;
+
+  get offset(): number {
+    return this._offset;
+  }
+
+  /**
+   * The size function returns the number of elements in an array.
+   * @returns {number} The size of the array, which is the difference between the length of the array and the offset.
+   */
+  get size(): number {
+    return this.nodes.length - this.offset;
+  }
+
+  /**
+   * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
+   * @public
+   * @static
+   * @param {E[]} elements - The "elements" parameter is an array of elements of type E.
+   * @returns The method is returning a new instance of the Queue class, initialized with the elements from the input
+   * array.
+   */
+  static fromArray<E>(elements: E[]): Queue<E> {
+    return new Queue(elements);
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The push function adds an element to the end of the queue and returns the updated queue.Adds an element at the back of the queue.
+   * @param {E} element - The `element` parameter represents the element that you want to add to the queue.
+   * @returns The `add` method is returning a `Queue<E>` object.
+   */
+  push(element: E): Queue<E> {
+    this.nodes.push(element);
+    return this;
+  }
+
+  /**
+   * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
+   * necessary to optimize performance.
+   * @returns The function `shift()` returns either the first element in the queue or `null` if the queue is empty.
+   */
+  shift(): E | undefined {
+    if (this.size === 0) return undefined;
+
+    const first = this.getFirst();
+    this._offset += 1;
+
+    if (this.offset * 2 < this.nodes.length) return first;
+
+    // only delete dequeued elements when reaching half size
+    // to decrease latency of shifting elements.
+    this._nodes = this.nodes.slice(this.offset);
+    this._offset = 0;
+    return first;
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The `getFirst` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
+   * @returns The `getFirst()` method returns the first element of the data structure, represented by the `_nodes` array at
+   * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
+   */
+  getFirst(): E | undefined {
+    return this.size > 0 ? this.nodes[this.offset] : undefined;
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The `peek` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
+   * @returns The `peek()` method returns the first element of the data structure, represented by the `_nodes` array at
+   * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
+   */
+  peek(): E | undefined {
+    return this.getFirst();
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The `getLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+   * @returns The method `getLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+   * array is empty, it returns `null`.
+   */
+  getLast(): E | undefined {
+    return this.size > 0 ? this.nodes[this.nodes.length - 1] : undefined;
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
+   * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
+   * array is empty, it returns `null`.
+   */
+  peekLast(): E | undefined {
+    return this.getLast();
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The enqueue function adds a value to the end of a queue.
+   * @param {E} value - The value parameter represents the value that you want to add to the queue.
+   */
+  enqueue(value: E) {
+    this.push(value);
+  }
+
+  /**
+   * Time Complexity: O(n) - same as shift().
+   * Space Complexity: O(1) - same as shift().
+   */
+
+  /**
+   * Time Complexity: O(n) - same as shift().
+   * Space Complexity: O(1) - same as shift().
+   *
+   * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
+   * @returns The method is returning a value of type E or null.
+   */
+  dequeue(): E | undefined {
+    return this.shift();
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * @param index
+   */
+  getAt(index: number): E | undefined {
+    return this.nodes[index];
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+   * Space Complexity: O(1) - no additional space is used.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+   * Space Complexity: O(1) - no additional space is used.
+   *
+   * The function checks if a data structure is empty by comparing its size to zero.
+   * @returns {boolean} A boolean value indicating whether the size of the object is 0 or not.
+   */
+  isEmpty(): boolean {
+    return this.size === 0;
+  }
+
+  /**
+   * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
+   * Space Complexity: O(n) - where n is the number of elements in the queue.
+   */
+
+  /**
+   * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
+   * Space Complexity: O(n) - where n is the number of elements in the queue.
+   *
+   * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
+   * @returns An array of type E is being returned.
+   */
+  toArray(): E[] {
+    return this.nodes.slice(this.offset);
+  }
+
+  /**
+   * The clear function resets the nodes array and offset to their initial values.
+   */
+  clear(): void {
+    this._nodes = [];
+    this._offset = 0;
+  }
+
+  /**
+   * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
+   * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+   */
+
+  /**
+   * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
+   * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+   *
+   * The `clone()` function returns a new Queue object with the same elements as the original Queue.
+   * @returns The `clone()` method is returning a new instance of the `Queue` class.
+   */
+  clone(): Queue<E> {
+    return new Queue(this.nodes.slice(this.offset));
+  }
+
+  * [Symbol.iterator]() {
+    for (const item of this.nodes) {
+      yield item;
+    }
+  }
+}

package/src/data-structures/stack/index.ts

@@ -0,0 +1 @@
+export * from './stack';

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

@@ -0,0 +1,150 @@
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+export class Stack<E = any> {
+  /**
+   * The constructor initializes an array of elements, which can be provided as an optional parameter.
+   * @param {E[]} [elements] - The `elements` parameter is an optional parameter of type `E[]`, which represents an array
+   * of elements of type `E`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
+   * is provided and is an array, it is assigned to the `_elements
+   */
+  constructor(elements?: E[]) {
+    this._elements = Array.isArray(elements) ? elements : [];
+  }
+
+  protected _elements: E[];
+
+  get elements(): E[] {
+    return this._elements;
+  }
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the input array. Similar to the constructor, it requires iterating through each element.
+   * Space Complexity: O(n), as it creates a new stack with the elements from the input array.
+   */
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the input array. Similar to the constructor, it requires iterating through each element.
+   * Space Complexity: O(n), as it creates a new stack with the elements from the input array.
+   *
+   * The function "fromArray" creates a new Stack object from an array of elements.
+   * @param {E[]} elements - The `elements` parameter is an array of elements of type `E`.
+   * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
+   * array.
+   */
+  static fromArray<E>(elements: E[]): Stack<E> {
+    return new Stack(elements);
+  }
+
+  /**
+   * The function checks if an array is empty and returns a boolean value.
+   * @returns A boolean value indicating whether the `_elements` array is empty or not.
+   */
+  isEmpty(): boolean {
+    return this.elements.length === 0;
+  }
+
+  /**
+   * The size() function returns the number of elements in an array.
+   * @returns The size of the elements array.
+   */
+  size(): number {
+    return this.elements.length;
+  }
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
+   * The `peek` function returns the last element of an array, or null if the array is empty.
+   * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
+   */
+  peek(): E | null {
+    if (this.isEmpty()) return null;
+
+    return this.elements[this.elements.length - 1];
+  }
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
+   * The push function adds an element to the stack and returns the updated stack.
+   * @param {E} element - The parameter "element" is of type E, which means it can be any data type.
+   * @returns The `push` method is returning the updated `Stack<E>` object.
+   */
+  push(element: E): Stack<E> {
+    this.elements.push(element);
+    return this;
+  }
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
+   * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
+   * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
+   * array is empty, it returns `null`.
+   */
+  pop(): E | null {
+    if (this.isEmpty()) return null;
+
+    return this.elements.pop() || null;
+  }
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The toArray function returns a copy of the elements in an array.
+   * @returns An array of type E.
+   */
+  toArray(): E[] {
+    return this.elements.slice();
+  }
+
+  /**
+   * The clear function clears the elements array.
+   */
+  clear(): void {
+    this._elements = [];
+  }
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the stack, as it creates a new stack and copies all elements into it.
+   * Space Complexity: O(n), as it creates a new stack.
+   */
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the stack, as it creates a new stack and copies all elements into it.
+   * Space Complexity: O(n), as it creates a new stack.
+   *
+   * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
+   * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
+   */
+  clone(): Stack<E> {
+    return new Stack(this.elements.slice());
+  }
+}

package/src/data-structures/tree/index.ts

@@ -0,0 +1 @@
+export * from './tree';

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

@@ -0,0 +1,41 @@
+export class TreeNode<V = any> {
+  key: string;
+  value?: V | undefined;
+  children?: TreeNode<V>[] | undefined;
+
+  constructor(key: string, value?: V, children?: TreeNode<V>[]) {
+    this.key = key;
+    this.value = value || undefined;
+    this.children = children || [];
+  }
+
+  addChildren(children: TreeNode<V> | TreeNode<V>[]) {
+    if (!this.children) {
+      this.children = [];
+    }
+    if (children instanceof TreeNode) {
+      this.children.push(children);
+    } else {
+      this.children = this.children.concat(children);
+    }
+  }
+
+  getHeight() {
+    let maxDepth = 0;
+    if (this) {
+      const bfs = (node: TreeNode<V>, level: number) => {
+        if (level > maxDepth) {
+          maxDepth = level;
+        }
+        const { children } = node;
+        if (children) {
+          for (let i = 0, len = children.length; i < len; i++) {
+            bfs(children[i], level + 1);
+          }
+        }
+      };
+      bfs(this, 0);
+    }
+    return maxDepth;
+  }
+}

package/src/data-structures/trie/index.ts

@@ -0,0 +1 @@
+export * from './trie';