min-heap-typed 1.39.4 → 1.39.6

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

@@ -15,15 +15,15 @@ export class UndirectedVertex<V = any> extends AbstractVertex<V> {
    * The constructor function initializes a vertex with an optional value.
    * @param {VertexKey} key - The `key` parameter is of type `VertexKey` and represents the identifier of the vertex. It is
    * used to uniquely identify the vertex within a graph or network.
-   * @param {V} [val] - The "val" parameter is an optional parameter of type V. It is used to initialize the value of the
+   * @param {V} [value] - The "value" parameter is an optional parameter of type V. 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(key: VertexKey, val?: V) {
-    super(key, val);
+  constructor(key: VertexKey, value?: V) {
+    super(key, value);
   }
 }
 
-export class UndirectedEdge<V = number> extends AbstractEdge<V> {
+export class UndirectedEdge<E = number> extends AbstractEdge<E> {
   /**
    * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
    * value.
@@ -31,11 +31,11 @@ export class UndirectedEdge<V = number> extends AbstractEdge<V> {
    * @param {VertexKey} v2 - The parameter `v2` is a `VertexKey`, 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 {V} [val] - The "val" parameter is an optional parameter of type V. It is used to store a value associated
+   * @param {E} [value] - The "value" parameter is an optional parameter of type E. It is used to store a value associated
    * with the edge.
    */
-  constructor(v1: VertexKey, v2: VertexKey, weight?: number, val?: V) {
-    super(weight, val);
+  constructor(v1: VertexKey, v2: VertexKey, weight?: number, value?: E) {
+    super(weight, value);
     this._vertices = [v1, v2];
   }
 
@@ -51,23 +51,25 @@ export class UndirectedEdge<V = number> extends AbstractEdge<V> {
 }
 
 export class UndirectedGraph<
-    V extends UndirectedVertex<any> = UndirectedVertex,
-    E extends UndirectedEdge<any> = UndirectedEdge
+    V = any,
+    E = any,
+    VO extends UndirectedVertex<V> = UndirectedVertex<V>,
+    EO extends UndirectedEdge<E> = UndirectedEdge<E>
   >
-  extends AbstractGraph<V, E>
-  implements IGraph<V, E>
+  extends AbstractGraph<V, E, VO, EO>
+  implements IGraph<V, E, VO, EO>
 {
   /**
    * The constructor initializes a new Map object to store edges.
    */
   constructor() {
     super();
-    this._edges = new Map<V, E[]>();
+    this._edges = new Map<VO, EO[]>();
   }
 
-  protected _edges: Map<V, E[]>;
+  protected _edges: Map<VO, EO[]>;
 
-  get edges(): Map<V, E[]> {
+  get edges(): Map<VO, EO[]> {
     return this._edges;
   }
 
@@ -75,13 +77,13 @@ export class UndirectedGraph<
    * The function creates a new vertex with an optional value and returns it.
    * @param {VertexKey} key - The `key` 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,
+   * @param [value] - The `value` 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 `key` 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`.
+   * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `VO`.
    */
-  override createVertex(key: VertexKey, val?: V['val']): V {
-    return new UndirectedVertex(key, val ?? key) as V;
+  override createVertex(key: VertexKey, value?: VO['value']): VO {
+    return new UndirectedVertex(key, value ?? key) as VO;
   }
 
   /**
@@ -90,28 +92,28 @@ export class UndirectedGraph<
    * @param {VertexKey} 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
+   * @param [value] - The `value` 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`.
+   * @returns a new instance of the `UndirectedEdge` class, which is casted as type `EO`.
    */
-  override createEdge(v1: VertexKey, v2: VertexKey, weight?: number, val?: E['val']): E {
-    return new UndirectedEdge(v1, v2, weight ?? 1, val) as E;
+  override createEdge(v1: VertexKey, v2: VertexKey, weight?: number, value?: EO['value']): EO {
+    return new UndirectedEdge(v1, v2, weight ?? 1, value) as EO;
   }
 
   /**
    * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
-   * @param {V | null | VertexKey} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
+   * @param {VO | VertexKey | null} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `VO` (vertex
    * object), `null`, or `VertexKey` (a string or number representing the ID of a vertex).
-   * @param {V | null | VertexKey} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
+   * @param {VO | VertexKey | null} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `VO` (vertex
    * object), `null`, or `VertexKey` (vertex ID).
-   * @returns an edge (E) or null.
+   * @returns an edge (EO) or null.
    */
-  getEdge(v1: V | null | VertexKey, v2: V | null | VertexKey): E | null {
-    let edges: E[] | undefined = [];
+  getEdge(v1: VO | VertexKey | null, v2: VO | VertexKey | null): EO | null {
+    let edges: EO[] | undefined = [];
 
     if (v1 !== null && v2 !== null) {
-      const vertex1: V | null = this._getVertex(v1);
-      const vertex2: V | null = this._getVertex(v2);
+      const vertex1: VO | null = this._getVertex(v1);
+      const vertex2: VO | null = this._getVertex(v2);
 
       if (vertex1 && vertex2) {
         edges = this._edges.get(vertex1)?.filter(e => e.vertices.includes(vertex2.key));
@@ -123,48 +125,48 @@ export class UndirectedGraph<
 
   /**
    * The function removes an edge between two vertices in a graph and returns the removed edge.
-   * @param {V | VertexKey} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexKey`).
-   * @param {V | VertexKey} v2 - V | VertexKey - This parameter can be either a vertex object (V) or a vertex ID
+   * @param {VO | VertexKey} v1 - The parameter `v1` represents either a vertex object (`VO`) or a vertex ID (`VertexKey`).
+   * @param {VO | VertexKey} v2 - VO | VertexKey - This parameter can be either a vertex object (VO) or a vertex ID
    * (VertexKey). 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.
+   * @returns the removed edge (EO) if it exists, or null if either of the vertices (VO) does not exist.
    */
-  deleteEdgeBetween(v1: V | VertexKey, v2: V | VertexKey): E | null {
-    const vertex1: V | null = this._getVertex(v1);
-    const vertex2: V | null = this._getVertex(v2);
+  deleteEdgeBetween(v1: VO | VertexKey, v2: VO | VertexKey): EO | null {
+    const vertex1: VO | null = this._getVertex(v1);
+    const vertex2: VO | null = this._getVertex(v2);
 
     if (!vertex1 || !vertex2) {
       return null;
     }
 
     const v1Edges = this._edges.get(vertex1);
-    let removed: E | null = null;
+    let removed: EO | null = null;
     if (v1Edges) {
-      removed = arrayRemove<E>(v1Edges, (e: E) => e.vertices.includes(vertex2.key))[0] || null;
+      removed = arrayRemove<EO>(v1Edges, (e: EO) => e.vertices.includes(vertex2.key))[0] || null;
     }
     const v2Edges = this._edges.get(vertex2);
     if (v2Edges) {
-      arrayRemove<E>(v2Edges, (e: E) => e.vertices.includes(vertex1.key));
+      arrayRemove<EO>(v2Edges, (e: EO) => e.vertices.includes(vertex1.key));
     }
     return removed;
   }
 
   /**
    * The deleteEdge 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.
+   * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
+   * @returns The method is returning either the removed edge (of type EO) or null if the edge was not found.
    */
-  deleteEdge(edge: E): E | null {
+  deleteEdge(edge: EO): EO | null {
     return this.deleteEdgeBetween(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 {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`.
+   * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`.
    * @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(vertexOrKey: VertexKey | V): number {
+  degreeOf(vertexOrKey: VertexKey | VO): number {
     const vertex = this._getVertex(vertexOrKey);
     if (vertex) {
       return this._edges.get(vertex)?.length || 0;
@@ -175,11 +177,11 @@ export class UndirectedGraph<
 
   /**
    * The function returns the edges of a given vertex or vertex ID.
-   * @param {VertexKey | V} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `V`. A `VertexKey` is a
-   * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
+   * @param {VertexKey | VO} vertexOrKey - The parameter `vertexOrKey` can be either a `VertexKey` or a `VO`. A `VertexKey` is a
+   * unique identifier for a vertex in a graph, while `VO` represents the type of the vertex.
    * @returns an array of edges.
    */
-  edgesOf(vertexOrKey: VertexKey | V): E[] {
+  edgesOf(vertexOrKey: VertexKey | VO): EO[] {
     const vertex = this._getVertex(vertexOrKey);
     if (vertex) {
       return this._edges.get(vertex) || [];
@@ -190,10 +192,10 @@ export class UndirectedGraph<
 
   /**
    * The function "edgeSet" returns an array of unique edges from a set of edges.
-   * @returns The method `edgeSet()` returns an array of type `E[]`.
+   * @returns The method `edgeSet()` returns an array of type `EO[]`.
    */
-  edgeSet(): E[] {
-    const edgeSet: Set<E> = new Set();
+  edgeSet(): EO[] {
+    const edgeSet: Set<EO> = new Set();
     this._edges.forEach(edges => {
       edges.forEach(edge => {
         edgeSet.add(edge);
@@ -204,12 +206,12 @@ export class UndirectedGraph<
 
   /**
    * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
-   * @param {V | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`V`) or a vertex ID
+   * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
    * (`VertexKey`).
-   * @returns an array of vertices (V[]).
+   * @returns an array of vertices (VO[]).
    */
-  getNeighbors(vertexOrKey: V | VertexKey): V[] {
-    const neighbors: V[] = [];
+  getNeighbors(vertexOrKey: VO | VertexKey): VO[] {
+    const neighbors: VO[] = [];
     const vertex = this._getVertex(vertexOrKey);
     if (vertex) {
       const neighborEdges = this.edgesOf(vertex);
@@ -226,11 +228,11 @@ export class UndirectedGraph<
   /**
    * 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
+   * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
+   * @returns The function `getEndsOfEdge` returns an array containing two vertices `[VO, VO]` if the edge exists in the
    * graph. If the edge does not exist, it returns `null`.
    */
-  getEndsOfEdge(edge: E): [V, V] | null {
+  getEndsOfEdge(edge: EO): [VO, VO] | null {
     if (!this.hasEdge(edge.vertices[0], edge.vertices[1])) {
       return null;
     }
@@ -245,10 +247,10 @@ export class UndirectedGraph<
 
   /**
    * 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.
+   * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
    * @returns a boolean value.
    */
-  protected _addEdgeOnly(edge: E): boolean {
+  protected _addEdgeOnly(edge: EO): boolean {
     for (const end of edge.vertices) {
       const endVertex = this._getVertex(end);
       if (endVertex === null) return false;
@@ -266,9 +268,9 @@ export class UndirectedGraph<
 
   /**
    * 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.
+   * @param v - A map where the keys are of type VO and the values are arrays of type EO.
    */
-  protected _setEdges(v: Map<V, E[]>) {
+  protected _setEdges(v: Map<VO, EO[]>) {
     this._edges = v;
   }
 }

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

@@ -8,12 +8,12 @@
 
 export class HashTableNode<K, V> {
   key: K;
-  val: V;
+  value: V;
   next: HashTableNode<K, V> | null;
 
-  constructor(key: K, val: V) {
+  constructor(key: K, value: V) {
     this.key = key;
-    this.val = val;
+    this.value = value;
     this.next = null;
   }
 }
@@ -71,14 +71,14 @@ export class HashTable<K, V> {
    * The set function adds a key-value pair to the hash table, handling collisions and resizing if necessary.
    * @param {K} key - The key parameter represents the key of the key-value pair that you want to insert into the hash
    * table. It is of type K, which is a generic type representing the key's data type.
-   * @param {V} val - The parameter `val` represents the value that you want to associate with the given key in the hash
+   * @param {V} value - The parameter `value` represents the value that you want to associate with the given key in the hash
    * table.
    * @returns Nothing is being returned. The return type of the `put` method is `void`, which means it does not return any
    * value.
    */
-  set(key: K, val: V): void {
+  set(key: K, value: V): void {
     const index = this._hash(key);
-    const newNode = new HashTableNode<K, V>(key, val);
+    const newNode = new HashTableNode<K, V>(key, value);
 
     if (!this._buckets[index]) {
       this._buckets[index] = newNode;
@@ -88,7 +88,7 @@ export class HashTable<K, V> {
       while (currentNode) {
         if (currentNode.key === key) {
           // If the key already exists, update the value
-          currentNode.val = val;
+          currentNode.value = value;
           return;
         }
         if (!currentNode.next) {
@@ -120,7 +120,7 @@ export class HashTable<K, V> {
 
     while (currentNode) {
       if (currentNode.key === key) {
-        return currentNode.val;
+        return currentNode.value;
       }
       currentNode = currentNode.next;
     }
@@ -259,7 +259,7 @@ export class HashTable<K, V> {
       let currentNode = bucket;
       while (currentNode) {
         const newIndex = this._hash(currentNode.key);
-        const newNode = new HashTableNode<K, V>(currentNode.key, currentNode.val);
+        const newNode = new HashTableNode<K, V>(currentNode.key, currentNode.value);
 
         if (!newBuckets[newIndex]) {
           newBuckets[newIndex] = newNode;