data-structure-typed 1.40.0-rc → 1.41.0

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

@@ -8,22 +8,24 @@
 import {arrayRemove} from '../../utils';
 import {AbstractEdge, AbstractGraph, AbstractVertex} from './abstract-graph';
 import type {VertexKey} from '../../types';
-import {IUNDirectedGraph} from '../../interfaces';
+import {IGraph} from '../../interfaces';
 
 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> {
+  vertices: [VertexKey, VertexKey];
+
   /**
    * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
    * value.
@@ -31,43 +33,34 @@ 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);
-    this._vertices = [v1, v2];
-  }
-
-  private _vertices: [VertexKey, VertexKey];
-
-  get vertices() {
-    return this._vertices;
-  }
-
-  set vertices(v: [VertexKey, VertexKey]) {
-    this._vertices = v;
+  constructor(v1: VertexKey, v2: VertexKey, weight?: number, value?: E) {
+    super(weight, value);
+    this.vertices = [v1, v2];
   }
 }
 
 export class UndirectedGraph<
-    V extends UndirectedVertex<any> = UndirectedVertex,
-    E extends UndirectedEdge<any> = UndirectedEdge
-  >
-  extends AbstractGraph<V, E>
-  implements IUNDirectedGraph<V, E>
-{
+  V = any,
+  E = any,
+  VO extends UndirectedVertex<V> = UndirectedVertex<V>,
+  EO extends UndirectedEdge<E> = UndirectedEdge<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 +68,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 +83,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 +116,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.
    */
-  removeEdgeBetween(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 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.
+   * The deleteEdge function removes an edge between two vertices in a graph.
+   * @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.
    */
-  removeEdge(edge: E): E | null {
-    return this.removeEdgeBetween(edge.vertices[0], edge.vertices[1]);
+  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 +168,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 +183,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 +197,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 +219,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 +238,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;
@@ -263,12 +256,4 @@ export class UndirectedGraph<
     }
     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

@@ -60,8 +60,4 @@ export class CoordinateMap<V> extends Map<any, V> {
   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

@@ -49,8 +49,4 @@ export class CoordinateSet extends Set<any> {
   override delete(value: number[]) {
     return super.delete(value.join(this._joint));
   }
-
-  protected _setJoint(v: string) {
-    this._joint = v;
-  }
 }

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

@@ -8,60 +8,6 @@ import {HashFunction} from '../../types';
  * @license MIT License
  */
 export class HashMap<K, V> {
-  get hashFn(): HashFunction<K> {
-    return this._hashFn;
-  }
-
-  set hashFn(value: HashFunction<K>) {
-    this._hashFn = value;
-  }
-  get table(): Array<Array<[K, V]>> {
-    return this._table;
-  }
-
-  set table(value: Array<Array<[K, V]>>) {
-    this._table = value;
-  }
-
-  get capacityMultiplier(): number {
-    return this._capacityMultiplier;
-  }
-
-  set capacityMultiplier(value: number) {
-    this._capacityMultiplier = value;
-  }
-
-  get loadFactor(): number {
-    return this._loadFactor;
-  }
-
-  set loadFactor(value: number) {
-    this._loadFactor = value;
-  }
-
-  get initialCapacity(): number {
-    return this._initialCapacity;
-  }
-
-  set initialCapacity(value: number) {
-    this._initialCapacity = value;
-  }
-
-  get size(): number {
-    return this._size;
-  }
-
-  set size(value: number) {
-    this._size = value;
-  }
-
-  private _initialCapacity: number;
-  private _loadFactor: number;
-  private _capacityMultiplier: number;
-  private _size: number;
-  private _table: Array<Array<[K, V]>>;
-  private _hashFn: HashFunction<K>;
-
   /**
    * The constructor initializes the properties of a hash table, including the initial capacity, load factor, capacity
    * multiplier, size, table array, and hash function.
@@ -92,31 +38,40 @@ export class HashMap<K, V> {
       });
   }
 
-  private _hash(key: K): number {
-    return this._hashFn(key);
+  protected _initialCapacity: number;
+
+  get initialCapacity(): number {
+    return this._initialCapacity;
   }
 
-  /**
-   * The `resizeTable` function resizes the table used in a hash map by creating a new table with a specified capacity and
-   * rehashing the key-value pairs from the old table into the new table.
-   * @param {number} newCapacity - The newCapacity parameter is the desired capacity for the resized table. It represents
-   * the number of buckets that the new table should have.
-   */
-  private resizeTable(newCapacity: number): void {
-    const newTable = new Array(newCapacity);
-    for (const bucket of this._table) {
-      // Note that this is this._table
-      if (bucket) {
-        for (const [key, value] of bucket) {
-          const newIndex = this._hash(key) % newCapacity;
-          if (!newTable[newIndex]) {
-            newTable[newIndex] = [];
-          }
-          newTable[newIndex].push([key, value]);
-        }
-      }
-    }
-    this._table = newTable; // Again, here is this._table
+  protected _loadFactor: number;
+
+  get loadFactor(): number {
+    return this._loadFactor;
+  }
+
+  protected _capacityMultiplier: number;
+
+  get capacityMultiplier(): number {
+    return this._capacityMultiplier;
+  }
+
+  protected _size: number;
+
+  get size(): number {
+    return this._size;
+  }
+
+  protected _table: Array<Array<[K, V]>>;
+
+  get table(): Array<Array<[K, V]>> {
+    return this._table;
+  }
+
+  protected _hashFn: HashFunction<K>;
+
+  get hashFn(): HashFunction<K> {
+    return this._hashFn;
   }
 
   set(key: K, value: V): void {
@@ -139,7 +94,7 @@ export class HashMap<K, V> {
     }
 
     this.table[index].push([key, value]);
-    this.size++;
+    this._size++;
   }
 
   get(key: K): V | undefined {
@@ -157,7 +112,7 @@ export class HashMap<K, V> {
     return undefined;
   }
 
-  remove(key: K): void {
+  delete(key: K): void {
     const index = this._hash(key);
     if (!this.table[index]) {
       return;
@@ -166,7 +121,7 @@ export class HashMap<K, V> {
     for (let i = 0; i < this.table[index].length; i++) {
       if (this.table[index][i][0] === key) {
         this.table[index].splice(i, 1);
-        this.size--;
+        this._size--;
 
         // Check if the table needs to be resized down
         const loadFactor = this.size / this.table.length;
@@ -178,7 +133,7 @@ export class HashMap<K, V> {
     }
   }
 
-  *entries(): IterableIterator<[K, V]> {
+  * entries(): IterableIterator<[K, V]> {
     for (const bucket of this.table) {
       if (bucket) {
         for (const [key, value] of bucket) {
@@ -193,11 +148,38 @@ export class HashMap<K, V> {
   }
 
   clear(): void {
-    this.size = 0;
-    this.table = new Array(this.initialCapacity);
+    this._size = 0;
+    this._table = new Array(this.initialCapacity);
   }
 
   isEmpty(): boolean {
     return this.size === 0;
   }
+
+  protected _hash(key: K): number {
+    return this._hashFn(key);
+  }
+
+  /**
+   * The `resizeTable` function resizes the table used in a hash map by creating a new table with a specified capacity and
+   * rehashing the key-value pairs from the old table into the new table.
+   * @param {number} newCapacity - The newCapacity parameter is the desired capacity for the resized table. It represents
+   * the number of buckets that the new table should have.
+   */
+  protected resizeTable(newCapacity: number): void {
+    const newTable = new Array(newCapacity);
+    for (const bucket of this._table) {
+      // Note that this is this._table
+      if (bucket) {
+        for (const [key, value] of bucket) {
+          const newIndex = this._hash(key) % newCapacity;
+          if (!newTable[newIndex]) {
+            newTable[newIndex] = [];
+          }
+          newTable[newIndex].push([key, value]);
+        }
+      }
+    }
+    this._table = newTable; // Again, here is this._table
+  }
 }