data-structure-typed 1.31.0 → 1.32.1

package/src/data-structures/graph/undirected-graph.ts

@@ -0,0 +1,274 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import {arrayRemove} from '../../utils';
+import {AbstractEdge, AbstractGraph, AbstractVertex} from './abstract-graph';
+import type {VertexId} from '../../types';
+import {IUNDirectedGraph} from '../../interfaces';
+
+export class UndirectedVertex<T = number> extends AbstractVertex<T> {
+  /**
+   * The constructor function initializes a vertex with an optional value.
+   * @param {VertexId} id - The `id` parameter is of type `VertexId` and represents the identifier of the vertex. It is
+   * used to uniquely identify the vertex within a graph or network.
+   * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to initialize the value of the
+   * vertex. If no value is provided, the vertex will be initialized with a default value.
+   */
+  constructor(id: VertexId, val?: T) {
+    super(id, val);
+  }
+}
+
+export class UndirectedEdge<T = number> extends AbstractEdge<T> {
+  /**
+   * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
+   * value.
+   * @param {VertexId} v1 - The first vertex ID of the edge.
+   * @param {VertexId} v2 - The parameter `v2` is a `VertexId`, which represents the identifier of the second vertex in a
+   * graph edge.
+   * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
+   * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to store a value associated
+   * with the edge.
+   */
+  constructor(v1: VertexId, v2: VertexId, weight?: number, val?: T) {
+    super(weight, val);
+    this._vertices = [v1, v2];
+  }
+
+  private _vertices: [VertexId, VertexId];
+
+  get vertices() {
+    return this._vertices;
+  }
+
+  set vertices(v: [VertexId, VertexId]) {
+    this._vertices = v;
+  }
+}
+
+export class UndirectedGraph<
+    V extends UndirectedVertex<any> = UndirectedVertex,
+    E extends UndirectedEdge<any> = UndirectedEdge
+  >
+  extends AbstractGraph<V, E>
+  implements IUNDirectedGraph<V, E>
+{
+  /**
+   * The constructor initializes a new Map object to store edges.
+   */
+  constructor() {
+    super();
+    this._edges = new Map<V, E[]>();
+  }
+
+  protected _edges: Map<V, E[]>;
+
+  get edges(): Map<V, E[]> {
+    return this._edges;
+  }
+
+  /**
+   * The function creates a new vertex with an optional value and returns it.
+   * @param {VertexId} id - The `id` parameter is the unique identifier for the vertex. It is used to distinguish one
+   * vertex from another in the graph.
+   * @param [val] - The `val` parameter is an optional value that can be assigned to the vertex. If a value is provided,
+   * it will be used as the value of the vertex. If no value is provided, the `id` parameter will be used as the value of
+   * the vertex.
+   * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `V`.
+   */
+  override createVertex(id: VertexId, val?: V['val']): V {
+    return new UndirectedVertex(id, val ?? id) as V;
+  }
+
+  /**
+   * The function creates an undirected edge between two vertices with an optional weight and value.
+   * @param {VertexId} v1 - The parameter `v1` represents the first vertex of the edge.
+   * @param {VertexId} v2 - The parameter `v2` represents the second vertex of the edge.
+   * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. If
+   * no weight is provided, it defaults to 1.
+   * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and
+   * is used to store additional information or data associated with the edge.
+   * @returns a new instance of the `UndirectedEdge` class, which is casted as type `E`.
+   */
+  override createEdge(v1: VertexId, v2: VertexId, weight?: number, val?: E['val']): E {
+    return new UndirectedEdge(v1, v2, weight ?? 1, val) as E;
+  }
+
+  /**
+   * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
+   * @param {V | null | VertexId} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
+   * object), `null`, or `VertexId` (a string or number representing the ID of a vertex).
+   * @param {V | null | VertexId} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+   * object), `null`, or `VertexId` (vertex ID).
+   * @returns an edge (E) or null.
+   */
+  getEdge(v1: V | null | VertexId, v2: V | null | VertexId): E | null {
+    let edges: E[] | undefined = [];
+
+    if (v1 !== null && v2 !== null) {
+      const vertex1: V | null = this._getVertex(v1);
+      const vertex2: V | null = this._getVertex(v2);
+
+      if (vertex1 && vertex2) {
+        edges = this._edges.get(vertex1)?.filter(e => e.vertices.includes(vertex2.id));
+      }
+    }
+
+    return edges ? edges[0] || null : null;
+  }
+
+  /**
+   * The function removes an edge between two vertices in a graph and returns the removed edge.
+   * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
+   * @param {V | VertexId} v2 - V | VertexId - This parameter can be either a vertex object (V) or a vertex ID
+   * (VertexId). It represents the second vertex of the edge that needs to be removed.
+   * @returns the removed edge (E) if it exists, or null if either of the vertices (V) does not exist.
+   */
+  removeEdgeBetween(v1: V | VertexId, v2: V | VertexId): E | null {
+    const vertex1: V | null = this._getVertex(v1);
+    const vertex2: V | null = this._getVertex(v2);
+
+    if (!vertex1 || !vertex2) {
+      return null;
+    }
+
+    const v1Edges = this._edges.get(vertex1);
+    let removed: E | null = null;
+    if (v1Edges) {
+      removed = arrayRemove<E>(v1Edges, (e: E) => e.vertices.includes(vertex2.id))[0] || null;
+    }
+    const v2Edges = this._edges.get(vertex2);
+    if (v2Edges) {
+      arrayRemove<E>(v2Edges, (e: E) => e.vertices.includes(vertex1.id));
+    }
+    return removed;
+  }
+
+  /**
+   * The removeEdge function removes an edge between two vertices in a graph.
+   * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+   * @returns The method is returning either the removed edge (of type E) or null if the edge was not found.
+   */
+  removeEdge(edge: E): E | null {
+    return this.removeEdgeBetween(edge.vertices[0], edge.vertices[1]);
+  }
+
+  /**
+   * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
+   * vertex.
+   * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
+   * @returns The function `degreeOf` returns the degree of a vertex in a graph. The degree of a vertex is the number of
+   * edges connected to that vertex.
+   */
+  degreeOf(vertexOrId: VertexId | V): number {
+    const vertex = this._getVertex(vertexOrId);
+    if (vertex) {
+      return this._edges.get(vertex)?.length || 0;
+    } else {
+      return 0;
+    }
+  }
+
+  /**
+   * The function returns the edges of a given vertex or vertex ID.
+   * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`. A `VertexId` is a
+   * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
+   * @returns an array of edges.
+   */
+  edgesOf(vertexOrId: VertexId | V): E[] {
+    const vertex = this._getVertex(vertexOrId);
+    if (vertex) {
+      return this._edges.get(vertex) || [];
+    } else {
+      return [];
+    }
+  }
+
+  /**
+   * The function "edgeSet" returns an array of unique edges from a set of edges.
+   * @returns The method `edgeSet()` returns an array of type `E[]`.
+   */
+  edgeSet(): E[] {
+    const edgeSet: Set<E> = new Set();
+    this._edges.forEach(edges => {
+      edges.forEach(edge => {
+        edgeSet.add(edge);
+      });
+    });
+    return [...edgeSet];
+  }
+
+  /**
+   * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
+   * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
+   * (`VertexId`).
+   * @returns an array of vertices (V[]).
+   */
+  getNeighbors(vertexOrId: V | VertexId): V[] {
+    const neighbors: V[] = [];
+    const vertex = this._getVertex(vertexOrId);
+    if (vertex) {
+      const neighborEdges = this.edgesOf(vertex);
+      for (const edge of neighborEdges) {
+        const neighbor = this._getVertex(edge.vertices.filter(e => e !== vertex.id)[0]);
+        if (neighbor) {
+          neighbors.push(neighbor);
+        }
+      }
+    }
+    return neighbors;
+  }
+
+  /**
+   * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
+   * it returns null.
+   * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+   * @returns The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
+   * graph. If the edge does not exist, it returns `null`.
+   */
+  getEndsOfEdge(edge: E): [V, V] | null {
+    if (!this.hasEdge(edge.vertices[0], edge.vertices[1])) {
+      return null;
+    }
+    const v1 = this._getVertex(edge.vertices[0]);
+    const v2 = this._getVertex(edge.vertices[1]);
+    if (v1 && v2) {
+      return [v1, v2];
+    } else {
+      return null;
+    }
+  }
+
+  /**
+   * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
+   * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
+   * @returns a boolean value.
+   */
+  protected _addEdgeOnly(edge: E): boolean {
+    for (const end of edge.vertices) {
+      const endVertex = this._getVertex(end);
+      if (endVertex === null) return false;
+      if (endVertex) {
+        const edges = this._edges.get(endVertex);
+        if (edges) {
+          edges.push(edge);
+        } else {
+          this._edges.set(endVertex, [edge]);
+        }
+      }
+    }
+    return true;
+  }
+
+  /**
+   * The function sets the edges of a graph.
+   * @param v - A map where the keys are of type V and the values are arrays of type E.
+   */
+  protected _setEdges(v: Map<V, E[]>) {
+    this._edges = v;
+  }
+}

package/src/data-structures/hash/coordinate-map.ts

@@ -0,0 +1,67 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export class CoordinateMap<V> extends Map<any, V> {
+  constructor(joint?: string) {
+    super();
+    if (joint !== undefined) this._joint = joint;
+  }
+
+  protected _joint = '_';
+
+  get joint(): string {
+    return this._joint;
+  }
+
+  /**
+   * The "has" function overrides the base class's "has" function and checks if a key exists in the map by joining the
+   * key array with a specified delimiter.
+   * @param {number[]} key - The parameter "key" is an array of numbers.
+   * @returns The `has` method is being overridden to return the result of calling the `has` method of the superclass
+   * (`super.has`) with the `key` array joined together using the `_joint` property.
+   */
+  override has(key: number[]) {
+    return super.has(key.join(this._joint));
+  }
+
+  /**
+   * The function overrides the set method of a Map object to convert the key from an array to a string using a specified
+   * delimiter before calling the original set method.
+   * @param {number[]} key - The key parameter is an array of numbers.
+   * @param {V} value - The value parameter is the value that you want to associate with the specified key.
+   * @returns The `set` method is returning the result of calling the `set` method of the superclass
+   * (`super.set(key.join(this._joint), value)`).
+   */
+  override set(key: number[], value: V) {
+    return super.set(key.join(this._joint), value);
+  }
+
+  /**
+   * The function overrides the get method to join the key array with a specified joint and then calls the super get
+   * method.
+   * @param {number[]} key - An array of numbers
+   * @returns The code is returning the value associated with the specified key in the map.
+   */
+  override get(key: number[]) {
+    return super.get(key.join(this._joint));
+  }
+
+  /**
+   * The function overrides the delete method and joins the key array using a specified joint character before calling
+   * the super delete method.
+   * @param {number[]} key - An array of numbers that represents the key to be deleted.
+   * @returns The `delete` method is returning the result of calling the `delete` method on the superclass, with the
+   * `key` array joined together using the `_joint` property.
+   */
+  override delete(key: number[]) {
+    return super.delete(key.join(this._joint));
+  }
+
+  protected _setJoint(v: string) {
+    this._joint = v;
+  }
+}

package/src/data-structures/hash/coordinate-set.ts

@@ -0,0 +1,56 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export class CoordinateSet extends Set<any> {
+  constructor(joint?: string) {
+    super();
+    if (joint !== undefined) this._joint = joint;
+  }
+
+  protected _joint = '_';
+
+  get joint(): string {
+    return this._joint;
+  }
+
+  /**
+   * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
+   * joining its elements with a specified separator.
+   * @param {number[]} value - The parameter "value" is an array of numbers.
+   * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
+   * in the joined value as an argument.
+   */
+  override has(value: number[]) {
+    return super.has(value.join(this._joint));
+  }
+
+  /**
+   * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
+   * specified delimiter before calling the parent class's "add" function.
+   * @param {number[]} value - An array of numbers
+   * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
+   * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
+   */
+  override add(value: number[]) {
+    return super.add(value.join(this._joint));
+  }
+
+  /**
+   * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
+   * array with a specified joint and then calling the delete method of the parent class.
+   * @param {number[]} value - An array of numbers
+   * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
+   * `value` array joined together using the `_joint` property.
+   */
+  override delete(value: number[]) {
+    return super.delete(value.join(this._joint));
+  }
+
+  protected _setJoint(v: string) {
+    this._joint = v;
+  }
+}

package/src/data-structures/hash/hash-table.ts

@@ -0,0 +1 @@
+export class HashTable {}

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

@@ -0,0 +1,6 @@
+export * from './hash-table';
+export * from './coordinate-map';
+export * from './coordinate-set';
+export * from './pair';
+export * from './tree-map';
+export * from './tree-set';

package/src/data-structures/hash/pair.ts

@@ -0,0 +1 @@
+export class Pair {}

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

@@ -0,0 +1 @@
+export class TreeMap {}

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

@@ -0,0 +1 @@
+export class TreeSet {}

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

@@ -0,0 +1,212 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import {PriorityQueue} from '../priority-queue';
+import type {HeapOptions} from '../../types';
+
+export class HeapItem<T = number> {
+  /**
+   * 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 {T | null} [val=null] - The `val` parameter is of type `T | null`, which means it can accept a value of type
+   * `T` or `null`.
+   */
+  constructor(priority: number = Number.MAX_SAFE_INTEGER, val: T | null = null) {
+    this._val = val;
+    this._priority = priority;
+  }
+
+  private _priority: number;
+
+  get priority(): number {
+    return this._priority;
+  }
+
+  set priority(value: number) {
+    this._priority = value;
+  }
+
+  private _val: T | null;
+
+  get val(): T | null {
+    return this._val;
+  }
+
+  set val(value: T | null) {
+    this._val = value;
+  }
+}
+
+export abstract class Heap<T = number> {
+  /**
+   * 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.
+   */
+  protected constructor(options?: HeapOptions<T>) {
+    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;
+    }
+  }
+
+  protected abstract _pq: PriorityQueue<HeapItem<T>>;
+
+  get pq() {
+    return this._pq;
+  }
+
+  protected _priorityExtractor: (val: T) => number;
+  get priorityExtractor() {
+    return this._priorityExtractor;
+  }
+
+  /**
+   * The function returns the size of a priority queue.
+   * @returns The size of the priority queue.
+   */
+  get size(): number {
+    return this._pq.size;
+  }
+
+  /**
+   * 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.
+   */
+  isEmpty(): boolean {
+    return this._pq.size < 1;
+  }
+
+  peek(isItem?: undefined): T | undefined;
+  peek(isItem: false): T | undefined;
+  peek(isItem: true): HeapItem<T> | null;
+
+  /**
+   * The `peek` function returns the top item in the priority queue without removing it.
+   * @returns The `peek()` method is returning either a `HeapItem<T>` object or `null`.Returns an val with the highest priority in the queue
+   */
+  peek(isItem?: boolean): HeapItem<T> | null | T | undefined {
+    isItem = isItem ?? false;
+    const peeked = this._pq.peek();
+
+    return isItem ? peeked : peeked?.val;
+  }
+
+  peekLast(isItem?: undefined): T | undefined;
+  peekLast(isItem: false): T | undefined;
+  peekLast(isItem: true): HeapItem<T> | null;
+
+  /**
+   * The `peekLast` function returns the last item in the heap.
+   * @returns The method `peekLast()` returns either a `HeapItem<T>` object or `null`.Returns an val with the lowest priority in the queue
+   */
+  peekLast(isItem?: boolean): HeapItem<T> | null | T | undefined {
+    isItem = isItem ?? false;
+    const leafItem = this._pq.leaf();
+
+    return isItem ? leafItem : leafItem?.val;
+  }
+
+  /**
+   * The `add` function adds an val to a priority queue with an optional priority value.
+   * @param {T} 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
+   */
+  add(priority: number, val?: T): Heap<T> {
+    val = val === undefined ? (priority as unknown as T) : val;
+    this._pq.add(new HeapItem<T>(priority, val));
+
+    return this;
+  }
+
+  poll(isItem?: undefined): T | undefined;
+  poll(isItem: false): T | undefined;
+  poll(isItem: true): HeapItem<T> | null;
+
+  /**
+   * 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<T> object or null.
+   */
+  poll(isItem?: boolean): HeapItem<T> | null | T | undefined {
+    isItem = isItem ?? false;
+    const top = this._pq.poll();
+    if (!top) {
+      return null;
+    }
+
+    return isItem ? top : top.val;
+  }
+
+  /**
+   * The function checks if a given node or value exists in the priority queue.
+   * @param {T | HeapItem<T>} node - The parameter `node` can be of type `T` or `HeapItem<T>`.
+   * @returns a boolean value.
+   */
+  has(node: T | HeapItem<T>): boolean {
+    if (node instanceof HeapItem) {
+      return this.pq.getNodes().includes(node);
+    } else {
+      return (
+        this.pq.getNodes().findIndex(item => {
+          return item.val === node;
+        }) !== -1
+      );
+    }
+  }
+
+  toArray(isItem?: undefined): (T | undefined)[];
+  toArray(isItem: false): (T | undefined)[];
+  toArray(isItem: true): (HeapItem<T> | null)[];
+
+  /**
+   * The `toArray` function returns an array of `HeapItem<T>` objects.
+   * @returns An array of HeapItem<T> objects.Returns a sorted list of vals
+   */
+  toArray(isItem?: boolean): (HeapItem<T> | null | T | undefined)[] {
+    isItem = isItem ?? false;
+    const itemArray = this._pq.toArray();
+
+    return isItem ? itemArray : itemArray.map(item => item.val);
+  }
+
+  sort(isItem?: undefined): (T | undefined)[];
+  sort(isItem: false): (T | undefined)[];
+  sort(isItem: true): (HeapItem<T> | null)[];
+
+  /**
+   * 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<T>` objects or an array of the values (`T`) of those objects. If `isItem` is `true`, the
+   * sorted result will be an array of `HeapItem
+   * @returns an array of either `HeapItem<T>`, `null`, `T`, or `undefined` values.
+   */
+  sort(isItem?: boolean): (HeapItem<T> | null | T | undefined)[] {
+    isItem = isItem ?? false;
+    const sorted = this._pq.sort();
+
+    return isItem ? sorted : sorted.map(item => item.val);
+  }
+
+  /**
+   * The clear function clears the priority queue.
+   */
+  clear(): void {
+    this._pq.clear();
+  }
+}

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

@@ -0,0 +1,3 @@
+export * from './max-heap';
+export * from './min-heap';
+export * from './heap';

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

@@ -0,0 +1,31 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+
+import {Heap, HeapItem} from './heap';
+import {PriorityQueue} from '../priority-queue';
+import type {HeapOptions} from '../../types';
+
+/**
+ * @class MaxHeap
+ * @extends Heap
+ */
+export class MaxHeap<T = number> extends Heap<T> {
+  protected _pq: PriorityQueue<HeapItem<T>>;
+
+  /**
+   * The constructor initializes a PriorityQueue with a custom comparator function.
+   * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
+   * type `HeapOptions<T>`, which is a generic type that represents the options for the heap.
+   */
+  constructor(options?: HeapOptions<T>) {
+    super(options);
+    this._pq = new PriorityQueue<HeapItem<T>>({
+      comparator: (a, b) => b.priority - a.priority
+    });
+  }
+}