data-structure-typed 1.39.5 → 1.39.6

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

@@ -16,12 +16,12 @@ export abstract class AbstractVertex<V = any> {
    * The function is a protected constructor that takes an key and an optional value as parameters.
    * @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 object.
-   * @param {V} [val] - The parameter "val" is an optional parameter of type V. It is used to assign a value to the
+   * @param {V} [value] - The parameter "value" is an optional parameter of type V. It is used to assign a value to the
    * vertex. If no value is provided, it will be set to undefined.
    */
-  protected constructor(key: VertexKey, val?: V) {
+  protected constructor(key: VertexKey, value?: V) {
     this._key = key;
-    this._val = val;
+    this._value = value;
   }
 
   private _key: VertexKey;
@@ -34,41 +34,41 @@ export abstract class AbstractVertex<V = any> {
     this._key = v;
   }
 
-  private _val: V | undefined;
+  private _value: V | undefined;
 
-  get val(): V | undefined {
-    return this._val;
+  get value(): V | undefined {
+    return this._value;
   }
 
-  set val(value: V | undefined) {
-    this._val = value;
+  set value(value: V | undefined) {
+    this._value = value;
   }
 }
 
-export abstract class AbstractEdge<VO = any> {
+export abstract class AbstractEdge<E = any> {
   /**
    * The above function is a protected constructor that initializes the weight, value, and hash code properties of an
    * object.
    * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the object. If
    * a value is provided, it will be assigned to the `_weight` property. If no value is provided, the default value of 1
    * will be assigned.
-   * @param {VO} [val] - The `val` parameter is of type `VO`, which means it can be any type. It is an optional parameter,
+   * @param {VO} [value] - The `value` parameter is of type `VO`, which means it can be any type. It is an optional parameter,
    * meaning it can be omitted when creating an instance of the class.
    */
-  protected constructor(weight?: number, val?: VO) {
+  protected constructor(weight?: number, value?: E) {
     this._weight = weight !== undefined ? weight : 1;
-    this._val = val;
+    this._value = value;
     this._hashCode = uuidV4();
   }
 
-  private _val: VO | undefined;
+  private _value: E | undefined;
 
-  get val(): VO | undefined {
-    return this._val;
+  get value(): E | undefined {
+    return this._value;
   }
 
-  set val(value: VO | undefined) {
-    this._val = value;
+  set value(value: E | undefined) {
+    this._value = value;
   }
 
   private _weight: number;
@@ -119,9 +119,9 @@ export abstract class AbstractGraph<
    * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it.
    * This means that using abstract methods in the parent class cannot constrain the grandchild classes. Defining methods within an interface also cannot constrain the descendant classes. When inheriting from this class, developers need to be aware that this method needs to be overridden.
    * @param key
-   * @param val
+   * @param value
    */
-  abstract createVertex(key: VertexKey, val?: V): VO;
+  abstract createVertex(key: VertexKey, value?: V): VO;
 
   /**
    * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it.
@@ -129,9 +129,9 @@ export abstract class AbstractGraph<
    * @param srcOrV1
    * @param destOrV2
    * @param weight
-   * @param val
+   * @param value
    */
-  abstract createEdge(srcOrV1: VertexKey | string, destOrV2: VertexKey | string, weight?: number, val?: E): EO;
+  abstract createEdge(srcOrV1: VertexKey, destOrV2: VertexKey, weight?: number, value?: E): EO;
 
   abstract deleteEdge(edge: EO): EO | null;
 
@@ -170,13 +170,13 @@ export abstract class AbstractGraph<
 
   addVertex(vertex: VO): boolean;
 
-  addVertex(key: VertexKey, val?: V): boolean;
+  addVertex(key: VertexKey, value?: V): boolean;
 
-  addVertex(keyOrVertex: VertexKey | VO, val?: V): boolean {
+  addVertex(keyOrVertex: VertexKey | VO, value?: V): boolean {
     if (keyOrVertex instanceof AbstractVertex) {
       return this._addVertexOnly(keyOrVertex);
     } else {
-      const newVertex = this.createVertex(keyOrVertex, val);
+      const newVertex = this.createVertex(keyOrVertex, value);
       return this._addVertexOnly(newVertex);
     }
   }
@@ -222,9 +222,9 @@ export abstract class AbstractGraph<
 
   addEdge(edge: EO): boolean;
 
-  addEdge(src: VO | VertexKey, dest: VO | VertexKey, weight?: number, val?: E): boolean;
+  addEdge(src: VO | VertexKey, dest: VO | VertexKey, weight?: number, value?: E): boolean;
 
-  addEdge(srcOrEdge: VO | VertexKey | EO, dest?: VO | VertexKey, weight?: number, val?: E): boolean {
+  addEdge(srcOrEdge: VO | VertexKey | EO, dest?: VO | VertexKey, weight?: number, value?: E): boolean {
     if (srcOrEdge instanceof AbstractEdge) {
       return this._addEdgeOnly(srcOrEdge);
     } else {
@@ -232,7 +232,7 @@ export abstract class AbstractGraph<
         if (!(this.hasVertex(srcOrEdge) && this.hasVertex(dest))) return false;
         if (srcOrEdge instanceof AbstractVertex) srcOrEdge = srcOrEdge.key;
         if (dest instanceof AbstractVertex) dest = dest.key;
-        const newEdge = this.createEdge(srcOrEdge, dest, weight, val);
+        const newEdge = this.createEdge(srcOrEdge, dest, weight, value);
         return this._addEdgeOnly(newEdge);
       } else {
         throw new Error('dest must be a Vertex or vertex key while srcOrEdge is an Edge');
@@ -493,10 +493,10 @@ export abstract class AbstractGraph<
     const getMinOfNoSeen = () => {
       let min = Infinity;
       let minV: VO | null = null;
-      for (const [key, val] of distMap) {
+      for (const [key, value] of distMap) {
         if (!seen.has(key)) {
-          if (val < min) {
-            min = val;
+          if (value < min) {
+            min = value;
             minV = key;
           }
         }
@@ -625,8 +625,8 @@ export abstract class AbstractGraph<
       if (vertexOrKey instanceof AbstractVertex) distMap.set(vertexOrKey, Infinity);
     }
 
-    const heap = new PriorityQueue<{key: number; val: VO}>({comparator: (a, b) => a.key - b.key});
-    heap.add({key: 0, val: srcVertex});
+    const heap = new PriorityQueue<{key: number; value: VO}>({comparator: (a, b) => a.key - b.key});
+    heap.add({key: 0, value: srcVertex});
 
     distMap.set(srcVertex, 0);
     preMap.set(srcVertex, null);
@@ -656,7 +656,7 @@ export abstract class AbstractGraph<
     while (heap.size > 0) {
       const curHeapNode = heap.poll();
       const dist = curHeapNode?.key;
-      const cur = curHeapNode?.val;
+      const cur = curHeapNode?.value;
       if (dist !== undefined) {
         if (cur) {
           seen.add(cur);
@@ -677,7 +677,7 @@ export abstract class AbstractGraph<
                 const distSrcToNeighbor = distMap.get(neighbor);
                 if (distSrcToNeighbor) {
                   if (dist + weight < distSrcToNeighbor) {
-                    heap.add({key: dist + weight, val: neighbor});
+                    heap.add({key: dist + weight, value: neighbor});
                     preMap.set(neighbor, cur);
                     distMap.set(neighbor, dist + weight);
                   }

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

@@ -15,11 +15,11 @@ export class DirectedVertex<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 data structure.
-   * @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);
   }
 }
 
@@ -32,11 +32,11 @@ export class DirectedEdge<E = any> extends AbstractEdge<E> {
    * @param {VertexKey} dest - The `dest` parameter represents the destination vertex of an edge. It is of type
    * `VertexKey`, which is likely a unique identifier for a vertex in a graph.
    * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
-   * @param {E} [val] - The `val` parameter is an optional parameter of type `E`. It represents the value associated with
+   * @param {E} [value] - The `value` parameter is an optional parameter of type `E`. It represents the value associated with
    * the edge.
    */
-  constructor(src: VertexKey, dest: VertexKey, weight?: number, val?: E) {
-    super(weight, val);
+  constructor(src: VertexKey, dest: VertexKey, weight?: number, value?: E) {
+    super(weight, value);
     this._src = src;
     this._dest = dest;
   }
@@ -99,13 +99,13 @@ export class DirectedGraph<
    * 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 of type `VertexKey`, which
    * could be a number or a string depending on how you want to identify your vertices.
-   * @param [val] - The 'val' parameter is an optional value that can be assigned to the vertex. If a value is provided,
-   * it will be assigned to the 'val' property of the vertex. If no value is provided, the 'val' property will be
+   * @param [value] - The 'value' parameter is an optional value that can be assigned to the vertex. If a value is provided,
+   * it will be assigned to the 'value' property of the vertex. If no value is provided, the 'value' property will be
    * assigned the same value as the 'key' parameter
    * @returns a new instance of a DirectedVertex object, casted as type VO.
    */
-  createVertex(key: VertexKey, val?: V): VO {
-    return new DirectedVertex(key, val ?? key) as VO;
+  createVertex(key: VertexKey, value?: V): VO {
+    return new DirectedVertex(key, value ?? key) as VO;
   }
 
   /**
@@ -119,23 +119,23 @@ export class DirectedGraph<
    * @param {VertexKey} dest - The `dest` parameter is the identifier of the destination vertex for 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 a DirectedEdge object, casted as type EO.
    */
-  createEdge(src: VertexKey, dest: VertexKey, weight?: number, val?: E): EO {
-    return new DirectedEdge(src, dest, weight ?? 1, val) as EO;
+  createEdge(src: VertexKey, dest: VertexKey, weight?: number, value?: E): EO {
+    return new DirectedEdge(src, dest, weight ?? 1, value) as EO;
   }
 
   /**
    * The `getEdge` function retrieves an edge between two vertices based on their source and destination IDs.
-   * @param {VO | null | VertexKey} srcOrKey - The source vertex or its ID. It can be either a vertex object or a vertex ID.
-   * @param {VO | null | VertexKey} destOrKey - The `destOrKey` parameter in the `getEdge` function represents the
+   * @param {VO | VertexKey | null} srcOrKey - The source vertex or its ID. It can be either a vertex object or a vertex ID.
+   * @param {VO | VertexKey | null} destOrKey - The `destOrKey` parameter in the `getEdge` function represents the
    * destination vertex of the edge. It can be either a vertex object (`VO`), a vertex ID (`VertexKey`), or `null` if the
    * destination is not specified.
    * @returns the first edge found between the source and destination vertices, or null if no such edge is found.
    */
-  getEdge(srcOrKey: VO | null | VertexKey, destOrKey: VO | null | VertexKey): EO | null {
+  getEdge(srcOrKey: VO | VertexKey | null, destOrKey: VO | VertexKey | null): EO | null {
     let edges: EO[] = [];
 
     if (srcOrKey !== null && destOrKey !== null) {

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

@@ -11,11 +11,11 @@ export class MapVertex<V = any> extends DirectedVertex<V> {
    * @param {number} long - The "long" parameter represents the longitude of a location. Longitude is a geographic
    * coordinate that specifies the east-west position of a point on the Earth's surface. It is measured in degrees, with
    * values ranging from -180 to 180.
-   * @param {V} [val] - The "val" parameter is an optional value of type V. It is not required to be provided when
+   * @param {V} [value] - The "value" parameter is an optional value of type V. It is not required to be provided when
    * creating an instance of the class.
    */
-  constructor(key: VertexKey, val: V, lat: number, long: number) {
-    super(key, val);
+  constructor(key: VertexKey, value: V, lat: number, long: number) {
+    super(key, value);
     this._lat = lat;
     this._long = long;
   }
@@ -49,11 +49,11 @@ export class MapEdge<E = any> extends DirectedEdge<E> {
    * a graph.
    * @param {VertexKey} dest - The `dest` parameter is the identifier of the destination vertex for an edge.
    * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
-   * @param {E} [val] - The "val" parameter is an optional parameter of type E. It is used to store additional
+   * @param {E} [value] - The "value" parameter is an optional parameter of type E. It is used to store additional
    * information or data associated with the edge.
    */
-  constructor(src: VertexKey, dest: VertexKey, weight?: number, val?: E) {
-    super(src, dest, weight, val);
+  constructor(src: VertexKey, dest: VertexKey, weight?: number, value?: E) {
+    super(src, dest, weight, value);
   }
 }
 
@@ -102,15 +102,15 @@ export class MapGraph<
    * The function creates a new vertex with the given key, value, latitude, and longitude.
    * @param {VertexKey} key - The key parameter is the unique identifier for the vertex. It is of type VertexKey, which could
    * be a string or a number depending on how you define it in your code.
-   * @param [val] - The `val` parameter is an optional value that can be assigned to the `val` property of the vertex. It
-   * is of type `V`, which means it should be of the same type as the `val` property of the vertex class `VO`.
+   * @param [value] - The `value` parameter is an optional value that can be assigned to the `value` property of the vertex. It
+   * is of type `V`, which means it should be of the same type as the `value` property of the vertex class `VO`.
    * @param {number} lat - The `lat` parameter represents the latitude of the vertex. It is a number that specifies the
    * position of the vertex on the Earth's surface in the north-south direction.
    * @param {number} long - The `long` parameter represents the longitude coordinate of the vertex.
    * @returns The method is returning a new instance of the `MapVertex` class, casted as type `VO`.
    */
-  override createVertex(key: VertexKey, val?: V, lat: number = this.origin[0], long: number = this.origin[1]): VO {
-    return new MapVertex(key, val, lat, long) as VO;
+  override createVertex(key: VertexKey, value?: V, lat: number = this.origin[0], long: number = this.origin[1]): VO {
+    return new MapVertex(key, value, lat, long) as VO;
   }
 
   /**
@@ -121,11 +121,11 @@ export class MapGraph<
    * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. It
    * is used to assign a numerical value to the edge, which can be used in algorithms such as shortest path algorithms.
    * If the weight is not provided, it can be set to a default value or left undefined.
-   * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type,
+   * @param [value] - The `value` parameter is an optional value that can be assigned to the edge. It can be of any type,
    * depending on the specific implementation of the `MapEdge` class.
    * @returns a new instance of the `MapEdge` class, cast as type `EO`.
    */
-  override createEdge(src: VertexKey, dest: VertexKey, weight?: number, val?: E): EO {
-    return new MapEdge(src, dest, weight, val) as EO;
+  override createEdge(src: VertexKey, dest: VertexKey, weight?: number, value?: E): EO {
+    return new MapEdge(src, dest, weight, value) as EO;
   }
 }

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

@@ -15,11 +15,11 @@ 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);
   }
 }
 
@@ -31,11 +31,11 @@ export class UndirectedEdge<E = number> extends AbstractEdge<E> {
    * @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 {E} [val] - The "val" parameter is an optional parameter of type E. 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?: E) {
-    super(weight, val);
+  constructor(v1: VertexKey, v2: VertexKey, weight?: number, value?: E) {
+    super(weight, value);
     this._vertices = [v1, v2];
   }
 
@@ -77,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 `VO`.
    */
-  override createVertex(key: VertexKey, val?: VO['val']): VO {
-    return new UndirectedVertex(key, val ?? key) as VO;
+  override createVertex(key: VertexKey, value?: VO['value']): VO {
+    return new UndirectedVertex(key, value ?? key) as VO;
   }
 
   /**
@@ -92,23 +92,23 @@ 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 `EO`.
    */
-  override createEdge(v1: VertexKey, v2: VertexKey, weight?: number, val?: EO['val']): EO {
-    return new UndirectedEdge(v1, v2, weight ?? 1, val) as EO;
+  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 {VO | null | VertexKey} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `VO` (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 {VO | null | VertexKey} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `VO` (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 (EO) or null.
    */
-  getEdge(v1: VO | null | VertexKey, v2: VO | null | VertexKey): EO | null {
+  getEdge(v1: VO | VertexKey | null, v2: VO | VertexKey | null): EO | null {
     let edges: EO[] | undefined = [];
 
     if (v1 !== null && v2 !== null) {

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;