directed-graph-typed 1.48.0 → 1.49.0

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

@@ -24,7 +24,7 @@ export class UndirectedVertex<V = any> extends AbstractVertex<V> {
 }
 
 export class UndirectedEdge<E = number> extends AbstractEdge<E> {
-  vertices: [VertexKey, VertexKey];
+  vertexMap: [VertexKey, VertexKey];
 
   /**
    * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
@@ -38,7 +38,7 @@ export class UndirectedEdge<E = number> extends AbstractEdge<E> {
    */
   constructor(v1: VertexKey, v2: VertexKey, weight?: number, value?: E) {
     super(weight, value);
-    this.vertices = [v1, v2];
+    this.vertexMap = [v1, v2];
   }
 }
 
@@ -51,17 +51,17 @@ export class UndirectedGraph<
   extends AbstractGraph<V, E, VO, EO>
   implements IGraph<V, E, VO, EO> {
   /**
-   * The constructor initializes a new Map object to store edges.
+   * The constructor initializes a new Map object to store edgeMap.
    */
   constructor() {
     super();
-    this._edges = new Map<VO, EO[]>();
+    this._edgeMap = new Map<VO, EO[]>();
   }
 
-  protected _edges: Map<VO, EO[]>;
+  protected _edgeMap: Map<VO, EO[]>;
 
-  get edges(): Map<VO, EO[]> {
-    return this._edges;
+  get edgeMap(): Map<VO, EO[]> {
+    return this._edgeMap;
   }
 
   /**
@@ -78,7 +78,7 @@ export class UndirectedGraph<
   }
 
   /**
-   * The function creates an undirected edge between two vertices with an optional weight and value.
+   * The function creates an undirected edge between two vertexMap with an optional weight and value.
    * @param {VertexKey} v1 - The parameter `v1` represents the first vertex of the edge.
    * @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
@@ -92,15 +92,15 @@ export class UndirectedGraph<
   }
 
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(|E|), where |E| is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    */
 
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(|E|), where |E| is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    *
-   * The function `getEdge` returns the first edge that connects two vertices, or undefined if no such edge exists.
+   * The function `getEdge` returns the first edge that connects two vertexMap, or undefined if no such edge exists.
    * @param {VO | VertexKey | undefined} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `VO` (vertex
    * object), `undefined`, or `VertexKey` (a string or number representing the ID of a vertex).
    * @param {VO | VertexKey | undefined} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `VO` (vertex
@@ -108,34 +108,34 @@ export class UndirectedGraph<
    * @returns an edge (EO) or undefined.
    */
   getEdge(v1: VO | VertexKey | undefined, v2: VO | VertexKey | undefined): EO | undefined {
-    let edges: EO[] | undefined = [];
+    let edgeMap: EO[] | undefined = [];
 
     if (v1 !== undefined && v2 !== undefined) {
       const vertex1: VO | undefined = this._getVertex(v1);
       const vertex2: VO | undefined = this._getVertex(v2);
 
       if (vertex1 && vertex2) {
-        edges = this._edges.get(vertex1)?.filter(e => e.vertices.includes(vertex2.key));
+        edgeMap = this._edgeMap.get(vertex1)?.filter(e => e.vertexMap.includes(vertex2.key));
       }
     }
 
-    return edges ? edges[0] || undefined : undefined;
+    return edgeMap ? edgeMap[0] || undefined : undefined;
   }
 
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(|E|), where |E| is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    */
 
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(|E|), where |E| is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    *
-   * The function removes an edge between two vertices in a graph and returns the removed edge.
+   * The function removes an edge between two vertexMap in a graph and returns the removed edge.
    * @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 (EO) if it exists, or undefined if either of the vertices (VO) does not exist.
+   * @returns the removed edge (EO) if it exists, or undefined if either of the vertexMap (VO) does not exist.
    */
   deleteEdgeBetween(v1: VO | VertexKey, v2: VO | VertexKey): EO | undefined {
     const vertex1: VO | undefined = this._getVertex(v1);
@@ -145,33 +145,101 @@ export class UndirectedGraph<
       return undefined;
     }
 
-    const v1Edges = this._edges.get(vertex1);
+    const v1Edges = this._edgeMap.get(vertex1);
     let removed: EO | undefined = undefined;
     if (v1Edges) {
-      removed = arrayRemove<EO>(v1Edges, (e: EO) => e.vertices.includes(vertex2.key))[0] || undefined;
+      removed = arrayRemove<EO>(v1Edges, (e: EO) => e.vertexMap.includes(vertex2.key))[0] || undefined;
     }
-    const v2Edges = this._edges.get(vertex2);
+    const v2Edges = this._edgeMap.get(vertex2);
     if (v2Edges) {
-      arrayRemove<EO>(v2Edges, (e: EO) => e.vertices.includes(vertex1.key));
+      arrayRemove<EO>(v2Edges, (e: EO) => e.vertexMap.includes(vertex1.key));
     }
     return removed;
   }
 
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(E), where E is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    */
 
+
   /**
-   * Time Complexity: O(|E|), where |E| is the number of edges incident to the given vertex.
+   * Time Complexity: O(E), where E is the number of edgeMap incident to the given vertex.
    * Space Complexity: O(1)
    *
-   * 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 undefined if the edge was not found.
+   * The function `deleteEdge` deletes an edge between two vertexMap in a graph.
+   * @param {EO | VertexKey} edgeOrOneSideVertexKey - The parameter `edgeOrOneSideVertexKey` can be
+   * either an edge object or a vertex key.
+   * @param {VertexKey} [otherSideVertexKey] - The parameter `otherSideVertexKey` is an optional
+   * parameter that represents the key of the vertex on the other side of the edge. It is used when the
+   * `edgeOrOneSideVertexKey` parameter is a vertex key, and it specifies the key of the vertex on the
+   * other side of the
+   * @returns The `deleteEdge` function returns either the deleted edge object (EO) or `undefined`.
+   */
+  deleteEdge(edgeOrOneSideVertexKey: EO | VertexKey, otherSideVertexKey?: VertexKey): EO | undefined {
+    let oneSide: VO | undefined, otherSide: VO | undefined;
+    if (this.isVertexKey(edgeOrOneSideVertexKey)) {
+      if (this.isVertexKey(otherSideVertexKey)) {
+        oneSide = this._getVertex(edgeOrOneSideVertexKey);
+        otherSide = this._getVertex(otherSideVertexKey);
+      } else {
+        return;
+      }
+    } else {
+      oneSide = this._getVertex(edgeOrOneSideVertexKey.vertexMap[0]);
+      otherSide = this._getVertex(edgeOrOneSideVertexKey.vertexMap[1]);
+    }
+
+    if (oneSide && otherSide) {
+      return this.deleteEdgeBetween(oneSide, otherSide);
+
+    } else {
+      return;
+    }
+  }
+
+  /**
+   * Time Complexity: O(1) - Constant time for Map operations.
+   * Space Complexity: O(1) - Constant space, as it creates only a few variables.
+   */
+
+  /**
+   * Time Complexity: O(1) - Constant time for Map operations.
+   * Space Complexity: O(1) - Constant space, as it creates only a few variables.
+   *
+   * The `deleteVertex` function removes a vertex from a graph by its ID or by the vertex object itself.
+   * @param {VO | VertexKey} vertexOrKey - The parameter `vertexOrKey` can be either a vertex object (`VO`) or a vertex ID
+   * (`VertexKey`).
+   * @returns The method is returning a boolean value.
    */
-  deleteEdge(edge: EO): EO | undefined {
-    return this.deleteEdgeBetween(edge.vertices[0], edge.vertices[1]);
+  override deleteVertex(vertexOrKey: VO | VertexKey): boolean {
+    let vertexKey: VertexKey;
+    let vertex: VO | undefined;
+    if (this.isVertexKey(vertexOrKey)) {
+      vertex = this.getVertex(vertexOrKey);
+      vertexKey = vertexOrKey;
+    } else {
+      vertex = vertexOrKey;
+      vertexKey = this._getVertexKey(vertexOrKey)
+    }
+
+    const neighbors = this.getNeighbors(vertexOrKey)
+
+    if (vertex) {
+      neighbors.forEach(neighbor => {
+        const neighborEdges = this._edgeMap.get(neighbor);
+        if (neighborEdges) {
+          const restEdges = neighborEdges.filter(edge => {
+            return !edge.vertexMap.includes(vertexKey);
+          });
+          this._edgeMap.set(neighbor, restEdges);
+        }
+      })
+      this._edgeMap.delete(vertex);
+
+    }
+
+    return this._vertexMap.delete(vertexKey);
   }
 
   /**
@@ -183,16 +251,16 @@ export class UndirectedGraph<
    * Time Complexity: O(1)
    * Space Complexity: O(1)
    *
-   * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
+   * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edgeMap connected to that
    * vertex.
    * @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.
+   * edgeMap connected to that vertex.
    */
   degreeOf(vertexOrKey: VertexKey | VO): number {
     const vertex = this._getVertex(vertexOrKey);
     if (vertex) {
-      return this._edges.get(vertex)?.length || 0;
+      return this._edgeMap.get(vertex)?.length || 0;
     } else {
       return 0;
     }
@@ -207,36 +275,36 @@ export class UndirectedGraph<
    * Time Complexity: O(1)
    * Space Complexity: O(1)
    *
-   * The function returns the edges of a given vertex or vertex ID.
+   * The function returns the edgeMap of a given vertex or vertex ID.
    * @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.
+   * @returns an array of edgeMap.
    */
   edgesOf(vertexOrKey: VertexKey | VO): EO[] {
     const vertex = this._getVertex(vertexOrKey);
     if (vertex) {
-      return this._edges.get(vertex) || [];
+      return this._edgeMap.get(vertex) || [];
     } else {
       return [];
     }
   }
 
   /**
-   * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+   * Time Complexity: O(|V| + |E|), where |V| is the number of vertexMap and |E| is the number of edgeMap.
    * Space Complexity: O(|E|)
    */
 
   /**
-   * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+   * Time Complexity: O(|V| + |E|), where |V| is the number of vertexMap and |E| is the number of edgeMap.
    * Space Complexity: O(|E|)
    *
-   * The function "edgeSet" returns an array of unique edges from a set of edges.
+   * The function "edgeSet" returns an array of unique edgeMap from a set of edgeMap.
    * @returns The method `edgeSet()` returns an array of type `EO[]`.
    */
   edgeSet(): EO[] {
     const edgeSet: Set<EO> = new Set();
-    this._edges.forEach(edges => {
-      edges.forEach(edge => {
+    this._edgeMap.forEach(edgeMap => {
+      edgeMap.forEach(edge => {
         edgeSet.add(edge);
       });
     });
@@ -244,18 +312,18 @@ export class UndirectedGraph<
   }
 
   /**
-   * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+   * Time Complexity: O(|V| + |E|), where |V| is the number of vertexMap and |E| is the number of edgeMap.
    * Space Complexity: O(|E|)
    */
 
   /**
-   * Time Complexity: O(|V| + |E|), where |V| is the number of vertices and |E| is the number of edges.
+   * Time Complexity: O(|V| + |E|), where |V| is the number of vertexMap and |E| is the number of edgeMap.
    * Space Complexity: O(|E|)
    *
-   * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
+   * The function "getNeighbors" returns an array of neighboring vertexMap for a given vertex or 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 (VO[]).
+   * @returns an array of vertexMap (VO[]).
    */
   getNeighbors(vertexOrKey: VO | VertexKey): VO[] {
     const neighbors: VO[] = [];
@@ -263,7 +331,7 @@ export class UndirectedGraph<
     if (vertex) {
       const neighborEdges = this.edgesOf(vertex);
       for (const edge of neighborEdges) {
-        const neighbor = this._getVertex(edge.vertices.filter(e => e !== vertex.key)[0]);
+        const neighbor = this._getVertex(edge.vertexMap.filter(e => e !== vertex.key)[0]);
         if (neighbor) {
           neighbors.push(neighbor);
         }
@@ -281,18 +349,18 @@ export class UndirectedGraph<
    * Time Complexity: O(1)
    * Space Complexity: O(1)
    *
-   * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
+   * The function "getEndsOfEdge" returns the vertexMap at the ends of an edge if the edge exists in the graph, otherwise
    * it returns undefined.
    * @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
+   * @returns The function `getEndsOfEdge` returns an array containing two vertexMap `[VO, VO]` if the edge exists in the
    * graph. If the edge does not exist, it returns `undefined`.
    */
   getEndsOfEdge(edge: EO): [VO, VO] | undefined {
-    if (!this.hasEdge(edge.vertices[0], edge.vertices[1])) {
+    if (!this.hasEdge(edge.vertexMap[0], edge.vertexMap[1])) {
       return undefined;
     }
-    const v1 = this._getVertex(edge.vertices[0]);
-    const v2 = this._getVertex(edge.vertices[1]);
+    const v1 = this._getVertex(edge.vertexMap[0]);
+    const v2 = this._getVertex(edge.vertexMap[1]);
     if (v1 && v2) {
       return [v1, v2];
     } else {
@@ -309,20 +377,20 @@ export class UndirectedGraph<
    * Time Complexity: O(1)
    * Space Complexity: O(1)
    *
-   * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
+   * The function adds an edge to the graph by updating the adjacency list with the vertexMap of the edge.
    * @param {EO} edge - The parameter "edge" is of type EO, which represents an edge in a graph.
    * @returns a boolean value.
    */
   protected _addEdgeOnly(edge: EO): boolean {
-    for (const end of edge.vertices) {
+    for (const end of edge.vertexMap) {
       const endVertex = this._getVertex(end);
       if (endVertex === undefined) return false;
       if (endVertex) {
-        const edges = this._edges.get(endVertex);
-        if (edges) {
-          edges.push(edge);
+        const edgeMap = this._edgeMap.get(endVertex);
+        if (edgeMap) {
+          edgeMap.push(edge);
         } else {
-          this._edges.set(endVertex, [edge]);
+          this._edgeMap.set(endVertex, [edge]);
         }
       }
     }